Find Account

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

{
  "data": {
    "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"
    }
  },
  "ok": true
}

GET

api

csp

account

{account_id}

Find Account

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

{
  "data": {
    "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"
    }
  },
  "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

Path Parameters

account_id

string

required

The unique identifier for the account

Example:

"acct_ctf930420orabtojo3r0"

Response

Response when retrieving an account

Standard response structure for successful operations

boolean

Indicates if the operation was successful

Example:

true

data

object

Contains the response data Account information

Show child attributes

data.account_title

string

Title of the account

Example:

"John Doe"

data.created_at

object

A timestamp with seconds since epoch

Show child attributes

data.created_at.seconds

number<int64>

Time in seconds since epoch

Example:

1691831179

data.masked_account_number

string

Masked account number

Example:

"XXXX-XXXX-XXXX-1234"

data.partner_id

string

ID of the partner the account belongs to

Example:

"part_123456789"

data.routing_number

string

Routing number of the account

Example:

"123456789"

data.status

string

Status of the account

Example:

"active"

data.token

string

Account identifier token

Example:

"acct_123456789"

data.type

string

Type of the account

Example:

"checking"

data.updated_at

object

A timestamp with seconds since epoch

Show child attributes

data.updated_at.seconds

number<int64>

Time in seconds since epoch

Example:

1691831179

data.institution

object

Institution information

Show child attributes

data.institution.address

object

Show child attributes

data.institution.address.address

string

Example:

"123 Main St"

data.institution.address.city

string

Example:

"New York"

data.institution.address.postal_code

string

Example:

"10001"

data.institution.address.state

string

Example:

"NY"

data.institution.name

string

Example:

"Example Bank"

data.institution.phone_number

string

Example:

"+1234567890"

data.institution.routing_number

string

Example:

"123456789"

Create Account Delete Account

⌘I

API documentation

Authorizations

Headers

Path Parameters

Response