RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Card Summary Object

The Card Summary object represents basic details for a card-based Financial Account, such as a Mastercard or Visa debit card.

Attributes

id

string (UUID)

Unique ID assigned to the Financial Account.

createdAt

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

Date and time the Financial Account was created.

updatedAt

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

Date and time the Financial Account was last updated.

accountId

string (UUID)

ID of the Business Account that owns the Financial Account.

entityId  

string (UUID)

ID of the entity that owns the Financial Account.

entityType

string enum

Type of entity that owns the Financial Account.

defaultFlag

boolean

default: false

Whether this the default Financial Account for transactions.

state  

string enum, values: ACTIVE, SUSPENDED

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

currency

string, max length: 3, min length: 3

default: USD

Currency of the Financial Account. Must be an ISO 4217 alpha 3-character currency code. RocketKOR supports USD and CAD currencies.

maskedAccountNumber

string

Masked account number for the card account.

type  

string enum, values: DEBIT

Type of card.

accountType

string enum, values: INTERNAL, EXTERNAL

Type of account. Possible values are:

  • INTERNAL  RocketKOR Financial Acccounts
  • EXTERNAL  Bank and card accounts issued by a financial institution

card  

object

Details for the card attached to the Financial Account.

type  

string enum, values: DEBIT

Type of card.

cardNumberTail

string, max length: 4

Last 4 digits of the card number.

The Card Summary Object

				
					{
  "id": "90dcbd64-b1fa-4429-adeb-4d5e8dcf90d7",
  "createdAt": "2022-07-14T21:41:28.111137Z",
  "updatedAt": "2022-07-14T21:41:28.111137Z",
  "accountId": "26b0ef39-72e9-4b0a-a183-9f1142083f03",
  "entityId": "8eb2a485-c074-40ac-a6e4-7a49e442ce45",
  "entityType": "RECIPIENT",
  "defaultFlag": false,
  "state": "ACTIVE",
  "currency": "USD",
  "maskedAccountNumber": "************4242",
  "type": "DEBIT",
  "accountType": "EXTERNAL",
  "card": {
    "type": "DEBIT",
    "cardNumberTail": "4242"
  }
}