GET STARTED
RECIPIENT
FINANCIAL ACCOUNT
PAYMENT REASON
TRANSACTION
NOTE
Suspend or unsuspend a card Recipient Financial Account. To make an account inactive, set state to SUSPENDED. To reactivate a suspended account, set state to ACTIVE.
POST /api/external/financial-accounts/{financialAccountId}
Basic Auth REQUIRED
username is your API key ID and password is your API key secret.
financialAccountId REQUIRED
string (UUID)
ID of the Financial Account to be suspended or unsuspended.
state REQUIRED
string enum, values: SUSPENDED, ACTIVE
Recipient Account state. Possible values are SUSPENDED (make an account inactive) and ACTIVE (reactivate a suspended account).
Returns the Recipient Financial Account details. The following fields are returned.
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.
name
string, max length: 40, min length: 0
Name for the Financial Account.
accountId
string (UUID)
ID of the account that owns the Financial Account. This could be a Recipient Account or a Business Account.
accountIdType
string enum, values: RECIPIENT, BUSINESS_ACCOUNT
Type of account that owns the Financial Account. This could be a Recipient Account (RECIPIENT) or a Business Account (BUSINESS_ACCOUNT).
defaultFlag
boolean (true, 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.
financialInstitutionId
string (UUID)
Unique ID for the financial institution that issued the card. This is an internal ID used by RocketKOR.
financialInstitutionName
string, max length: 40, min length: 0
Name of the financial institution that issued the card.
ledgerIds
array of strings (UUID)
Accounting ledgers associated with the Financial Account.
card
object
Details for the card.
id
string (UUID)
Unique ID assigned to the card.
token
string (UUID)
Random alphanumeric token for the card details.
firstName
string, max length: 40, min length: 0
Recipient’s first name as it appears on the card.
middleName
string, max length: 40, min length: 0
Recipient’s middle name as it appears on the card.
lastName
string, max length: 40, min length: 0
Recipient’s last name as it appears on the card.
type
string enum, values: DEBIT
Type of card.
expiry
object
Expiry information for the card.
year
integer (int32)
Expiry year.
month
string enum, values: JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
Expiry month.
monthValue
integer (int32), values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
Expiry month as a numeral.
leapYear
boolean (true, false)
Whether the expiry year is a leap year.
billingAddress
object
Billing address for the card.
addressLine1
string, max length: 50, min length: 0
Address line 1.
addressLine2
string, max length: 50, min length: 0
Address line 2.
addressLine3
string, max length: 50, min length: 0
Address line 3.
city
string, max length: 25, min length: 0
City.
state
string, max length: 3, min length: 2
State or province.
country
string, max length: 3, min length: 3
3-digit country code.
postalCode
string, max length: 10, min length: 0
ZIP code or postal code.
cardNumberTail
string
Last 4 digits of the card number.
SAMPLE REQUEST
{
"state": "SUSPENDED"
}
SAMPLE RESPONSE
{
"id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"createdAt": "2021-07-08T21:10:51.610Z",
"updatedAt": "2021-07-08T21:10:51.610Z",
"name": "Debit Card",
"accountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
"accountIdType": "RECIPIENT",
"defaultFlag": true,
"state": "SUSPENDED",
"financialInstitutionId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
"financialInstitutionName": "CIBC",
"ledgerIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"card": {
"id": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
"firstName": "Mark",
"middleName": "David",
"lastName": "Strong",
"type": "DEBIT",
"expiry": {
"year": 2022,
"month": "JANUARY",
"monthValue": 1,
"leapYear": false
},
"billingAddress": {
"addressLine1": "625 Queen St",
"addressLine2": "",
"addressLine3": "",
"city": "Vancouver",
"state": "BC",
"country": "Canada",
"postalCode": "V5K 0A1"
},
"cardNumberTail": "6999"
}
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2022 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2022 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2022 by Rocket Financial Inc. All rights reserved.