INTRODUCTION

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

Design  /  Recipient Use Cases  /  Retrieve Recipient Account Details

Retrieve Recipient Account Details

Overview

In this use case, we’ll walk through retrieving detailed information for 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

Steps

Send a request to the following endpoint:

GET /api/external/recipients/{recipientId}

  • Use the {recipientId} path parameter to specify the ID of the Recipient Account you want to retrieve.
  • Request body is not required.
  • Include a Basic Auth Authorization header where the username is your API key ID and the password is your API key secret.

Sample Response

The Recipient Account details are returned.

				
					{
  "createdAt": "2021-07-08T20:56:35.219Z",
  "updatedAt": "2021-07-08T20:56:35.219Z",
  "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "requestorId": "9kj43t32-2956-2886-x7dy-6r821w39kra3",
  "businessAccountId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "clientId": "C12X896Y",
  "businessRefId": "RECIP001",
  "createdSource": "SDK iOS",
  "firstName": "John",
  "middleName": "",
  "lastName": "Smith",
  "secondLastName": "",
  "email": "jsmith@xyz.com",
  "phoneNumber": "4161234567",
  "nationality": "Canadian",
  "dateOfBirth": "1970-07-08",
  "additionalInformation": "",
  "recipientType": "INDIVIDUAL",
  "businessName": "",
  "state": "ACTIVE"
}
				
			
ON THIS PAGE