GET STARTED
RECIPIENT
FINANCIAL ACCOUNT
PAYMENT REASON
TRANSACTION
NOTE
Retrieve all Recipient Accounts created within a Business Account.
Use the state and search query parameters to filter the results. 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 Accounts will be retrieved for the Business Account associated with the API key included in the request.
GET /api/external/recipients
Basic Auth REQUIRED
username is your API key ID and password is your API key secret.
state
string, values: ACTIVE, SUSPENDED
Filter the results by the Recipient Account state. Possible values are ACTIVE (account is active) and SUSPENDED (account is inactive).
search
string
Limit the results based on the following fields.
firstName
string, max length: 40, min length: 0
Recipient’s first name.
middleName
string, max length: 40, min length: 0
Recipient’s middle name.
lastName
string, max length: 40, min length: 0
Recipient’s last name.
string, max length: 100, min length: 0
Recipient’s email address.
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 pagination information and an array of Recipient Accounts. The following fields are returned for each Recipient Account.
id
string (UUID)
Unique ID assigned to the Recipient Account.
createdAt
string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the Recipient Account was created.
updatedAt
string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the Recipient Account was last updated.
requestorId
string, max length: 40, min length: 0
ID of the entity that requested the Recipient Account creation. This could be a RocketKOR Business Account (if the account is created via an API) or a Team Member (if the account is created in the RocketKOR Portal).
businessAccountId
string (UUID)
ID of the Business Account that the Recipient Account belongs to.
clientId
string, max length: 40, min length: 0
ID of the client application interacting with the RocketKOR system.
businessRefId
string, max length: 40, min length: 0
Your organization’s internal reference number assigned to the Recipient Account. This reference number is not used by RocketKOR.
createdSource
string, max length: 40, min length: 0
Application used to create the Recipient Account, such as a RocketKOR API, the RocketKOR Portal, or an iframe.
firstName
string, max length: 40, min length: 0
Recipient’s first name.
middleName
string, max length: 40, min length: 0
Recipient’s middle name.
lastName
string, max length: 40, min length: 0
Recipient’s last name.
secondLastName
string, max length: 40, min length: 0
Recipient’s second last name.
string, max length: 100, min length: 0
Recipient’s email address.
phoneNumber
string, max length: 40, min length: 0
Recipient’s phone number.
nationality
string, max length: 40, min length: 0
Recipient’s nationality.
dateOfBirth
string (date), required format: YYYY-MM-DD
Recipient’s date of birth.
additionalInformation
string, max length: 500, min length: 0
Additional information or notes about the recipient.
recipientType
string, values: BUSINESS, INDIVIDUAL
Type of recipient.
businessName
string, max length: 40, min length: 0
Business name. Required if recipientType is BUSINESS.
state
string, values: ACTIVE, SUSPENDED
Current status of the Recipient Account. Possible values are ACTIVE (account is active) and SUSPENDED (account is inactive). A Recipient Account is ACTIVE when first created.
SAMPLE RESPONSE
{
"totalElements": 100,
"totalPages": 50,
"number": 1,
"numberOfElements": 2,
"hasNext": true,
"content": [
{
"createdAt": "2021-07-08T20:56:35.219Z",
"updatedAt": "2021-07-10T12:35:22.217Z",
"id": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
"requestorId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
"businessAccountId": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
"clientId": "C12X896Y",
"businessRefId": "RECIP001",
"createdSource": "SDK iOS",
"firstName": "John",
"middleName": "",
"lastName": "Smith",
"secondLastName": "",
"email": "jsmith@xyz.com",
"phoneNumber": "9055621258",
"nationality": "Canadian",
"dateOfBirth": "1970-07-08",
"additionalInformation": "",
"recipientType": "INDIVIDUAL",
"businessName": "",
"state": "ACTIVE"
},
{
"createdAt": "2021-09-08T20:56:35.219Z",
"updatedAt": "2021-09-10T12:35:22.217Z",
"id": "1wl83a98-1243-6856-g3sg-2s680s13pkm3",
"requestorId": "5ws94h37-1792-6523-r3jn-9z754i34kin5",
"businessAccountId": "9qw98h31-3978-2498-g2ko-8w965t32kwe6",
"clientId": "D45Q327P",
"businessRefId": "RECIP002",
"createdSource": "SDK iOS",
"firstName": "Jane",
"middleName": "",
"lastName": "Jones",
"secondLastName": "",
"email": "jjones@abc.com",
"phoneNumber": "9053217869",
"nationality": "Canadian",
"dateOfBirth": "1990-09-07",
"additionalInformation": "",
"recipientType": "INDIVIDUAL",
"businessName": "",
"state": "ACTIVE"
}
]
}
© 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.