SchemaPaymentsBank Transfer Refunds

List refunds

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of bank transfer 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/bank-transfer-refunds/retrieve) method. Use query parameters to filter the list of results that we return, for example, to search for refunds for a customer, an orderId, or a date range. Our gateway returns the following information about each refund in the list: - Order details, including the refund amount and when it was processed. - Bank account details, including the customer’s name and account number. For referenced refunds, our gateway also returns details about the payment that the refund is linked to.

Authentication

AuthorizationBearer

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

Query parameters

processingTerminalIdstringRequired>=4 characters<=50 characters
Filter results by the unique identifier that we assigned to the terminal.
orderIdstringOptional>=1 character<=24 characters
Filter results by the order ID of the refund.
nameOnAccountstringOptional>=1 character<=50 characters
Filter results by the accountholder's name.
last4stringOptionalformat: "[0-9]{4}"
Filter results by the last four digits of the account number.
typelist of enumsOptional
Filter results by transaction type.
Allowed values:
statuslist of enumsOptional
Filter results by the status of the refund.
dateFromdatetimeOptional
Filter results by refunds that the merchant ran after a specific date. The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard.
dateTodatetimeOptional
Filter results by refunds that the merchant ran before a specific date. The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard.
settlementStateenumOptional
Filter results by the settlement status.
Allowed values:
settlementDatedateOptional

Filter results by the settlement date. Send a value in YYYY-MM-DD format.

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

Errors