Design / Recipient Use Cases / Update a Recipient Account

Update a Recipient Account

Overview

In this use case, we’ll walk through updating the information in a Recipient Account.

A recipient is a business or individual with whom you wish to conduct transactions. A Recipient Account contains the recipient’s profile (name, contact information, date of birth, and so on).

API Operation

Update Recipient Account

Steps

Send a request to the following endpoint:

PUT /api/external/recipients/{recipientId}

Use the {recipientId} path parameter to specify the ID of the Recipient Account to be updated.
Include the fields you want to update in the request body. You can update the recipient’s name, phone number, nationality, and additional information. For more information, see the API Reference.
Include a Basic Auth Authorization header where the username is your API key ID and the password is your API key secret.

Sample Request

The following request would update the recipient’s phone number.

				
					{
  "phoneNumber": "9055621258",
}

Sample Response

The updated Recipient Account details are returned.

				
					{
  "createdAt": "2021-07-08T20:56:35.219Z",
  "updatedAt": "2021-07-10T12:35:22.217Z",
  "id": "B08P316F",
  "requestorId": "KNLOPBHZYT",
  "businessAccountId": "KNLOPBHZYT",
  "clientId": "C12X896Y",
  "businessRefId": "RECIP001",
  "createdSource": "SDK iOS",
  "firstName": "John",
  "middleName": "null",
  "lastName": "Smith",
  "secondLastName": "null",
  "email": "jsmith@xyz.com",
  "phoneNumber": "9055621258",
  "nationality": "Canadian",
  "dateOfBirth": "1970-07-08",
  "additionalInformation": "null",
  "recipientType": "INDIVIDUAL",
  "businessName": "null",
  "state": "ACTIVE"
}