Update Beneficiary
Update a beneficiary with additional fields.
Nota
You cannot update the values of the beneficiary fields which were defined when it was created.
The code samples include successful requests (200), bad requests (400), and an unauthorized request (401). For all error messages that appear due to bad requests, see Payout Errors and General Errors.
beneficiary
ID of the
beneficiaryobject. String starting with beneficiary_.
Nota
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_0e1c96eac00e22a6875b9ba5107a310a' \ -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' \ --data-raw '{ "state": "Illinois", "postcode": "12345" }'{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "af4bd368-a5fa-4d79-a51d-9fcc344d8d74" }, "data": { "id": "beneficiary_cb009f46c8dcd85004c8054541287723", "last_name": "Doe", "first_name": "John", "country": "US", "entity_type": "individual", "address": "1 Main Street", "name": "John Doe", "postcode": "12345", "city": "Anyyown", "state": "Illinois", "account_number": "1234567", "currency": "USD", "identification_type": "identification_id", "identification_value": "*********", "merchant_reference_id": "JohnDoe", "gender": "other", "bic_swift": "12345678XXX", "payment_type": "priority", "category": "bank", "default_payout_method_type": "us_general_bank" } }
Bad Request - Update Beneficiary with No New Fields
curl -X post 'https://sandboxapi.rapyd.net/v1/payouts/beneficiary/beneficiary_0e1c96eac00e22a6875b9ba5107a310a' \ -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' \ --data-raw '{ "state": "Illinois", "postcode": "12345" }'{ "status": { "error_code": "ERROR_UPDATE_BENEFICIARY_WITH_NO_NEW_FIELDS", "status": "ERROR", "message": "The request attempted to update a beneficiary field, but its value has already been defined. The request was rejected. Corrective action: Update only values of beneficiary fields that were not previously defined.", "response_code": "ERROR_UPDATE_BENEFICIARY_WITH_NO_NEW_FIELDS", "operation_id": "51ce8647-5495-4f44-bc90-d6b22416693b" } }
Bad Request - Beneficiary Not Found
curl -X post 'https://sandboxapi.rapyd.net/v1/payouts/beneficiary/beneficiary0e1c96eac00e22a6875b9ba5107a310a' \ -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' \ --data-raw '{ "state": "Illinois", "postcode": "12345" }'{ "status": { "error_code": "ERROR_GET_BENEFICIARY", "status": "ERROR", "message": "The request attempted an operation that requires a payout beneficiary, but the beneficiary was not found. The request was rejected. Corrective action: Use the ID of a valid beneficiary.", "response_code": "ERROR_GET_BENEFICIARY", "operation_id": "b08b8ef7-56ef-43c6-b437-f53395b2ab83" } }
Unauthorized
curl -X post 'https://sandboxapi.rapyd.net/v1/payouts/beneficiary/beneficiary_0e1c96eac00e22a6875b9ba5107a310a' \ -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' \ --data-raw '{ "state": "Illinois", "postcode": "12345" }'{ "status": { "error_code": "UNAUTHENTICATED_API_CALL", "status": "ERROR", "message": "The request was rejected due to an authentication issue. Corrective action: Check the status of your account in the 'Account Details' page of the Client Portal.", "response_code": "UNAUTHENTICATED_API_CALL", "operation_id": "96d11925-07a8-4982-84db-eeb142ee68bb" } }