Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Returns

List returns

List and filter returns.

get/returns

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

type'sepa' | 'sepa_instant'

The type of the related payment.

return_type'return' | 'refund' | 'reversal'

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

status'pending' | 'sent' | 'processing' | 'executed' | 'received' | 'rejected'

The status of the return.

related_payment_idstring uuid

The ID of the payment related to the return.

related_payment_typestring

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

start_datestring date

The creation date of the return.

end_datestring date

The creation date of the return.

start_value_datestring date

The value date of the return.

end_value_datestring date

The value date of the return.

direction'credit' | 'debit'

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

reconciliation_status'reconciled' | 'partially_reconciled' | 'unreconciled' | 'excluded'

The reconciliation status of the return.

file_idstring

The ID of the file including the return.

aggregation_referencestring

The aggregation reference of the return.

validation.type'internal_account_is_active' | 'direct_debit_mandate_is_active' | 'liquidity_screening' | 'sanctions_screening' | 'risk_screening' | 'limits_screening' | 'mambu_authorization'

The type of payment validation.

validation.status'queued' | 'in_progress' | 'successful' | 'failed' | 'pending_investigation' | 'pending_retry' | 'canceled' | 'technical_error'

The status of payment validation.

Response

List of filtered returns.

Example response

{
  "records": [
    {
      "object": "return",
      "metadata": {
        "property_a": true,
        "property_b": "false"
      },
      "originating_account_bank_address": {
        "line_1": "1, place de la Concorde",
        "building_number": "1",
        "street_name": "place de la Concorde",
        "postal_code": "75008",
        "city": "Paris",
        "country": "FR",
        "department": "Marketing",
        "sub_department": "Content team",
        "building_name": "Bat. 4",
        "floor": "3",
        "postal_box": "67b",
        "room": "47",
        "city_location_name": "Confluences",
        "district_name": "District 9"
      },
      "receiving_account_bank_address": {
        "line_1": "1, place de la Concorde",
        "building_number": "1",
        "street_name": "place de la Concorde",
        "postal_code": "75008",
        "city": "Paris",
        "country": "FR",
        "department": "Marketing",
        "sub_department": "Content team",
        "building_name": "Bat. 4",
        "floor": "3",
        "postal_box": "67b",
        "room": "47",
        "city_location_name": "Confluences",
        "district_name": "District 9"
      }
    }
  ]
}