Paycose Docs
Bank Account
GET/bank_accounts

List

List all bank accounts.

Supports page-based and cursor-based pagination.

Requires: Bearer token, X-Country header.

Request

Example

curl -X GET 'https://api.paycose.com/api/v1/app1/platform/wallet/bank_accounts/?limit=10&page=1&use-cursor=true&starting_after=&ending_before=&sort=created_at:desc&q=&filter[account]=&filter[account_id]=&filter[active]=&filter[created_at]=&filter[id]=&filter[labels]=&filter[provider_id]=&filter[reference_id]=&filter[reference_only]=&filter[type]=&filter[updated_at]=&filter[verified]=' \
  -H 'X-Session-Token: {{session_token}}' \
  -H 'X-Country: {{country}}' \
  -H 'X-Test-Mode: {{x_test_mode}}'

Headers

NameValueDescription
X-Session-Token{{session_token}}
X-Country{{country}}
X-Test-Mode{{x_test_mode}}true=wallet_test, false=wallet_live (default). Toggle the x_test_mode collection variable to flip every applicable request.

Responses

200200 OK

Headers

NameValue
Content-Typeapplication/json

Body

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "<string>",
      "livemode": false,
      "created_at": null,
      "updated_at": null,
      "account": "<string>",
      "account_holder_name": "<string>",
      "account_number": "<string>",
      "routing_number": "<string>",
      "bank_code": "<string>",
      "bank": {
        "object": "<string>",
        "code": "<string>",
        "name": "<string>",
        "slug": "<string>"
      },
      "branch_code": "<string>",
      "account_type": "<string>",
      "phone_number": "<string>",
      "primary_identity_id": "<string>",
      "type": "<string>",
      "active": false,
      "verified": false,
      "reference_id": "<string>",
      "provider": "<string>",
      "recipients": [
        {
          "id": "<string>",
          "provider": "<string>",
          "reference_id": "<string>",
          "is_default": false
        }
      ],
      "metadata": {},
      "labels": "<core.Labels>"
    }
  ],
  "page": 1,
  "limit": 10,
  "total_items": 1,
  "total_pages": 1
}

On this page