The return object

A return is the return of an incoming payment or payment order. This feature is only available to financial institution customers.

AttributeDescription
id
string
The UUID of the return.
object
string
The object, here return.
connected_account_id
string
The ID of the connected account used to trigger or receive the return.
connected_account (deprecated)
string
The ID of the connected account used to trigger or receive the return.

This field has been deprecated in favor of connected_account_id.
related_payment
string
The ID of the payment returned, either an incoming payment or a payment order.
related_payment_type
string
The type of the payment corresponding to the return. It can be an incoming payment or a payment order.
return_reason
string
The reason for returning the payment. Authorised reasons depend on the payment scheme. For SEPA, refer to SEPA return reasons.
value_date
date
The value date of the return.
returned_amount
integer
The absolute value of the return in the specified currency's smallest unit.

For euro payments, the smallest unit is cents. €20 is represented as 2000.
currency
string
The currency of the return. Only EUR is supported for now.
receiving_account_number
string
The account receiving the return.
status
string
The lifecycle stage of this return. It will be updated as the return is processed.
status_details
string
The details of the status of this return.
reconciliation_status
string
The reconciliation status of the payment order, which is either unreconciled, reconciled or partially_reconciled.
reconciled_amount
integer
The amount that is already reconciled.

It is the sum of the amount of the reconciliations related to this payment order.
reconciliation_override
boolean
If true, the payment order has been manually reconciled although the payment's reconciled_amount does not match the payment's amount.
metadata
object
Additional data in JSON key:value format. See Metadata.
bank_data
object
Bank data, such as message and transaction IDs, in JSON key:value format.
created_at
datetime
The UTC timestamp of the creation of this return.
created_at
datetime
The UTC timestamp of the last update of this return.

Below is an example of a return:

{
  "id": "a117fdf3-0f5d-46f1-abe8-57b8e78f6226",
  "object": "return",
  "connected_account": "050b18a2-fe5a-47c5-8692-50cf6663c259",
  "connected_account_id": "050b18a2-fe5a-47c5-8692-50cf6663c259",
  "related_payment": "9c95044f-73bb-425e-bf66-74cb3a03647d",
  "related_payment_type": "incoming_payment",
  "return_reason": "AC04",
  "value_date": "2022-01-03",
  "returned_amount": 2000,
  "currency": "EUR",
  "receiving_account_number": "FR6010096000306973462461G47",
  "status": "executed",
  "status_details": "",
  "reconciliation_status": "reconciled",
  "reconciled_amount": 2000,
  "reconciliation_override": false,
  "metadata": {},
  "bank_data": {
    "file_id": "9ac03610-02b6-421c-958a-de17088b1901",
    "message_id": "7d0665620d",
    "transaction_id": "dfe7eb0b9c",
    "end_to_end_id": "1061b6c83f"
  },
  "created_at": "2022-01-03T15:12:20.644356Z",
  "updated_at": "2022-01-03T16:04:20.537346Z"
}