GET STARTED

RECIPIENT

FINANCIAL ACCOUNT

PAYMENT REASON

TRANSACTION

NOTE

Create a Recipient

Add a new Recipient Account to a Business Account. The Recipient Account contains the recipient’s profile information (name, contact information, date of birth, and so on).

Endpoint

POST /api/external/recipients

Authorization Header

Basic Auth REQUIRED

username is your API key ID and password is your API key secret.

Request Body

businessRefId

string, max length: 40, min length: 0

Your organization’s internal reference number assigned to the Recipient Account. This reference number is not used by RocketKOR.

firstName REQUIRED

string, max length: 40, min length: 0

Recipient’s first name.

middleName

string, max length: 40, min length: 0

Recipient’s middle name.

lastName REQUIRED

string, max length: 40, min length: 0

Recipient’s last name.

secondLastName

string, max length: 40, min length: 0

Recipient’s second last name.

email REQUIRED

string, max length: 100, min length: 0

Recipient’s email address.

phoneNumber

string, max length: 40, min length: 0

Recipient’s phone number.

nationality

string, max length: 40, min length: 0

Recipient’s nationality.

dateOfBirth

string (date), required format: YYYY-MM-DD

Recipient’s date of birth.

additionalInformation

string, max length: 500, min length: 0

Additional information or notes about the recipient.

recipientType

string, values: BUSINESS, INDIVIDUAL

Type of recipient.

businessName CONDITIONAL

string, max length: 40, min length: 0

Business name. Required if recipientType is BUSINESS.

Returns

Returns the Recipient Account details, including a unique ID for the account. The request body and the following fields are returned.

string (UUID)

Unique ID assigned to the Recipient Account.

createdAt

string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the Recipient Account was created.

updatedAt

string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the Recipient Account was last updated.

requestorId

string, max length: 40, min length: 0

ID of the entity that requested the Recipient Account creation. This could be a RocketKOR Business Account (if the account is created via an API) or a Team Member (if the account is created in the RocketKOR Portal).

businessAccountId

string (UUID)

ID of the Business Account that the Recipient Account belongs to.

clientId

string, max length: 40, min length: 0

ID of the client application interacting with the RocketKOR system.

createdSource

string, max length: 40, min length: 0

Application used to create the Recipient Account, such as a RocketKOR API, the RocketKOR Portal, or an iframe.

state

string, values: ACTIVE, SUSPENDED

Current status of the Recipient Account. Possible values are ACTIVE (account is active) and SUSPENDED (account is inactive). A Recipient Account is ACTIVE when first created.

SAMPLE REQUEST

				
					{
  "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

				
					{
  "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"
}