Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Return Requests

List return requests

List and filter return requests.

get/return_requests

Query parameters

limitinteger
starting_afterstring

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

connected_account_idstring

The ID of the connected account used to send or receive the return request.

type'sepa' | 'sepa_instant'

The type of the return request.

status'received' | 'sent' | 'accepted' | 'rejected' | 'pending' | 'denied'

The status of the return request.

return_reasonstring

The reason for returning the payment. Authorised reasons depend on the payment scheme. For SEPA, refer to SEPA reason codes.

related_payment_idstring uuid

The ID of the payment related to the return request.

related_payment_type'payment_order' | 'incoming_payment'

The type of the payment related to the return, either incoming_payment or payment_order.

start_datestring date

The creation date of the return request.

end_datestring date

The creation date of the return request.

start_value_datestring date

The start value date of the return request.

end_value_datestring date

The end value date of the return request.

file_idstring

The ID of the file including the return request.

Response

List of filtered return requests.

Example response

{
  "records": [
    {
      "object": "return_request",
      "metadata": {
        "property_a": true,
        "property_b": "false"
      },
      "additional_information": [
        "Insufficient funds",
        "Account closed"
      ]
    }
  ]
}