Payout Status

Published when a payout created, rejected, completed, failed.

Event metadata

  • name: PAYOUT
  • types:
    • payout.ready.send, successfully created a payout
    • payout.compliance.rejected
    • payout.completed
    • payout.failed, will be triggered after the system successfully refunds a failed payout.

Request body

FieldsData TypeDescription
event_idstringA unique ID for the event.
event_namestringEvent name.
event_typestringEvent type.
source_idstringPayout ID.
versionstringAPI Version number.
dataobjectObject containing payout details associated with the event.

Notification example

{
    "version": "V1.6.0",
    "event_name": "PAYOUT",
    "event_type": "payout.ready.send",
    "event_id": "56c3e023-dc73-4c12-ae6b-755ca0f77baa",
    "source_id": "05fd17a6-6dfa-472d-bb19-901c0b7a886d",
    "data": {
        "account_id": "7039ab63-2b29-4010-bd8b-0fa5bcb4d6c4",
        "amount": "100",
        "authorisation_steps_required": "0",
        "beneficiary_id": "378b8446-51e9-49d1-8897-dfbae4619d56",
        "conversion": {
            "client_rate": "1.277655",
            "currency_pair": "USDSGD"
        },
        "currency": "USD",
        "direct_id": "0",
        "failure_reason": "",
        "failure_returned_amount": "",
        "fee_amount": "35",
        "fee_currency": "USD",
        "fee_paid_by": "SHARED",
        "payment_date": "2025-08-15",
        "payment_type": "SWIFT",
        "payout_amount": "127.76",
        "payout_currency": "SGD",
        "payout_id": "05fd17a6-6dfa-472d-bb19-901c0b7a886d",
        "payout_way": "",
        "quote_id": "09a0bb4a-757f-4cc8-9e59-a2fe7206fbc4",
        "reason": "audiovisual services",
        "reference": "100",
        "short_reference": "P250815-W3GXQCID",
        "short_reference_id": "P250815-W3GXQCID",
        "status": "READY_TO_SEND",
        "unique_request_id": ""
    }
}