Capture a transaction

Request

Header Params

Content-Type

string

required

Example:

application/x-www-form-urlencoded

Body Params application/json

merchant_id

string

required

Merchant Code or Merchant ID or Merchant Number

<= 7 characters

Example:

701001

account_id

string

required

Account ID or Gateway Number

<= 10 characters

Example:

701001010

encryption_data

string

required

Digital signatures information
encryption_data=sha256(merchant_id + account_id + transaction_id1 + transaction_id2 ...+ sign_key);
All encryption parameters need to remove spaces before encryption.

<= 64 characters

Example:

a290ea1fd6c69d69d578eb15921eb486e4b801c5b6a577df445aa8f6c592b66b

capture_orders

array [object {4}]

required

Return of error status: 0: Fail 1: Success

transaction_id

string

required

Transaction ID generated by gateway system, the Transaction ID = Order No + '-' + 5 digits random number

<= 50 characters

Example:

1667308950627942400

order_no

string

required

List of captured orders

<= 50 characters

Example:

1591067778165

currency

string

required

Transaction ID generated by gateway system, the Transaction ID = Order No + '-' + 5 digits random number

<= 3 characters

Example:

USD

amount

string

required

Merchant Order Number

<= 15 characters

Example:

123.00

Example

{
  "merchant_id": "1018001",
  "account_id": "1018001013",
  "encryption_data": "138527e176e62b1dcd5ce3393aa6fa04e5c8031a1bf89b7f2e516417abd2fb42",
  "capture_orders": [
    {
      "transaction_id": "1379870442859134976",
      "order_no": "1731482700989",
      "currency": "USD",
      "amount": "958.38"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://test-api.star-saas.com/v1/capture' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-raw '{
    "merchant_id": "1018001",
	"account_id": "1018001013",
	"encryption_data": "138527e176e62b1dcd5ce3393aa6fa04e5c8031a1bf89b7f2e516417abd2fb42",
    "capture_orders":[
        {
            "transaction_id": "1379870442859134976",
		    "order_no": "1731482700989",
            "currency": "USD",
            "amount": "958.38"
        }
    ]
}'

Responses

🟢200Success

application/json

Body

account_id

string

required

return_message

string

required

return_status

string

required

encryption_data

string

required

merchant_id

string

required

capture_orders

array [object {6}]

required

amount

string

required

capture_status

string

required

currency

string

required

error_message

string

required

order_no

string

required

transaction_id

string

required

Example

{
  "account_id": "1018001013",
  "return_message": "OK",
  "return_status": "1",
  "encryption_data": "138527e176e62b1dcd5ce3393aa6fa04e5c8031a1bf89b7f2e516417abd2fb42",
  "merchant_id": "1018001",
  "capture_orders": [
    {
      "amount": "958.38",
      "capture_status": "1",
      "currency": "USD",
      "error_message": "",
      "order_no": "1731482700989",
      "transaction_id": "1379870442859134976"
    }
  ]
}