GET STARTED
RECIPIENT
FINANCIAL ACCOUNT
PAYMENT REASON
TRANSACTION
NOTE
Retrieve details for all Recipient Financial Accounts created within a Business Account.
You can filter the results based on the Recipient Financial Account type (bankAccount or card) and state (ACTIVE or SUSPENDED). Use the sort query parameter to sort the results, and use the page and size query parameters to limit the number of results returned.
Note Recipient Financial Accounts will be retrieved for the Business Account associated with the API key included in the request.
GET /api/external/recipients/payment-details
Basic Auth REQUIRED
username is your API key ID and password is your API key secret.
type
string, values: bankAccount, card
Filter the results by the type of Financial Account. Possible values are bankAccount (bank account) and card (card account).
state
string, values: ACTIVE, SUSPENDED
Filter the results by the state of the Financial Account. Possible values are ACTIVE (account is active) and SUSPENDED (account is inactive).
sort
string
Sort the response by any field in ascending or descending order. For details, see Sorting and Pagination. The default sort order is createdAt,DESC.
page
integer (int32)
Page number to return.
size
integer (int32)
Maximum number of results to return per page.
Returns a paginated response with an array of Financial Account objects. The following fields are returned for each Financial Account.
id
string (UUID)
Unique ID assigned to the Financial Account.
createdAt
string (date-time)
Date and time the Financial Account was created.
updatedAt
string (date-time)
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, 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, values: ACTIVE, SUSPENDED
Current status of the Financial Account. Possible values are ACTIVE (account is active) and SUSPENDED (account is inactive). A Recipient Account is ACTIVE when first created.
financialInstitutionId
string (UUID)
Unique ID for the financial institution. This is an internal ID used by RocketKOR.
financialInstitutionName
string, max length: 40, min length: 0
Name of the financial institution for the bank account.
ledgerIds
string (UUID)
Accounting ledgers associated with the Financial Account.
The following fields are returned for card accounts.
card
object
Card details.
id
string (UUID)
Unique ID assigned to the card.
token
string (UUID)
Random alphanumeric token for the card.
type
string enum, values: DEBIT
Type of card.
cardNumberTail
string
Last 4 digits of the card number.
The following fields are returned for bank accounts.
bankAccount
object
Bank account details.
id
string (UUID)
Unique ID assigned to the bank account.
token
string (UUID)
Random alphanumeric token for the bank account.
type
string enum, values: CHECKING, SAVING
Type of bank account.
accountNumberTail
string
Last 4 digits of the bank account number.
SAMPLE RESPONSE
{
"totalElements": 100,
"totalPages": 50,
"number": 1,
"numberOfElements": 2,
"hasNext": true,
"content": [
{
"id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"createdAt": "2021-07-08T21:10:51.610Z",
"updatedAt": "2021-07-08T21:10:51.610Z",
"name": "Checking Account",
"accountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
"accountIdType": "RECIPIENT",
"defaultFlag": true,
"state": "ACTIVE",
"financialInstitutionId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
"financialInstitutionName": "CIBC",
"ledgerIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"bankAccount": {
"id": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
"token": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
"type": "CHECKING",
"accountNumberTail": "4523"
}
},
{
"id": "1wl83a98-1243-6856-g3sg-2s680s13pkm3",
"createdAt": "2021-07-08T21:10:51.610Z",
"updatedAt": "2021-07-08T21:10:51.610Z",
"name": "Debit Card",
"accountId": "5ws94h37-1792-6523-r3jn-9z754i34kin5",
"accountIdType": "RECIPIENT",
"defaultFlag": false,
"state": "ACTIVE",
"financialInstitutionId": "9qw98h31-3978-2498-g2ko-8w965t32kwe6",
"financialInstitutionName": "CIBC",
"ledgerIds": [
"4hy47a98-2453-9867-u3qa-5p347q98kim4"
],
"card": {
"id": "9kj43t32-2956-2886-x7dy-6r821w39kra3",
"token": "8hb21a87-3985-9217-a6zq-5y643x47hsa7",
"type": "DEBIT",
"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.