Hello everyone!
I used Create Beneficiary Tokenization Page for creating beneficiary, I want to send some extra parameters to this and get them in BENEFICIARY_CREATED webhook, how can I do this?
Thanks
Thanks @Santosh123, by extra parameters, you would be referring to these Optional Beneficiary Fields?
I’m trying to add the Additional Sender and Beneficiary fields here and it looks like it only passes through if it’s required or when using the API directly.
Create Beneficiary Tokenization Page
Request
{
"category": "bank",
"sender_entity_type": "company",
"sender_country": "US",
"merchant_reference_id": "A-1013",
"beneficiary_country": "US",
"beneficiary_entity_type": "individual",
"beneficiary_optional_fields": {
"last_name": "Doe",
"first_name": "John",
"identification_type": "international_passport",
"identification_value": "123456789",
"nationality":"USA"
}
}
Response
{
"status": {
"error_code": "",
"status": "SUCCESS",
"message": "",
"response_code": "",
"operation_id": "88810424-b4f3-44ee-b78d-4889e4501832"
},
"data": {
"status": "NEW",
"cancel_url": "http://rapyd.net",
"complete_url": "http://rapyd.net",
"language": null,
"merchant_color": "323fff",
"merchant_logo": null,
"merchant_website": "http://rapyd.net",
"merchant_customer_support": {
"url": "http://support.rapyd.net",
"email": "support@rapyd.net",
"phone_number": "555-555-5555"
},
"merchant_alias": "Test Business",
"page_expiration": 1666391890,
"redirect_url": "https://sandboxhosted.rapyd.net/disburse/beneficiary?token=hp_ben_cb36be790bf89d714309fe44a689b8b1",
"id": "hp_ben_cb36be790bf89d714309fe44a689b8b1",
"category": "bank",
"sender_entity_type": "company",
"sender_country": "US",
"merchant_reference_id": "A-1013",
"beneficiary_entity_type": "individual",
"beneficiary_country": "US",
"beneficiary_currency": "USD",
"sender_currency": "USD",
"beneficiary_id": null,
"payout_method_type": null,
"beneficiary_validated": false,
"timestamp": 1665182290,
"beneficiary_optional_fields": {
"last_name": "Doe",
"first_name": "John",
"company_name": null,
"identification_type": "international_passport",
"identification_value": "123456789"
},
"payout_method_types_include": null,
"payout_method_types_exclude": null,
"expiration": 1666391890
}
}
Webhook
{
"id": "wh_7669c9a12bdb645b3a1eaff0538c7bf0",
"type": "BENEFICIARY_CREATED",
"data": {
"id": "beneficiary_5d57d2c1fd30dbf6887a8200ad239f00",
"aba": "123456789",
"name": "John Doe",
"country": "US",
"category": "bank",
"currency": "USD",
"last_name": "Doe",
"first_name": "John",
"entity_type": "individual",
"account_number": "123456789",
"identification_type": "international_passport",
"identification_value": "123456789",
"merchant_reference_id": "A-1013",
"default_payout_method_type": "us_ach_bank"
},
"trigger_operation_id": "831c5abd-02c8-4788-a187-97a50ce668b5",
"status": "NEW",
"created_at": 1665182324
}
Create Beneficiary
Request
{
"category": "bank",
"default_payout_method_type": "us_wires_bank",
"country": "US",
"currency": "USD",
"entity_type": "individual",
"first_name": "John",
"identification_type": "work permit",
"identification_value": "6658412",
"last_name": "Doe",
"payment_type": "regular",
"address": "123 Main Street",
"city": "NY",
"postcode": "12345",
"account_number": "1234567890",
"merchant_reference_id": "JohnDoeOffice",
"company_name": "CompanyTest",
"bic_swift": "ABCDEFGH",
"bank_account_type": "CACC",
"phone_number":"555-555-5555",
"nationality":"USA"
}
Response
{
"status": {
"error_code": "",
"status": "SUCCESS",
"message": "",
"response_code": "",
"operation_id": "dfaed0ce-e710-4c36-ac8b-56b7006586c6"
},
"data": {
"id": "beneficiary_cd4fb3b7d1a5fda502ab6494003e9814",
"last_name": "Doe",
"first_name": "John",
"country": "US",
"entity_type": "individual",
"address": "123 Main Street",
"name": "John Doe",
"postcode": "12345",
"city": "NY",
"phone_number": "555-555-5555",
"company_name": "CompanyTest",
"account_number": "1234567890",
"currency": "USD",
"identification_type": "work permit",
"identification_value": "6658412",
"nationality": "USA",
"merchant_reference_id": "JohnDoeOffice",
"bic_swift": "ABCDEFGH",
"bank_account_type": "CACC",
"payment_type": "regular",
"category": "bank",
"default_payout_method_type": "us_wires_bank"
}
}
Webhook
“nationality”: “USA”, is present below.
{
"id": "wh_7cef5d84069367b8d18dd97690fd41c0",
"type": "BENEFICIARY_CREATED",
"data": {
"id": "beneficiary_cd4fb3b7d1a5fda502ab6494003e9814",
"city": "NY",
"name": "John Doe",
"address": "123 Main Street",
"country": "US",
"category": "bank",
"currency": "USD",
"postcode": "12345",
"bic_swift": "ABCDEFGH",
"last_name": "Doe",
"first_name": "John",
"entity_type": "individual",
"nationality": "USA",
"company_name": "CompanyTest",
"payment_type": "regular",
"phone_number": "555-555-5555",
"account_number": "1234567890",
"bank_account_type": "CACC",
"identification_type": "work permit",
"identification_value": "6658412",
"merchant_reference_id": "JohnDoeOffice",
"default_payout_method_type": "us_wires_bank"
},
"trigger_operation_id": "dfaed0ce-e710-4c36-ac8b-56b7006586c6",
"status": "NEW",
"created_at": 1665183041
}
Thanks for reply, I want to send some custom data to beneficiary tokenization page like metadata available in create payout and get it in webhook.
After some investigation, and follow up with team members, we do have metadata objects in the Payout Object and Create Payout.
Is this data specific or required for the beneficiary only? I’d be interested in hearing more about your use case.