RErev-io
Payments

Search payments

Changed on

Search for one or more payments.

get/v1/Payments

Request

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

Return only entries created after this date.

search.created_date_endstring date-time

Return only entries created before this date.

search.payment_account_idinteger[]

Foreign identifier indicating the payment account used for the transaction.

search.page_sizeinteger

Defines how many items to return at a time.

search.pageinteger

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.

Changes

  • f175f5a3b11dRevision changes
    • warning

      added the new PSA enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new PSA enum value to the // response property for the response status (media type: text/json)

    • warning

      added the new PSA enum value to the // response property for the response status (media type: text/html)

    • info

      added the enum value PSA to the property items/ of the query request parameter search.source

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: text/json)

    • info

      added the optional property // to the response with the status (media type: text/html)