List Accounts
GET /accounts/list
Returns a list of the accounts associated to a business
This list can use filters and also pagination.
Available Filters
This endpoint supports advanced filtering and search capabilities based on the parameters below.
The parameters should be appended to the API URL as follows:
https://api.druo.com/accounts/list?uuid=acc_1231-123123-123123-1234&end_user_email=j.smith@example.com.
| Category | Query Parameter | Description |
| General | type | The accounts type. |
| General | subtype | The account's suptype. |
| General | current_status | The account's current status |
| General | primary_reference | Any value contained within the primary reference. |
| General | secondary_reference | Any value contained within the secondary reference. |
| General | date_from | The beginning of the creation date range in GMT time. |
| General | date_to | The end of creation date range in GMT time. |
| Account | institution_uuid | The account's institution uuid |
| Account | uuid | The account's uuid |
| Account | code | The account's code |
| Account | last_4 | The account's last_4 |
| End User | end_user_uuid | Any transaction with an end user uuid |
| End User | end_user_code | Any transaction with an end user code |
| End User | end_user_email | Any transaction with an end user email |
| End User | end_user_local_id | Any transaction with an end user local id |
Response Fields
uuid
string
The Connected Account’s UUID.
Example value: acc_747536f4-1efd-4cad-91b3-cc8aaeed93e3
code
string
The Connected Account’s code.
Example value: ACSCDSVFGH
source_connect_link
string
The Connect Link used to connect this account.
Example value: clk_422f0f81-5001-4cce-a229-242d9ab9960a
current_status
string
The current status for this Connected Account.
Example value: CONNECTED
Check out the list of Account Status here.
requires_account_validation
string
If this field is true, please use the Validate Account endpoint with the slug of pending_account_validations.
Example values: TRUE FALSE
Check out the Validate Account Endpoint documentation here.
pending_account_validations
object
Object that contains the list of pending account validations to connect this Account.
If this field is present, use the Validate Account endpoint with the slug value.
Example value:
[
{
"slug":"b8772a3a-ca25-...-f044975a66eb",
"action":"CONFIRM_REQUEST_WITH_INSTITUTION"
}
]
Check out the Validate Account Endpoint documentation here.
remarks
string
The account remarks for this Connected Account.
Example value: ACCOUNT_DOES_NOT_EXIST
institution
object
Object that contains the UUID of the Institution where the Connected Account is registered and the name of it.
Example value: {"uuid": "ins_ff6c5094-1cd1-11ec-9621-0242ac130002", "name": "Banco"}
last_4
string
The last 4 digits of the actual account number.
Example value: 4524
type
string
The type of account. Determines whether account holds value.
Example value: DEPOSITORY
Check out the list of Account Types here.
subtype
string
The subtype of account. Provides futher detail about the type of account.
Example value: SAVINGS
Check out the list of Account Subtypes here.
capabilities
string
The capabilities available for this account.
Example value: PAYMENTS, BALANCE, IDENTITY, AUTHENTICATION, TRANSFERS
enabled_real_time_payouts
string
Wether the account is setup to have real time payouts or not
Example value: false | true
end_user
EndUser
The complete object for the End User related to this Account.
See more here.
disconnect_reason
string
The disconnection reason of account.
Example value: ACTIVITY_COMPLETED
Check out list of disconnect reason here.
disconnection_note
string
A note indicating why the account was disconnected.
Example value: No longer available
primary_reference
string
The connect link’s primary reference. Can be any value to associate the connected account to an entity in an external system.
Example value: 23423524
secondary_reference
string
The connect link’s primary reference. Can be any value to associate the connected account to an entity in an external system.
Example value: bj39fhow39fhqp3f0hfae4344
metadata
string
Set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.
Example value: {"order_id": "6735"}
creation_source
string
The creation source for this account.
Example value: MERCHANT_API
date_created_gmt
date-time
Create date of the account
Example value: 2021-11-15T23:23:38Z
date_updated_gmt
date-time
Updated date of the account
Example value: 2021-11-15T23:23:38Z
GET /accounts/list
curl --location 'https://api.druo.com/accounts/list' \ --header 'DRUO-Version: 2021-11-22' \ --header 'Authorization: Bearer ACCESS_TOKEN'
Response
{
"accounts": [
{
"uuid": "acc_a5b01eb0-43fd-4139-b3c4-175d846cbf46",
"code": "A6VKY44AJHC",
"source_connect_link": null,
"current_status": "VERIFICATION_IN_PROGRESS",
"requires_account_validation": false,
"pending_account_validations": null,
"remarks": null,
"institution": {
"uuid": "ins_ede4a882-c522-406a-b004-345d556ff971",
"name": "U.S. Bank"
},
"last_4": "4203",
"type": "DEPOSITORY",
"subtype": "SAVINGS",
"capabilities": [],
"enabled_real_time_payouts": false,
"end_user": {
"uuid": "eur_ff6c5094-1cd1-11ec-9621-0242ac130002",
"code": "EY67VK44FGG",
"type": "INDIVIDUAL",
"first_name": "John",
"last_name": "Doe",
"organization": "ABC Inc",
"local_id": "987654321",
"local_id_type": "DRIVER_LICENSE",
"local_id_country": "USA",
"date_of_birth": "1985-05-12",
"email": "johndoe@example.com",
"phone_number": {
"country_code": 1,
"number": 5551234567
},
"address": {
"address_line1": "123 Main St",
"address_line2": "Apt 301",
"address_line3": "Building C",
"locality": "Los Angeles",
"sublocality": "Downtown",
"administrative_district": "California",
"postal_code": "90001",
"country": "United States"
},
"preferred_language": "en_US",
"note": "Great customer.",
"primary_reference": "User Primary Reference Here",
"secondary_reference": "User Secondary Reference Here",
"metadata": {
"end_user_example_key_1": "end_user_example_value_1"
},
"creation_source": "MERCHANT_API",
"date_created_gmt": "2023-09-22T20:12:55.702Z",
"date_updated_gmt": "2023-09-22T20:12:55.702Z"
},
"disconnection_reason": null,
"disconnection_note": null,
"primary_reference": "Account Primary Reference Here",
"secondary_reference": "Account Secondary Reference Here",
"metadata": {
"account_example_key_1": "account_example_value_1"
},
"creation_source": "MERCHANT_API",
"date_created_gmt": "2023-09-22T20:12:55.702Z",
"date_updated_gmt": "2023-09-22T20:12:55.702Z"
}
],
"page_info": {
"has_next_page": false,
"page_size": 1
}
}