Skip to main content
POST
/
withdraw
/
open
/
institution
/
v1
/
pay
/
payouts
/
detail
Payout Detail
curl --request POST \
  --url https://openplatform.gateapi.io/withdraw/open/institution/v1/pay/payouts/detail \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "batch_id": "M57143269150",
  "detail_status": "ALL"
}
'
{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "batch_id": "M57143269148",
    "merchant_id": 2124538349,
    "client_id": "mZ96D37oKk-HrWJc",
    "status": "PROCESSING",
    "create_time": 1764048644523,
    "withdraw_list": [
      {
        "id": 634708,
        "batch_id": "M57143269148",
        "merchant_id": 2124538349,
        "suborder_id": "35803766522511370",
        "withdraw_id": "",
        "chain": "ETH",
        "address": "THISISTESTADDRESSFORGATEPAY1",
        "currency": "USDT",
        "amount": "0.01",
        "fee": "0",
        "tx_id": "",
        "timestamp": 1764048644540,
        "memo": "",
        "create_time": 1764048644540,
        "update_time": 1764048644891,
        "status": "PENDING",
        "err_msg": "",
        "merchant_withdraw_id": "e1619185671593",
        "desc": "",
        "channel_id": null,
        "finish_time": 0,
        "sub_amount": "0",
        "done_amount": "0"
      }
    ],
    "channel_id": ""
  }
}

Headers

​
X-GatePay-Certificate-ClientId
string
required

The clientId assigned when the merchant registers an application in the Gate merchant console.

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

​
X-GatePay-Timestamp
string
required

UTC timestamp in milliseconds when the request is generated. GatePay will not process requests where the difference from the receive time exceeds 10 seconds.

Example:

"1672905655498"

​
X-GatePay-Nonce
string
required

Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.

Example:

"9578"

​
X-GatePay-Signature
string
required

Request signature. GatePay uses this signature to verify whether the request is valid.

​
X-GatePay-On-Behalf-Of
string
required

The institution account id being acted on behalf of (sub-account ID).

Example:

"2124538349"

Body

application/json
​
batch_id
string
required

Batch ID from create payouts.

​
detail_status
enum<string>
required

Filter: ALL, INIT, PENDING, PROCESSING, CHECK, FAIL, DONE.

Available options:
ALL,
INIT,
PENDING,
PROCESSING,
CHECK,
FAIL,
DONE

Response

200 - application/json

Success

​
status
string
​
code
string
​
errorMessage
string
​
data
object