API Reference

Get Payments of Client

get
https://api.vcita.biz/platform/v1/clients//payments

Overview

Gets a list of payments for a client.

Authentication

Available for Staff, App, and Directory Tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

client's id

Query Params
string

Available filters: state: filter[state][in]=paid,pending,failed,refunded,cancelled,archived,incompleted. created_at: filter[created_at][eq/lt/lte/gt/gte]=2023-01-01 or 2023-01-01 09:30:00. updated_at: filter[updated_at][eq/lt/lte/gt/gte]=2023-01-01 or 2023-01-01 09:30:00.

string

Sort by one of the following: created_at, updated_at. Available operators: asc, desc. Example: sort=created_at:asc,updated_at:desc

string

Page offset

string

Page size

Responses

Updated 3 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago