Payment Transaction
Search payments
Retrieve a list of payments based on search and filter criteria.
get/rest/v2/payments
Request
- The document declares no server URL.
- Authnone declared. Required headers: api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
customer-keystring required
Filters payment by the unique identifier of the associated customer.
plan-keystring required
Filters results by the unique identifier of the payment plan.
pageinteger required
Specifies the page number of results to return when pagination is applied.
page-sizeinteger required
Specifies the number of results to return per page.
isDescendingboolean required
Specifies the sort order of the results. Set to true for descending order. Default is true.
order-bystring required
Specifies the field used to sort the results.
Headers
api-keystring required
An access API key issued to you by Xplor Pay.
Response
ok
Changes
No recorded changes to this operation across all 1 revision of this API.