listClientBankAccounts

GET 
/api/clients/:document/bank-accounts

List all bank accounts of a client

Request

Path Parameters

document stringrequired
Client document
Example: 12345678901

Responses

200

Ok

application/json

Schema

Schema

data object[]
Array of client bank accounts)
Array [
anyOf
Client Bank Account
id id (integer)
Client Bank Account id
bank_ispb bank_ispb (string)
Bank ISPB
account_number account_number (string)
Account number
account_branch account_branch (string)
Account branch
]
links object

Links

first first (string)

Show first page link

last last (string)

Show last page link

prev prev (string)

Show previous page link

next next (string)

Show next page link

meta object

Links

current_page current_page (integer)

Current page number

from from (integer)

From page number

last_page last_page (integer)

Last page number

links object[]

Array of links to navigate the pages

Array [

anyOf

MetaLinks

url url (string)required

url

label label (string)required

label

active active (boolean)required

active

MetaLinks

url url (string)

url

label label (string)

label

active active (boolean)

active

MetaLinks

url url (string)required

url

label label (string)required

label

active active (boolean)required

active

]

path path (string)

Pagination path

per_page per_page (integer)

Pagination per_page number of items

to to (integer)

Pagination to page

total total (integer)

Total number of items per page

Example (from schema)

{
  "data": [
    {}
  ],
  "links": {
    "first": "http://payments-api-hml.zrobank.xyz/api/transactions?page=1",
    "last": "http://payments-api-hml.zrobank.xyz/api/transactions?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": null,
    "last_page": 1,
    "links": [
      {},
      {},
      {}
    ],
    "path": "http://payments-api-hml.zrobank.xyz/api/transactions",
    "per_page": 10,
    "to": null,
    "total": 1
  }
}

401

Unauthenticated

application/json

Schema

Schema

message message (integer)

Response 401

Example (from schema)

{
  "message": "Invalid x-api-key"
}

404

Client Not Found

application/json

Schema

Schema

message message (string)

Response 404

Example (from schema)

{
  "message": "Resource not found"
}

500

Error

Loading...