​
event_id
string

Event id.

​
event_name
string

Event name.

​
event_type
string

Event type. One of payout.ready.send, payout.compliance.rejected, payout.completed, payout.failed

​
version
string

The default is default.

​
Payload

​
amount
string

Payout amount.

​
authorisation_steps_required
string

Authorization steps required.default 0.

​
beneficiary_id
string

Payout beneficiary id.

​
currency
string

Payout currency.

​
failure_reason
string

Failure reason.

​
failure_returned_amount
string

Failure returned amount.

​
payment_date
string

Payment date.

​
payment_type
string

Payment type.

​
payout_id
string

Payout id.

​
reason
string

Payout reason.

​
reference
string

Payout reference.

​
short_reference
string

Payout short reference.

​
status
string

Payout status. one of Success, Failed, Rejected, Ready To Send.

​
unique_request_id
string

Payout unique request id.

Response
{
    "header": {
        "event_id": "3a9ca795-d36e-4913-b85e-8aaa28fa90d2",
        "event_name": "payout.ready.send",
        "event_type": "PAYOUT",
        "version": "default"
    },
    "body": {
        "amount": "10",
        "authorisation_steps_required": "0",
        "beneficiary_id": "a3c61451-c93f-4e53-8710-0e749d5667dc",
        "currency": "USD",
        "failure_reason": "",
        "failure_returned_amount": "10",
        "payment_date": "2023-09-27",
        "payment_type": "company",
        "payout_id": "b5ca63ec-ac47-48df-be38-f5e366cb2059",
        "reason": "1",
        "reference": "1",
        "short_reference": "P230927-IOXYQYG8",
        "status": "Success",
        "unique_request_id": "2bc17ba4-47a2-4c32-ae64-440e22a1511f"
    }
}