List returns

get

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

List and filter returns.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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 trigger or receive the return.

type

string

enum

The type of the related payment.

Allowed:

return_type

string

enum

The type of the return. Authorized values include return, refund and reversal. Only available when related payment is a direct debit.

Allowed:

status

string

enum

The status of the return.

Allowed:

related_payment_id

uuid

The ID of the payment related to the return.

related_payment_type

string

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

start_date

date

The creation date of the return.

end_date

date

The creation date of the return.

start_value_date

date

The value date of the return.

end_value_date

date

The value date of the return.

direction

string

enum

The direction of the return. credit for credit transfer returns (SCT/SCT Inst), and debit for direct debit returns (SDD).

Allowed:

reconciliation_status

string

enum

The reconciliation status of the return.

Allowed:

file_id

string

The ID of the file including the return.

aggregation_reference

string

length ≤ 140

The aggregation reference of the return.

validation.type

string

enum

The type of payment validation.

Allowed:

validation.status

string

enum

The status of payment validation.

Allowed:

Responses

200List of filtered returns.

400Validation error.

500Internal server error.