List Accounts

curl --request GET \
  --url https://sandbox.api.paylias.xyz/gateway/api/v1/csp/account \
  --header 'Authorization: Bearer <token>' \
  --header 'x-partner-id: <x-partner-id>'

{
  "data": {
    "count": 2,
    "accounts": [
      {
        "account_title": "John Doe",
        "created_at": {
          "seconds": 1635784800
        },
        "masked_account_number": "XXXX-XXXX-XXXX-1234",
        "partner_id": "part_123456789",
        "routing_number": "123456789",
        "status": "active",
        "token": "acct_123456789",
        "type": "checking",
        "updated_at": {
          "seconds": 1635788400
        },
        "institution": {
          "address": {
            "address": "123 Main St",
            "city": "New York",
            "postal_code": "10001",
            "state": "NY"
          },
          "name": "Example Bank",
          "phone_number": "+1234567890",
          "routing_number": "123456789"
        }
      },
      {
        "account_title": "Jane Smith",
        "created_at": {
          "seconds": 1635784900
        },
        "masked_account_number": "XXXX-XXXX-XXXX-5678",
        "partner_id": "part_123456789",
        "routing_number": "987654321",
        "status": "active",
        "token": "acct_987654321",
        "type": "savings",
        "updated_at": {
          "seconds": 1635788500
        },
        "institution": {
          "address": {
            "address": "456 Oak Ave",
            "city": "San Francisco",
            "postal_code": "94103",
            "state": "CA"
          },
          "name": "Second Bank",
          "phone_number": "+0987654321",
          "routing_number": "987654321"
        }
      }
    ]
  },
  "ok": true
}

GET

api

csp

account

List Accounts

curl --request GET \
  --url https://sandbox.api.paylias.xyz/gateway/api/v1/csp/account \
  --header 'Authorization: Bearer <token>' \
  --header 'x-partner-id: <x-partner-id>'

{
  "data": {
    "count": 2,
    "accounts": [
      {
        "account_title": "John Doe",
        "created_at": {
          "seconds": 1635784800
        },
        "masked_account_number": "XXXX-XXXX-XXXX-1234",
        "partner_id": "part_123456789",
        "routing_number": "123456789",
        "status": "active",
        "token": "acct_123456789",
        "type": "checking",
        "updated_at": {
          "seconds": 1635788400
        },
        "institution": {
          "address": {
            "address": "123 Main St",
            "city": "New York",
            "postal_code": "10001",
            "state": "NY"
          },
          "name": "Example Bank",
          "phone_number": "+1234567890",
          "routing_number": "123456789"
        }
      },
      {
        "account_title": "Jane Smith",
        "created_at": {
          "seconds": 1635784900
        },
        "masked_account_number": "XXXX-XXXX-XXXX-5678",
        "partner_id": "part_123456789",
        "routing_number": "987654321",
        "status": "active",
        "token": "acct_987654321",
        "type": "savings",
        "updated_at": {
          "seconds": 1635788500
        },
        "institution": {
          "address": {
            "address": "456 Oak Ave",
            "city": "San Francisco",
            "postal_code": "94103",
            "state": "CA"
          },
          "name": "Second Bank",
          "phone_number": "+0987654321",
          "routing_number": "987654321"
        }
      }
    ]
  },
  "ok": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-partner-id

string

default:""

required

The Partner ID header used for authorization

Query Parameters

account_titles

string

Filter based on account titles

Example:

"Safepay Inc."

routing_numbers

string

Filter based on routing numbers

Example:

"011000015"

status

enum<string>

Filter for accounts with a specific status

Available options:

AS_Verified,

AS_Unverified,

AS_Deleted

Example:

"AS_Verified"

limit

string

Set the limit for search results

Example:

"3"

page

string

Set the page offset

Example:

"1"

Response

Response when retrieving a list of accounts

Standard response structure for successful operations

boolean

Indicates if the operation was successful

Example:

true

data

object

Contains the response data

Show child attributes

data.count

integer

Total number of accounts

Example:

2

data.accounts

object[]

List of account objects

Show child attributes

data.accounts.account_title

string

Title of the account

Example:

"John Doe"

data.accounts.created_at

object

A timestamp with seconds since epoch

Show child attributes

data.accounts.created_at.seconds

number<int64>

Time in seconds since epoch

Example:

1691831179

data.accounts.masked_account_number

string

Masked account number

Example:

"XXXX-XXXX-XXXX-1234"

data.accounts.partner_id

string

ID of the partner the account belongs to

Example:

"part_123456789"

data.accounts.routing_number

string

Routing number of the account

Example:

"123456789"

data.accounts.status

string

Status of the account

Example:

"active"

data.accounts.token

string

Account identifier token

Example:

"acct_123456789"

data.accounts.type

string

Type of the account

Example:

"checking"

data.accounts.updated_at

object

A timestamp with seconds since epoch

Show child attributes

data.accounts.updated_at.seconds

number<int64>

Time in seconds since epoch

Example:

1691831179

data.accounts.institution

object

Institution information

Show child attributes

data.accounts.institution.address

object

Show child attributes

data.accounts.institution.address.address

string

Example:

"123 Main St"

data.accounts.institution.address.city

string

Example:

"New York"

data.accounts.institution.address.postal_code

string

Example:

"10001"

data.accounts.institution.address.state

string

Example:

"NY"

data.accounts.institution.name

string

Example:

"Example Bank"

data.accounts.institution.phone_number

string

Example:

"+1234567890"

data.accounts.institution.routing_number

string

Example:

"123456789"

Find Namespace Create Account

⌘I

API documentation

Authorizations

Headers

Query Parameters

Response