SchemaPayments

List payments

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of payments. **Note:** If you want to view the details of a specific payment and you have its paymentId, use our [Retrieve Payment](https://docs.payroc.com/api/schema/payments/retrieve) method. Use query parameters to filter the list of results that we return, for example, to search for payments for a customer, a tip mode, or a date range. Our gateway returns the following information about each payment in the list: - Order details, including the transaction amount and when it was processed. - Payment card details, including the masked card number, expiry date, and payment method. - Cardholder details, including their contact information and shipping address. - Payment details, including the payment type, status, and response. For each transaction, we also return the paymentId and an optional secureTokenId, which you can use to perform follow-on actions.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

processingTerminalIdstringOptional>=4 characters<=50 characters
Filter by terminal ID.
orderIdstringOptional>=1 character<=24 characters
Filter payments by order ID.
operatorstringOptional>=1 character<=50 characters
Filter payments by operator.
cardholderNamestringOptional>=1 character<=50 characters

Filter payments by the cardholder’s name.

first6stringOptionalformat: "[0-9]{6}"
Filter payments by the first six digits of the card number that the customer used in the transaction.
last4stringOptionalformat: "[0-9]{4}"
Filter payments by the last four digits of the card number that the customer used in the transaction.
tenderenumOptional
Filter by tender type.
Allowed values:
tipModelist of enumsOptional
Filter payments by tip.
Allowed values:
typelist of enumsOptional
Filter payments by transaction type.
Allowed values:
statuslist of enumsOptional
Filter payments by the status of the transaction.
dateFromdatetimeOptional
Filter by payments that the processor processed after a specific date. The date format follows the ISO 8601 standard.
dateTodatetimeOptional
Filter by payments that the processer processed before a specific date. The date format follows the ISO 8601 standard.
settlementStateenumOptional
Filter payments by the settlement status of the transaction.
Allowed values:
settlementDatedateOptional

Filter by payments that the processor settled on a specific date in the format YYYY-MM-DD.

paymentLinkIdstringOptional=10 characters
Unique identifier that our gateway assigned to the payment link.
beforestringOptional

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstringOptional

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitintegerOptional<=100Defaults to 10
Limit the maximum number of results that we return for each page.

Response

Successful request. Returns a list of payments.
limitdouble
Maximum number of results that we return for each page.
countdouble

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean
Indicates whether there is another page of results available.
datalist of objects
Array of transactions.

Errors