INTRODUCTION

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

Design  /  Recipient Use Cases  /  Create a Recipient Account

Create a Recipient Account

Overview

In this use case, we’ll walk through creating a new 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).

Note  One or more Recipient Financial Accounts can be linked to the Recipient Account. A Financial Account is a bank account or card account belonging to the recipient.

Tip  For more information about the types of accounts you’ll work with on the RocketKOR platform, see About RocketKOR Accounts.

API Operation

Steps

Send a request to the following endpoint:

POST /api/external/recipients

  • Include details about the business or individual in the request body (name, contact information, date of birth, and so on). For a list of required fields, 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 create a new Recipient Account for an individual.

				
					{
  "businessRefId": "RECIP001",
  "firstName": "John",
  "middleName": "",
  "lastName": "Smith",
  "secondLastName": "",
  "email": "jsmith@xyz.com",
  "phoneNumber": "4161234567",
  "nationality": "Canadian",
  "dateOfBirth": "1970-07-08",
  "additionalInformation": "",
  "recipientType": "INDIVIDUAL",
  "businessName": ""
}
				
			

Sample Response

If the Recipient Account creation is successful, a unique ID is returned for the account. Details about the account creation and the recipient’s profile are also 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