List Payments
Returns a list of transactions. It can be paged and filtered by appending arguments to the query string of the request.
Authentication
AuthorizationBasic
Query parameters
paymentType
Returns payments of this Payment Type. It is possible to filter by multiple values by repeating this argument.
merchantReference
Returns transactions of the payments associated with this merchant reference.
verification.status
Returns transactions of the payments at this payment Verification Status.
paymentId
Returns payments of this identification.
merchant.merchantId
Returns payments by this merchant identification.
description
Returns payments by description.
paymentProvider.paymentProviderId
Returns payments by this payment provider identification.
customer.customerId
Returns payments by this customer identification.
fingerprint
Returns payments by this fingerprint.
createdAt.start
Returns payments after this creation date
createdAt.end
Returns payments before this creation date
updatedAt.start
Returns payments after this update date
updatedAt.end
Returns payments before this update date
amount.min
Returns payments for that minimum amount.
amount.max
Returns payments for that maximum amount.
paid.min
Returns payments for that minimum paid.
paid.max
Returns payments for that maximum paid.
refunded.min
Returns payments with this minimum refund amount.
refunded.max
Returns payments with this maximum refund amount.
orderBy
List payments by order field.
sortOrder
Returns payments by this sort order
startIndex
Returns payments from that offset
count
Returns the maximum number of payments specified by this field
Response
OK
payments
startIndex
itemsPerPage