The return request object

Also sometimes called a recall, a return request is the request to return an incoming payment or payment order. This feature is only available to financial institution customers.

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

This field has been deprecated in favor of connected_account_id.
related_payment
string
The ID of the payment to be returned, either an incoming payment or a payment order.
related_payment_type
string
The type of the payment corresponding to the return request. It can be an incoming payment or 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.
status
string
The lifecycle stage of this return request. It will be updated as the return request is processed.
status_details
string
The details of the status of this return request.
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 request.
updated_at
datetime
The UTC timestamp of the last update of this return request.

Below is an example of a return_request:

{
  "id": "d87fce04-309c-4107-a209-b9865230b316",
  "object": "return_request",
  "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": "payment_order",
  "return_reason": "CUST",
  "status": "received",
  "status_details": "",
  "metadata": {},
  "bank_data": {},
  "created_at": "2022-01-03T15:12:20.644356Z",
  "updated_at": "2022-01-03T16:04:20.537346Z"
}