Return request object

Also sometimes called recalls, return requests are requests to return incoming payments received or payment orders sent. This feature is only available to financial institution customers.

Attribute Description
id
string
The the return request ID.
object
string
Always return_request.
connected_account_id
string
The ID of the connected account used to send or receive the return request.
type
string
The payment scheme or network. Only sepa and sepa_instant are supported.
related_payment_type
string
The type of the payment linked to the return request, either a payment_orderor incoming_payment.
related_payment_id
string
The ID of the payment to be returned.
return_reason
string
The return reason. Authorised reasons depend on the payment scheme. For SEPA, refer to SEPA reason codes.
status
string
The return request status. It is be updated as the return request is processed.
status_details
string
The return request status details.
metadata
object
Additional data in JSON key:value format. See Metadata.
bank_data
object
Bank data in JSON key:value format.
created_at
datetime
The return request creation UTC timestamp.

Below is an example of a return request:

{
   "id": "d87fce04-309c-4107-a209-b9865230b316",
   "object": "return_request",
   "connected_account_id": "050b18a2-fe5a-47c5-8692-50cf6663c259",
   "type": "sepa",
   "related_payment_id": "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"
}