Update Beneficiary
Update a beneficiary with additional fields.
Note
You cannot update the values of the beneficiary fields which were defined when it was created.
beneficiary
ID of the
beneficiaryobject. String starting with beneficiary_.
Note
In addition to the fields documented below, you can include all other fields listed for the beneficiary in the response to Get Payout Required Fields, and you must conform to the regex provided.
/v1/payouts/beneficiary/:beneficiary
Update Beneficiary - individual
curl -X post https://sandboxapi.rapyd.net/v1/payouts/beneficiary/beneficiary_6ef1a6c71de4c34733ae22e15f158b5d -H 'access_key: your-access-key-here' -H 'Content-Type: application/json' -H 'idempotency: your-idempotency-parameter-here' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here' -d ' { "gender": "other", "address": "1 Main Street", "city": "Montreal", "state": "Quebec" } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "1e914fa7-5dd4-4a7c-9f5f-1ee181c2a6ba" }, "data": { "id": "beneficiary_6ef1a6c71de4c34733ae22e15f158b5d", "last_name": "Doe", "first_name": "John", "country": "CA", "entity_type": "individual", "address": "1 Main Street", "name": "John Doe", "date_of_birth": "07/06/1992", "city": "Montreal", "state": "Quebec", "phone_number": "1234567890", "currency": "CAD", "identification_type": "residence_permit", "identification_value": "******", "nationality": "Ukraine", "purpose_code": "salary", "gender": "other", "bin_details": { "type": null, "brand": null, "level": null, "issuer": null, "country": null, "bin_number": "473118" }, "card_number": "2089", "payment_type": "priority", "category": "card", "default_payout_method_type": "ua_general_card" } }