v1

latestOpenAPI 3.1.02026-07-24233206489.1 KB

List all Payments

Use secret API key to retrieve a list of Payments.

get/v1/payments

Query parameters

beforestring

A cursor for use in pagination. before is a resource ID that defines your place in the list. For example, if you make a request and receive 10 resources, starting with some_resource_id, your subsequent call can include before=some_resource_id in order to fetch the previous page of the list.

afterstring

A cursor for use in pagination. after is a resource ID that defines your place in the list. For example, if you make a list request and receive 10 resources, ending with some_resource_id, your subsequent call can include after=some_resource_id in order to fetch the next page of the list.

limitstring

Limit of resources to return. If not passed, the default limit is 10.

created_atstring date

Field to indicate when the payment was created

created_at.betweenstring

Field to indicate when the payment was made given a select period (Format: YYYY-DD-MM HH:mm..YYYY-DD-MM HH:mm)

created_at.gtstring date

Field to indicate when the payment was created after the given date (created_at.greater than)

created_at.gtestring date

Field to indicate when the payment was created after or on the given date (created_at.greater than or equal to)

created_at.ltstring date

Field to indicate when the payment was created before the given date (created_at.less than)

created_at.ltestring date

Field to indicate when the payment was created before or on the given date (created_at.less than or equal to)

statusstring

Field to filter payment transactions that are in the inputted status

Response

200

object required