v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Payments

Search payments

Search for one or more payments.

get/v1/Payments

Query parameters

search.payment_idinteger[]

Query by identifier.

search.customer_idinteger[]

Query by account identifier.

search.bill_idinteger[]

Query by bill identifier.

search.agent_idinteger[]

Query by agent identifier.

search.created_byinteger[]

Query by creating user identifier.

search.sourcestring[]

Query by source.

search.methodstring[]

Query by method.

search.payment_type_idinteger[]

Query by user defined type identifier.

search.created_date_startstring date-time

Format - date-time (as date-time in RFC3339). Return only entries created after this date.

search.created_date_endstring date-time

Format - date-time (as date-time in RFC3339). Return only entries created before this date.

search.payment_account_idinteger[]

Foreign identifier indicating the payment account used for the transaction.

search.page_sizeinteger

Format - int32. Defines how many items to return at a time.

search.pageinteger

Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.