Sign in

v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB
Refunds

Refunds - List

Lists all the refunds associated with the merchant, or for a specific payment if payment_id is provided

post/refunds/list

Request body

start_timestring date-time required

The start time to filter payments list or to get list of filters. To get list of filters start time is needed to be passed

end_timestring date-time nullable

The end time to filter payments list or to get list of filters. If not passed the default time is now

payment_idstring nullable

The identifier for the payment

refund_idstring nullable

The identifier for the refund

profile_idstring nullable

The identifier for business profile

limitinteger nullable

Limit on the number of objects to return

offsetinteger nullable

The starting point within a list of objects

connectorstring[] nullable

The list of connectors to filter refunds list

merchant_connector_idstring[] nullable

The list of merchant connector ids to filter the refunds list for selected label

currencyCurrency[] nullable

The list of currencies to filter refunds list

refund_statusRefundStatus[] nullable

The list of refund statuses to filter refunds list

Response

List of refunds

countinteger required

The number of refunds included in the list

total_countinteger required

The total number of refunds in the list

Example response

{
  "data": [
    {
      "amount": 6540,
      "connector": "stripe",
      "split_refunds": {
        "adyen_split_refund": {
          "split_items": [
            {
              "amount": 6540
            }
          ]
        }
      }
    }
  ]
}