API Reference

Beneficiary Created

Published when a beneficiary creation is successful or failed.

Event metadata

  • name: BENEFICIARY
  • types:
    • beneficiary.successful
    • beneficiary.failed

Request body

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

Notification example

{
    "version": "V1.5.2",
    "event_name": "BENEFICIARY",
    "event_type": "beneficiary.successful",
    "event_id": "8a78af1e-de83-43a5-b177-ecbc6a8a9fc6",
    "source_id": "b27aa356-5f4e-4c22-ab1d-0e2f9e3af451",
    "data": {
        "beneficiary_id": "b27aa356-5f4e-4c22-ab1d-0e2f9e3af451",
        "payment_type": "swift",
        "beneficiary_email": "[email protected]",
        "beneficiary_nickname": "ABC nickname",
        "beneficiary_first_name": "",
        "beneficiary_last_name": "",
        "beneficiary_company_name": "Industries Dynamic",
        "account_currency_code": "EUR",
        "bank_country_code": "BI",
        "account_number": "GB71950018692652646666",
        "beneficiary_bank_details": "{\"bank_name\":\"CIMB\",\"bank_address\":\"2 Canning Rise, Singapore 179558\",\"bank_country_code\":\"BI\",\"account_holder\":\"ABC Holder\",\"account_currency_code\":\"EUR\",\"account_number\":\"GB71950018692652646598\",\"iban\":\"GB71950018692652646598\",\"swift_code\":\"WFOMDEX56CI\",\"clearing_system\":\"SWIFT\",\"routing_code_type1\":\"\",\"routing_code_value1\":\"\",\"routing_code_type2\":\"\",\"routing_code_value2\":\"\"}",
        "beneficiary_address": "{\"country_code\":\"BW\",\"city\":\"Pasir Ris\",\"street_address\":\"2 Canning Rise, Singapore 179558\",\"postal_code\":\"098018\",\"state\":\"North Region\"}",
        "beneficiary_status": "Enable"
    }
}