Payout Status

Event metadata

name: PAYOUT
types:
- payout.ready.send, successfully created a payout
- payout.compliance.rejected
- payout.completed
- payout.failed

Request body

Fields	Data Type	Description
`event_id`	`string`	A unique ID for the event.
`event_name`	`string`	Event name.
`event_type`	`string`	Event type.
`source_id`	`string`	Payout ID.
`version`	`string`	API Version number.
`data`	`object`	Object containing payout details associated with the event.

Notification example

{
    "version": "V1.5.2",
    "event_name": "PAYOUT",
    "event_type": "payout.ready.send",
    "event_id": "8a78af1e-de83-43a5-b177-ecbc6a8a9fc6",
    "source_id": "8e56543e-7887-4fde-a161-8f973700673d",
    "data": {
        "payout_id": "8e56543e-7887-4fde-a161-8f973700673d",
        "amount": "100",
        "failure_returned_amount": "100",
      	"fee_paid_by": "SHARED",
      	"fee_currency": "USD",
      	"fee_amount": "1.00",
        "beneficiary_id": "2d896e19-bc10-4ed2-94b6-4818c50f4018",
        "currency": "USD",
        "reference": "Test reference",
        "reason": "Test",
        "status": "READY_TO_SEND",
        "payment_type": "swift",
        "payment_date": "2024-06-21",
        "authorisation_steps_required": "0",
        "short_reference": "P240620-CNRHNZZB",
        "failure_reason": "",
        "unique_request_id": "c4f7586d-16e2-4e07-9824-f38cb1d75de1"
    }
}