List payments
Returns a list of payments, optionally filtered by invoice, currency, status, or payment method.
Headers
string The Bearer token for authentication.
string The user agent of the request. Must contain at least two identifiers separated by a space.
string The content type of the request.
Parameters
string The ID of the resource you want to filter based on (e.g. Invoice).
string The currency you want to filter based on.
string The status you want to filter based on.
pendingfailedapprovedsettledrefundedcancelledstring The method you want to filter based on.
walletqrcardbankothernumber The number of results to return.
string The start date to filter based on.
string The end date to filter based on.
Response Body
application/jsonboolean Indicates that the request was successful.
object The payments data.
array The list of payments.
string The ID of the payment.
number The Serial ID of the payment.
string The ID of the invoice associated with the payment.
string The description or reference of the payment.
string The currency of the payment.
string Status of the payment.
pendingfailedapprovedsettledrefundedcancelledobject The payment method used for the payment.
string The provider of the payment method.
string Type of payment method.
walletqrcardbankotherobject The metadata of the payment method.
object The amount details of the payment.
float The sub total of the payment.
object The tax details of the payment.
float The tax rate of the payment.
string The applicable rate type.
percentagefixedfloat The total tax amount of the payment.
float The total due amount of the payment.
float The total fee amount of the payment.
float The total output amount of the payment.
object Customer shipping details schema.
string Full name of the customer.
string Phone number of the customer. (e.g. +597-8123456)
string Address line 1.
string Address line 2.
string City.
string State.
string Zip code.
string Country code in ISO 3166-1 alpha-2 format.
string The notes of the payment.
object The metadata of the payment.
date-time The date and time the payment was initiated.
date-time The date and time the payment was approved.
date-time The date and time the payment was settled.
date-time The date and time the payment was cancelled.
string The ID of the member who cancelled the payment.
date-time The date and time the payment was reversed.
string The ID of the member who reversed the payment.
date-time The estimated settlement date and time of the payment.