​
event_id
string

Event id.

​
event_name
string

Event name.

​
event_type
string

Event type. One of beneficiary.failed, beneficiary.successful

​
version
string

The default is default.

​
Payload

​
beneficiary_id
string

Beneficiary id.

​
payment_type
string

Beneficiary payment type.

​
beneficiary_email
string

Beneficiary email.

​
beneficiary_nickname
string

Beneficiary nickname.

​
beneficiary_first_name
string

Beneficiary first name. When creating beneficiaries, if the entity_type selects Individual, beneficiary_first_name is not empty.

​
beneficiary_last_name
string

Beneficiary last name. When creating beneficiaries, if the entity_type selects Individual, beneficiary_last_name is not empty.

​
beneficiary_company_name
string

Beneficiary company name. When creating beneficiaries, if the entity_type selects Company, beneficiary_company_name is not empty.

​
account_currency_code
string

Account currency code.

​
bank_country_code
string

Bank country code.

​
account_number
string

Account number.

​
beneficiary_bank_details
string

Beneficiary bank details.

​
beneficiary_address
string

Beneficiary address.

​
beneficiary_status
string

Beneficiary status. One of Enable, Disabled

Response
{
    "header": {
        "event_id": "16dc32da-7aa3-433e-a638-90f780371b67",
        "event_name": "beneficiary.failed",
        "event_type": "BENEFICIARY",
        "version": "default"
    },
    "body": {
        "beneficiary_id": "09d62dbf-9631-484f-9f9f-54a899b689ed",
        "payment_type": "local",
        "beneficiary_email": "[email protected]",
        "beneficiary_nickname": "EMILY SMITH",
        "beneficiary_first_name": "Emily",
        "beneficiary_last_name": "Smith",
        "beneficiary_company_name": "",
        "account_currency_code": "USD",
        "bank_country_code": "AF",
        "account_number": "123123",
        "beneficiary_bank_details": "{\"bank_name\":\"123123\",\"bank_address\":\"123123\",\"bank_country_code\":\"AF\",\"account_holder\":\"123123\",\"account_currency_code\":\"USD\",\"account_number\":\"123123\",\"iban\":\"\",\"swift_code\":\"213123\",\"clearing_system\":\"LOCAL\",\"routing_code_type1\":\"\",\"routing_code_value1\":\"\",\"routing_code_type2\":\"\",\"routing_code_value2\":\"\"}",
        "beneficiary_address": "{\"country_code\":\"AU\",\"city\":\"Ho Chi Minh City\",\"street_address\":\"140 Lê Trọng Tấn, Tây Thạnh, Tân Phú, Thành phố Hồ Chí Minh,\",\"postal_code\":\"10000\",\"state\":\"CA\"}",
        "beneficiary_status": "Enabled"
    }
}