Skip to main content
GET
/
customer
/
account
/
{account_id}
/
deposit-locations
Get Client Deposit Locations Signed
curl --request GET \
  --url https://api.example.com/customer/account/{account_id}/deposit-locations \
  --header 'X-API-KEY: <x-api-key>' \
  --header 'X-API-NONCE: <x-api-nonce>' \
  --header 'X-API-SIGNATURE: <x-api-signature>' \
  --header 'X-API-TIMESTAMP: <x-api-timestamp>'
{
  "message": "<string>",
  "data": [
    {
      "location_id": 123,
      "name": "<string>",
      "city_and_state": "London, CA",
      "balance": 1000
    }
  ],
  "as_of_date": "<string>",
  "pagination": {
    "limit": 123,
    "total": 123,
    "offset": "<unknown>"
  }
}
Retrieve deposit locations associated with a specific account. This endpoint supports pagination and filtering by load date, returning information about where deposits can be made for the account.

Headers

​
X-API-SIGNATURE
string
required

Signature header

​
X-API-TIMESTAMP
integer
required

Timestamp header

​
X-API-NONCE
string
required

Nonce header

​
X-API-KEY
string
required

Account ID header

Path Parameters

​
account_id
string
required

Query Parameters

​
page_number
integer | null

Page number for pagination

​
page_size
integer | null
default:100

Number of transactions per page

​
load_date
string<date> | null

Load date

Response

Successful Response

​
message
string
required
​
data
ClientDepositLocationsResponse · object[] | null
​
as_of_date
string | null

As of date for the data

​
pagination
Pagination · object

Represent the pagination structure.