Skip to main content

​
Endpoint

  • Method: GET
  • URL: {{LIQUIDITY_URL}}/v1/ext/linked-accounts/:currency?limit=10&page=1
  • Auth: Bearer {{accessToken}}

​
Path Parameters

ParameterTypeDescriptionRequired
currencystringCurrency code (e.g., USD)Yes

​
Query Parameters

ParameterTypeDescriptionRequired
limitintegerNumber of results per page (default: 10)No
pageintegerPage number (default: 1)No
externalIdstringFilter by external ID (optional)No

​
Request

curl -X GET "{{LIQUIDITY_URL}}/v1/ext/linked-accounts/USD?limit=10&page=1" \
  -H "Authorization: Bearer {{accessToken}}"

​
Response (200)

{
  "data": [
    {
      "id": "8937b3cf-9b13-4b3b-b9a8-fd1fbb0583cd",
      "currency": "USD",
      "optionType": "bank",
      "account": {
        "label": "Josh Fairpuny - Bank #3340",
        "lastFourDigits": "0000"
      },
      "wallet": {
        "id": "3eb8d02c-30e0-497c-a6ac-e2d203c63198",
        "balance": "25732.00",
        "disabled": false
      },
      "entity": {
        "id": "d5e6f1dd-57bc-4581-98e8-646264a5f2c9",
        "entityType": "BUSINESS"
      }
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 5,
    "pageCount": 5,
    "total": 21
  }
}

​
Response Fields

FieldTypeDescription
dataarrayArray of linked account objects
data[].idstringLinked account ID
data[].currencystringCurrency of the linked account
data[].optionTypestringAccount type: bank, card, international_bank, zelle, venmo, paypal, prepaid_card
data[].account.labelstringDisplay label for the account (if applicable)
data[].account.lastFourDigitsstringLast 4 digits of account/card number (when available)
data[].wallet.idstringAssociated wallet ID
data[].wallet.balancestringCurrent wallet balance
data[].wallet.disabledbooleanWhether the wallet is disabled
data[].entity.idstringEntity ID associated with the account
data[].entity.entityTypestringEntity type: USER or BUSINESS
meta.pageintegerCurrent page number
meta.pageSizeintegerNumber of items per page
meta.pageCountintegerTotal number of pages
meta.totalintegerTotal number of linked accounts

​
Notes

  • Results are paginated; use limit and page parameters to navigate
  • Linked accounts are filtered by currency