List Accounts
Returns the accounts the member holds. Each entry carries an accountUuid to send back, unchanged, as the account_uuid on List Disputable Transactions and the Eligibility Check. Use description as the display label in an account picker. account_type filters to one or more account types (repeat the query param); omit it to receive every type. Jointly held accounts are included, with holderType describing the ownership; no other holder's details are ever returned. This is the only endpoint whose customer_uuid also accepts the member's encrypted tax id - see the "Encrypting the tax id" concept page.
Query Parameters
- Type: stringcustomer
Uuid customer_uuid accepts either form of the member identifier: one Casap already issued (returned as-is), or the member's tax id encrypted with the org's Casap-issued public key (RSA-OAEP with SHA-256 as both the OAEP and MGF1 digest; base64-encode, then percent-encode). See "Encrypting the tax id" concept page for common pitfalls. Every other RPC's customer_uuid only accepts the identifier this endpoint resolves to.
- Type: array of "ACCOUNT_TYPE_UNKNOWN" or "ACCOUNT_TYPE_DEBIT" or "ACCOUNT_TYPE_CREDIT"enumaccount
Type account_type narrows the result to one or more of the listed account types (e.g. debit only, or debit and credit explicitly). Leave empty to receive every type.
Responses
- application/json
- application/json
curl /v1/accounts \
--header 'Authorization: YOUR_SECRET_TOKEN'
{
"accounts": [
{
"accountType": "ACCOUNT_TYPE_DEBIT",
"accountUuid": "1986120001",
"customerUuid": "09e01299-e3a7-46c3-af16-a8316c30619e",
"description": "Regular Savings",
"holderType": "Primary",
"memberId": "198612",
"openedAt": 1554076800,
"shareId": "0001"
},
{
"accountType": "ACCOUNT_TYPE_DEBIT",
"accountUuid": "1986120010",
"customerUuid": "09e01299-e3a7-46c3-af16-a8316c30619e",
"description": "Free Checking",
"holderType": "Joint",
"memberId": "198612",
"openedAt": 1618531200,
"shareId": "0010"
}
]
}