refunds

List refunds

Changed on

Use this method to return a paginated 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 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.

get/bank-transfer-refunds

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/bank-transfer-refunds
  • Auth
    HTTP bearer

Query parameters

processingTerminalIdstring required

Filter results by the unique identifier that we assigned to the terminal.

orderIdstring

Filter results by the order ID of the refund.

nameOnAccountstring

Filter results by the accountholder's name.

last4string

Filter results by the last four digits of the account number.

typeBankTransferRefundsGetParametersTypeSchemaItems[]

Filter results by transaction type.

statusBankTransferRefundsGetParametersStatusSchemaItems[]

Filter results by the status of the refund.

dateFromstring date-time

Filter results by refunds that the merchant ran after a specific date. The value follows the ISO 8601 standard.

dateTostring date-time

Filter results by refunds that the merchant ran before a specific date. The value follows the ISO 8601 standard.

settlementState'settled' | 'unsettled'

Filter results by the settlement status.

settlementDatestring date

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

beforestring

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.

afterstring

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.

limitinteger

Limit the maximum number of results that we return for each page.

Response

Successful request. Returns a list of refund transactions.

limitinteger required

Maximum number of results that we return for each page.

countinteger required

Number of results we returned on this page.

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

hasMoreboolean required

Indicates whether there is another page of results available.

Changes

  • 817f57a896f3Revision changes
    • breaking

      the //// response property's maxLength was increased from 100 to 255 for the response status

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API