The External Card Financial Account object represents an external Financial Account linked to a card, such as a debit card or credit card.
id
string (UUID)
ID of the 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, value: EXTERNAL
Financial Account category. Value must be EXTERNAL.
type
string enum, value: CARD
Type of Financial Account. Value must be CARD.
subtype
string enum, values: DEBIT, CREDIT
Type of card.
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:
maskedAccountNumber
string
Masked card number for the issued card.
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.
id
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:
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.
id
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:
updatedAt
string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the Financial Account was last updated.
card
object
Details for the card attached to the Financial Account.
firstName
string, min length: 1, max length: 40
First name of the Customer or Recipient, as it appears on the card.
middleName
string, min length: 1, max length: 40
Middle name of the Customer or Recipient, as it appears on the card.
lastName
string, min length: 1, max length: 40
Last name of the Customer or Recipient, as it appears on the card.
cardNumber
string, min length: 11, max length: 19
Card number.
cardNumberTail
string, max length: 4
Last 4 digits of the card number.
expiry
string, format: yyyy-MM
Expiry date for the card.
billingAddress
object
Billing address for the card.
addressLine1
string, min length: 1, max length: 50
Address line 1.
addressLine2
string, min length: 1, max length: 50
Address line 2.
addressLine3
string, min length: 1, max length: 50
Address line 3.
city
string, min length: 1, max length: 25
City.
stateCode
string, min length: 2, max length: 3
State, province, or territory. Required if country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2-character or 3-character country subdivision code. For example, Missouri is MO and Ontario is ON.
countryCode
string, min length: 3, max length: 3
Country. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA and Canada is CAN.
postalCode
string, min length: 1, max length: 10
ZIP code or postal code. For US addresses, must be a valid value of 5 digits (example: 63368) or 5 digits-4 digits (example: 63368-5555). Can be alphanumeric for other countries with a maximum length of 10 characters.
External Card Financial Account Object
{
"id": "string(UUID)",
"businessAccountId": "string(UUID)",
"name": "string",
"category": "EXTERNAL", // value must be EXTERNAL
"type": "CARD", // value must be CARD
"subtype": "DEBIT | CREDIT",
"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": "PENDING | ACTIVE | SUSPENDED",
"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)",
"card": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"cardNumber": "string",
"cardNumberTail": "string",
"expiry": "string",
"billingAddress": {
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"city": "string",
"stateCode": "string",
"countryCode": "string",
"postalCode": "string"
}
}
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2024 RocketKOR, Inc. All rights reserved.
