Update recipient

patch

https://sandbox.dev.business.mamopay.com/manage_api/v1/recipients/{recipientIdentifier}

Changes the details of an existing recipient, such as their name, email, address, or bank account.

Send only the fields you want to change. Inside bank and address, only the keys you send are updated; the rest keep their current values. The same validation rules as Create recipient apply to the fields you send, and a failure returns 422 with error_code: VALIDATION_ERROR and an errors array. If the recipient passes validation but can't be saved, you get 422 with error_code: UNPROCESSABLE_ENTITY and the message Can not update recipient.

The response is the updated recipient. An unknown or deleted recipient returns 404.

Path Params

recipientIdentifier

string

required

Defaults to REP-3C4D5E6F7A

Recipient Identifier

Body Params

recipient_type

string

enum

Defaults to individual

The type of the recipient.

Allowed:

string

Recipient's email.

business_name

string

Name of the recipient when recipient_type is business.

first_name

string

First name of the recipient when recipient_type is individual.

last_name

string

Last name of the recipient when recipient_type is individual.

relationship

string

enum

Recipient's relationship

eid_number

string

Recipient's Emirates ID number.

phone_number

string

Recipient's phone number. Required for some corridors (for example India).

identity_document_type

string

enum

Recipient's identity document type. Required for some corridors.

business_registration_number

string

Recipient's business registration number, when recipient_type is business. Required for some corridors.

nationality

string

Recipient's nationality as a three-letter ISO 3166-1 alpha-3 country code (for example: ARE, GBR).

date_of_birth

date

Recipient's date of birth in YYYY-MM-DD format. Cannot be a future date.

bank

object

address

object

recipient_meta

object

Headers

Idempotency-Key

string

A unique key, such as a UUID, that makes it safe to retry this request. Reuse the same key when you retry. See Idempotency.

Responses

429

Too many requests. You sent more than 100 requests in 30 seconds from one IP address. This response has no JSON body. See Rate limits.

500

Unexpected error

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

403Unauthorised

404Not Found

422Unprocessable entity