RocketKOR

COMING SOON

Issued Card Financial Account Object

The Issued Card Financial Account object represents an integrated Financial Account that is linked to an issued card.

Attributes

id

string (UUID)

ID of the Financial Account.

businessAccountId

string (UUID)

ID of the Business Account that contains the Financial Account.

name  

string, max length: 100, min length: 1

Name for the Financial Account. This is an informal name used for the account in RocketKOR.

category

string enum, value: INTEGRATED

Financial Account category. Value must be INTEGRATED.

type

string enum, value: CARD

Type of Financial Account. Value must be CARD.

subtype  

string enum, values: DEBIT, CREDIT, PREPAID, GIFT

Type of card.

defaultFlag

boolean, default: false

Whether this is the Customer’s default Financial Account for transactions.

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.

accountHolderId  

string (UUID)

ID of the Customer Account for which the card was issued.

accountHolderType

string enum, value: CUSTOMER

Type of entity referenced by the accountHolderId field. Value must be CUSTOMER.

state  

string enum, values: ACTIVE, SUSPENDED

Current status of the Financial Account. The following values are supported:

  • ACTIVE  Financial Account is active. A Financial Account is active when first created.
  • SUSPENDED  Financial Account is inactive. Inactive Financial Accounts cannot be used in transactions.

stateReason

string enum, values: CARD_ACTIVATED, CARD_REISSUED, ISSUED_INACTIVE, LOST_CARD, STOLEN_CARD, LOST_CARD_NOT_CAPTURED, STOLEN_CARD_NOT_CAPTURED, FRAUD_BLOCK

Reason for the Financial Account status.

The following values are supported for ACTIVE status:

  • CARD_ACTIVATED  Card has been activated.
  • CARD_REISSUED  Card has been reissued.

The following values are supported for SUSPENDED status:

  • ISSUED_INACTIVE  Card has been issued or reissued in an inactive state. The card state will become ACTIVE after the card is activated.
  • LOST_CARD  Card has been lost.
  • STOLEN_CARD  Card has been stolen.
  • LOST_CARD_NOT_CAPTURED  Card has been lost and one or more transactions have not been captured.
  • STOLEN_CARD_NOT_CAPTURED  Card has been stolen and one or more transactions have not been captured.
  • FRAUD_BLOCK  Card has been blocked due to potential fraud.

maskedAccountNumber

string

Masked card number for the issued card.

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.

card  

object

Details for the issued card attached to the Financial Account. See the Issued Card object.

Issued Card Financial Account Object

				
					{
  "id": "7d08a89d-2ac5-4ed3-a6ca-ad7c974c994e",
  "businessAccountId": "b535dce9-b71a-4f7b-b27f-73e47b13e7a5",
  "name": "Debit Card",
  "category": "INTEGRATED",
  "type": "CARD",
  "subtype": "DEBIT",
  "defaultFlag": false,
  "currency": "USD",
  "accountHolderId": "6d0b12d8-6e9d-4021-85da-b42ab3845f11",
  "accountHolderType": "CUSTOMER",
  "state": "ACTIVE",
  "stateReason": "CARD_ACTIVATED",
  "maskedAccountNumber": "******4823",
  "createdAt": "2023-02-09T02:31:07.792Z",
  "updatedAt": "2023-02-11T02:31:07.793Z",
  "card": {...}
}