HomeGuidesAPI ExplorerAnnouncements
API Explorer
AboutContactRev.io

Search payments

get
https://api.revioapi.com/v1/Payments

Search for one or more payments.

Query Params
search.payment_id
array of int32s

Query by identifier.

search.payment_id
search.customer_id
array of int32s

Query by account identifier.

search.customer_id
search.bill_id
array of int32s

Query by bill identifier.

search.bill_id
search.agent_id
array of int32s

Query by agent identifier.

search.agent_id
search.created_by
array of int32s

Query by creating user identifier.

search.created_by
search.source
array of strings

Query by source.

search.source
search.method
array of strings

Query by method.

search.method
search.payment_type_id
array of int32s

Query by user defined type identifier.

search.payment_type_id
date-time

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

date-time

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

search.payment_account_id
array of int32s

Foreign identifier indicating the payment account used for the transaction.

search.payment_account_id
int32

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

int32

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

string

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/html
Updated 7 months ago