Update Recipient

Post https://whitelabel.markets/demos/apex/api/v1/recipient/update/{recipient_id}

Headers

Authorization* string

Pass your {api_key} as a bearer token in the request header to authorize this call

Path parameters

recipient_id* string

ID of recipient

Body parameters

transfer_purpose_id* uuid

Purpose of sending money to recipient

first_name* string

Recipient First Name

middle_name string

Recipient Middle Name

last_name* string

Recipient Last Name

email string

Recipient Email address

phone string

Recipient Phone number

phone_iso2 string

Recipient Phone number iso2

delivery_method* string

Recipient Payout Method

agent_id uuid

Recipient Cash Pickup Agent, required if delivery_method is cash_pickup. Learn more about getting agent_id from https://whitelabel.markets/demos/apex/docs/reference/agents.

mobile_id uuid

Recipient Mobile Money Company, required if delivery_method is mobile_money. Learn more about getting agent_id from https://whitelabel.markets/demos/apex/docs/reference/networks.

mobile_money_number string

Recipient Mobile Money Phone Number, required if delivery_method is mobile_money.

bank_id uuid

Recipient Bank, required if delivery_method is bank. Learn more about getting bank_id from https://whitelabel.markets/demos/apex/docs/reference/banks.

acct_type_id uuid

Recipient Account Type, required if delivery_method is bank. Learn more about getting acct_type_id from https://whitelabel.markets/demos/apex/docs/reference/currencies under international remittance object.

acct_no string

Recipient Bank Account Number, required if delivery_method is bank.

acct_name string

Recipient Bank Account Name, required if delivery_method is bank.

state string

Recipient State iso2

city string

Recipient City

address string

Recipient Address

postal_code string

Recipient Postal/Zip Code

Response


{
    "message": "Recipient Updated",
    "status": "success",
    "data": {
        "id": "8d7a7950-d6d5-401d-a8a6-2d0c52dd12bc",
        "first_name": "John",
        "middle_name": "Son",
        "last_name": "Derrick",
        "email": "Derrick@remote.com",
        "phone": "+2349012345678",
        "currency_code": "USD",
        "currency_id": "d374d1fa-6a88-47b7-a5cc-94acb76610fc",
        "transfer_purpose": "Education",
        "delivery_method": "bank",
        "image": null,
        "country": "US",
        "state": "DE",
        "city": "City",
        "address": "Address",
        "postal_code": "90000",
        "bank": {
            "bank_name": "Bank of America",
            "account_number": "12413523562366",
            "account_name": "John Derick",
            "account_type": "Checkings"
        }
    }
}