RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Retrieve Financial Account Details

Retrieve details for a Recipient Financial Account. You can also request the following subresources for the Financial Account: the Recipient Account details (only available for card Financial Accounts), the Financial Account balances, and the Financial Account transaction limits.

Endpoint

GET /financial-accounts/{financialAccountId}

Authorization Header

Authorization: Bearer <access_token>

where <access_token> is your RocketKOR access token.

Path Parameters

financialAccountId  REQUIRED

string (UUID)

Financial Account ID.

Query Parameters

embed

string, values: recipient, balances, limits

Specify subresources to embed in the response. The subresources are returned in the _embedded object. The following subresources can be requested:

  • recipient  Details for the Recipient Account that owns the Financial Account. Only available for card Financial Accounts.
  • balances  Balances for the Financial Account.
  • limits  Limits for the Financial Account.

Use a comma-separated list to return multiple subresources (example: balance,recipient,limits).

Request Body

None

Returns

Returns the Financial Account details. The Card Financial Account object or Bank Financial Account object is returned, depending on whether the Financial Account is a card-based account or a bank account.

The _embedded object contains any requested subresources, including:

SAMPLE RESPONSE

				
					{
  "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "businessAccountId": "93f8edd6-d9e0-4d8e-b28d-cc3b81e36792",
  "recipientId": "c132f171-18f2-45ce-a80e-b04d797893fb",
  "name": "Debit Card",
  "defaultFlag": true,
  "currency": "USD",
  "state": "ACTIVE",
  "createdAt": "2021-07-08T21:10:51.610Z",
  "updatedAt": "2021-07-08T21:10:51.610Z",
  "accountType": "EXTERNAL",
  "card": {
    "firstName": "Mark",
    "middleName": "David",
    "lastName": "Strong",
    "type": "DEBIT",
    "expiry": "2027-12",
    "billingAddress": {
      "addressLine1": "625 Queen St",
      "addressLine2": "",
      "addressLine3": "",
      "city": "Vancouver",
      "state": "BC",
      "country": "Canada",
      "postalCode": "V5K 0A1"
    },
    "cardNumber": "84563876999"
  },
  "_embedded": {
    "recipient": {
      "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
      "businessAccountId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
      "businessRefId": "RECIP001",
      "firstName": "John",
      "middleName": "",
      "lastName": "Smith",
      "secondLastName": "",
      "email": "jsmith@xyz.com",
      "phoneNumber": "4161234567",
      "nationality": "Canadian",
      "dateOfBirth": "1970-07-08",
      "additionalInformation": "",
      "recipientType": "INDIVIDUAL",
      "businessName": "",
      "state": "ACTIVE",
      "createdAt": "2021-07-08T20:56:35.219Z",
      "updatedAt": "2021-07-08T20:56:35.219Z",
      "requestorId": "9kj43t32-2956-2886-x7dy-6r821w39kra3"
    },
    "balances": {
      "USD": {
        "accountBalance": "1000.00",
        "availableBalance": "800.00",
        "pendingWithdrawals": "200.00",
        "pendingDeposits": "300.00"
      }
      "CAD": {
        "accountBalance": "700.00",
        "availableBalance": "600.00",
        "pendingWithdrawals": "100.00",
        "pendingDeposits": "900.00"
      }
    },
    "limits": {
      "periods": [
        {
          "type": "daily",
          "from": "2022-06-22T00:00:00+00:00",
          "to": "2022-06-23T00:00:00+00:00",
          "amount": {
            "USD": {
              "limit": "10000.00",
              "used": "150.00"
            },
            "CAD": {
              "limit": "15000.00",
              "used": "350.00"
            }
          }
        },
        {
          "type": "weekly",
          "from": "2022-06-19",
          "to": "2022-06-25",
          "amount": {
            "USD": {
              "limit": "50000.00",
              "used": "2150.00"
            },
            "CAD": {
              "limit": "65000.00",
              "used": "550.00"
            }
          }
        },
        {
          "type": "monthly",
          "from": "2022-06-01T00:00:00+00:00",
          "to": "2022-07-01T00:00:00+00:00",
          "amount": {
            "USD": {
              "limit": "200000.00",
              "used": "20150.00"
            },
            "CAD": {
              "limit": "265000.00",
              "used": "17550.00"
            }
          }
        }
      ]
    }
  }
}