Skip to main content

PayOut

The PayOut structure will be received in response to the Mass Payout operation.

A callback will be received at the address specified in the operation creation method upon every change in the transaction status.

Description of Input Parameters

The webhook structure for the PayOut operations:

In JSON format

id
required
string <uuid>
type
required
string
required
object
created_at
required
string <date-time>
{
  • "id": "b58850d3-fb4a-468c-a16f-be94962d48ae",
  • "type": "payout:pending",
  • "data": {
    },
  • "created_at": "2023-08-08T10:17:14.815487+03:00"
}

Example request:

{
"id": "b58850d3-fb4a-468c-a16f-be94962d48ae",
"type": "payout:pending",
"data": {
"id": "83ce184b-2f92-4d60-8d56-7016bc121263",
"network": "ethereum",
"symbol": "USDT",
"address": "0xA0723dAFAd27aBC0c50719aEf55017f5EC7c3A69",
"amount": 0.333,
"status": "pending",
"ext_tx_id": "string",
"callback_url": "https://example.com/callback",
"external_id": "abc-def",
"mass_payout_id": "12c5c0df-c4c0-4ab9-8945-2d2f3a5ea462",
"created_at": "2023-08-08T10:17:14.804+03:00",
"updated_at": "2023-08-08T10:17:14.804+03:00"
},
"created_at": "2023-08-08T10:17:14.815487+03:00"
}