INTRODUCTION

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

Design  /  Financial Account Use Cases  /  Create a Recipient Financial Account

Create a Recipient Financial Account

Overview

In this use case, we’ll walk through creating a new bank account or card Recipient Financial Account. You can create card Recipient Financial Accounts for Mastercard and VISA debit cards and for eligible Discover cards.

A Recipient Financial Account contains details about the card (number, expiry date, billing address, and so on) or bank account (account number, routing number, and so on). When creating a new Recipient Financial Account, you must link it to an existing Recipient Account. The Recipient Account contains the recipient’s profile information (name, contact information, date of birth, and so on).

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

Prerequisites

Create a Recipient Account for the business or individual.

API Operations

Steps: Card Recipient Financial Account

Send a request to the following endpoint:

POST /api/external/recipients/{recipientId}/financial-accounts/card

  • Use the {recipientId} path parameter to specify the Recipient Account ID. The Financial Account will be created for this Recipient Account.
  • Include details about the card in the request body. 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.

Steps: Bank Account Recipient Financial Account

Send a request to the following endpoint:

POST /api/external/recipients/{recipientId}/financial-accounts/bank-accounts

  • Use the {recipientId} path parameter to specify the Recipient Account ID. The Financial Account will be created for this Recipient Account.
  • Include details about the bank account in the request body. 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 debit card Recipient Financial Account.

				
					{
  "name": "Debit Card",
  "defaultFlag": true,
  "card": {
    "firstName": "Mark",
    "middleName": "David",
    "lastName": "Strong",
    "type": "DEBIT",
    "expiry": {
      "year": 2022,
      "month": "JANUARY",
      "monthValue": 1,
      "leapYear": false
    },
    "billingAddress": {
      "addressLine1": "625 Queen St",
      "addressLine2": "",
      "addressLine3": "",
      "city": "Vancouver",
      "state": "BC",
      "country": "Canada",
      "postalCode": "V5K 0A1"
    },
    "cardNumber": "84563876999"
  }
}
				
			

Sample Response

If the Recipient Financial Account creation is successful, a unique ID is returned for the account. Details about the account creation and the card or bank account are also returned.

The following example shows the response for the successful creation of a debit card Recipient Financial Account.

				
					{
  "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "createdAt": "2021-07-08T21:10:51.610Z",
  "updatedAt": "2021-07-08T21:10:51.610Z",
  "name": "Debit Card",
  "accountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "accountIdType": "RECIPIENT",
  "defaultFlag": true,
  "state": "ACTIVE",
  "financialInstitutionId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "financialInstitutionName": "CIBC",
  "ledgerIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "card": {
    "id": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
    "firstName": "Mark",
    "middleName": "David",
    "lastName": "Strong",
    "type": "DEBIT",
    "expiry": {
      "year": 2022,
      "month": "JANUARY",
      "monthValue": 1,
      "leapYear": false
    },
    "billingAddress": {
      "addressLine1": "625 Queen St",
      "addressLine2": "",
      "addressLine3": "",
      "city": "Vancouver",
      "state": "BC",
      "country": "Canada",
      "postalCode": "V5K 0A1"
    },
    "cardNumberTail": "6999"
  }
}
				
			
ON THIS PAGE