Payout Webhook

Register your Webhook URL and get payout notification whenever Payout request status is DONE

POST {www.yourcompany.com}/payout_webhook_url

Request

Header Request

Parameter
Data Type
Requirement
Description

X-API-Key

String

M

Callback API Key, an additional API Key used specifically for receiving callbacks

Content-Type

String

M

application/JSON

Accept

String

M

application/JSON

Request Body

{
  "event": "PAYOUT.DONE",
  "data": {
    "uuid": "d6a46a2c-1b26-40c5-9ca3-e063e69635a0",
    "merchantId": "922e39ab-7565-49f6-b84f-fb56122821ae",
    "payoutResults": {
      "totalPendingCount": 0,
      "totalPendingAmount": 0,
      "totalSuccessCount": 1,
      "totalSuccessAmount": 100000,
      "totalFailedCount": 0,
      "totalFailedAmount": 0,
    "status": "DONE"
    }
  }
}

Detail Parameter Request

Parameter
Data Type
Requirement
Description

event

String

M

Event Name

data

Object

M

Payout Object. Refers to Payout Object