SLT Credit Financial Account Object

The Credit Financial Account object represents the Financial Account used as the credit account (receiver of funds) for a transaction.

Attributes

string (UUID)

ID of the Financial Account.

parentId

string (UUID)

ID of the Parent Financial Account.

businessAccountId

string (UUID)

ID of the Business Account that contains the Financial Account.

name

string, min length: 1, max length: 100

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

category

string enum, values: EXTERNAL, INTEGRATED, INTERNAL

Financial Account category. The following values are supported:

EXTERNAL Linked to an account that is issued or managed by an outside financial institution. Example: A debit card or bank account issued by a financial institution.
INTEGRATED Linked to a third-party account at a third-party institution. Example: A debit card or bank account issued on RocketKOR.
INTERNAL Created within RocketKOR to manage funds and track account balances for a Customer. Not linked to an account at a financial institution.

type

string enum, values: BANK, CARD

Type of Financial Account. The following values are supported:

BANK Bank account
CARD Debit or credit card

subtype

string enum; values for BANK Financial Accounts: CHECKING, SAVING; values for CARD Financial Accounts: CREDIT, DEBIT

Financial Account subtype.

Values supported for BANK Financial Accounts: SAVING, CHECKING
Values supported for CARD Financial Accounts: CREDIT, DEBIT

defaultFlag

boolean, default: false

Whether this is the default Financial Account for transactions.

currency

string, min length: 3, max length: 3

Currency of the Financial Account. Must be an ISO 4217 alpha 3-character currency code.

accountHolderId

string (UUID)

ID of the entity that owns the Financial Account. Returned if the account holder is a Customer or Recipient. This field is not returned if the account holder is a Business Account.

accountHolderType

string enum, values: CUSTOMER, RECIPIENT

Type of entity that owns the Financial Account. Returned if the account holder is a Customer or Recipient. Omitted if the account holder is a Business Account.

state

string enum, values: PENDING, ACTIVE, SUSPENDED

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

PENDING Financial Account is being processed and is not yet active.
ACTIVE Financial Account is active.
SUSPENDED Financial Account is inactive. Inactive Financial Accounts cannot be used in transactions.

stateReason

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

Applies to integrated card Financial Accounts. 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 PENDING status:

PENDING Card is pending acceptance.

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 account number for the Financial Account (bank account number or card number).

verificationStatus

object

Current verification status of the Financial Account.

verificationMethod

string enum, values: PRENOTE, AGGREGATION

Method used to verify the Financial Account.

createdBy

object

Entity that created the Financial Account.

string (UUID)

ID of the entity. Will be blank if createdBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
internal Internal service call.
kor_employee Rocket Financial employee.
service-account Service Account using APIs.

createdAt

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

Date and time the Financial Account was created.

updatedBy

object

Entity that last updated the Financial Account.

string (UUID)

ID of the entity. Will be blank if updatedBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
internal Internal service call.
kor_employee Rocket Financial employee.
service-account Service Account using APIs.

updatedAt

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

Date and time the Financial Account was last updated.

SLT Credit Financial Account Object

				
					{
  "creditFinancialAccount": {
    "id": "string(UUID)",
    "parentId": "string(UUID)",
    "businessAccountId": "string(UUID)",
    "name": "string",
    "category": "EXTERNAL | INTEGRATED | INTERNAL",
    "type": "BANK | CARD",
    "subtype": "CHECKING | SAVING | CREDIT | DEBIT",
    "defaultFlag": boolean,
    "currency": "string",
    "accountHolderId": "string(UUID)", // omitted if the account holder is a Business Account
    "accountHolderType": "CUSTOMER | RECIPIENT", // omitted if the account holder is a Business Account
    "state": "ACTIVE | PENDING | SUSPENDED",
    "stateReason": "CARD_ACTIVATED | CARD_REISSUED | ISSUED_INACTIVE | LOST_CARD | STOLEN_CARD | LOST_CARD_NOT_CAPTURED | STOLEN_CARD_NOT_CAPTURED | FRAUD_BLOCK",
    "maskedAccountNumber": "string",
    "verificationStatus": "UNVERIFIED | PENDING | PROCESSING | REVIEW | DECLINED | APPROVED | ERROR",
    "verificationMethod": "PRENOTE | AGGREGATION",
    "createdBy": {
      "id": "string(UUID)",
      "type": "employee | internal | kor_employee | service-account"
    },
    "createdAt": "string(date-time)",
    "updatedBy": {
      "id": "string(UUID)",
      "type": "employee | internal | kor_employee | service-account"
    },
    "updatedAt": "string(date-time)"
  }
}