API Reference

Get Payments List

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

Overview

Get Payments List. Available for Staff Tokens.

Prerequisites

The business must have the payments_module feature enabled.

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

Page offset

string

Page size

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. client_id: filter[client_id][eq]=client_id. invoice_id: filter[invoice_id][eq]=invoice_id.

string

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

Headers
string

A unique identifer of the business. Can be the Business UID or nickname\external ID

Response

Updated 2 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 2 months ago