List refunds | Payroc | Documentation

Use this method to return a paginated list of refunds.

Note: If you want to view the details of a specific refund and you have its refundId, use our Retrieve Refund method.

Use query parameters to filter the list of results that we return, for example, to search for refunds for a customer, a tender type, or a date range. Our gateway returns the following information about each refund in the list:

Order details, including the refund amount and when we processed the refund.
Payment card details, including the masked card number, expiry date, and payment method.
Cardholder details, including their contact information and shipping address.

For referenced refunds, our gateway also returns details about the payment that the refund is linked to.

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of refunds. **Note:** If you want to view the details of a specific refund and you have its refundId, use our [Retrieve Refund](https://docs.payroc.com/api/schema/payments/refunds/retrieve) method. Use query parameters to filter the list of results that we return, for example, to search for refunds for a customer, a tender type, or a date range. Our gateway returns the following information about each refund in the list: - Order details, including the refund amount and when we processed the refund. - Payment card details, including the masked card number, expiry date, and payment method. - Cardholder details, including their contact information and shipping address. For referenced refunds, our gateway also returns details about the payment that the refund is linked to.

Query parameters

processingTerminalIdstringOptional>=4 characters<=50 characters

Filter by terminal ID.

orderIdstringOptional>=1 character<=24 characters

Filter refunds by the unique identifier that the merchant assigned to the order.

operatorstringOptional>=1 character<=50 characters

Filter refunds by the operator who initiated the request.

cardholderNamestringOptional>=1 character<=50 characters

Filter refunds by cardholder name.

first6stringOptionalformat: "[0-9]{6}"

Filter refunds by the first six digits of the card number.

last4stringOptionalformat: "[0-9]{4}"

Filter refunds by the last four digits of the card number.

tenderenumOptional

Filter by tender type.

Allowed values:

statuslist of enumsOptional

Filter refunds by the current status of the refund.

dateFromdatetimeOptional

Filter by refunds processed after a specific date. The date format follows the ISO 8601 standard.

dateTodatetimeOptional

Filter by refunds processed before a specific date. The date format follows the ISO 8601 standard.

settlementStateenumOptional

Status of the settlement.

Allowed values:

settlementDatedateOptional

Date the transaction was settled.

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 paginated list of refunds.

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 refund objects.

linkslist of objects or null

Reference links to navigate to the previous page of results or to the next page of results.

Errors