List return requests

get

https://sandbox.numeral.io/v1/return_requests

List and filter return requests.

Query Params

limit

int32

Defaults to 25

starting_after

string

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

sort_order

string

enum

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.

Allowed:

connected_account_id

string

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

type

string

enum

The type of the return request.

Allowed:

status

string

enum

The status of the return request.

Allowed:

return_reason

string

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

related_payment_id

uuid

The ID of the payment related to the return request.

related_payment_type

string

enum

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

Allowed:

start_date

date

The creation date of the return request.

end_date

date

The creation date of the return request.

start_value_date

date

The start value date of the return request.

end_value_date

date

The end value date of the return request.

file_id

string

The ID of the file including the return request.

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of filtered return requests.

400Validation error.

500Internal server error.