Accept return request

post https://sandbox.numeral.io/v1/return_requests/{id}/accept

Accept a return request for an incoming payment previously received. Accepting a return request creates a return. See Create a return.

Responses

Response body

object

return

object

required

string

required

The UUID of the return.

object

string

required

Label used to identify this kind of object

return

type

string

required

The payment scheme or network. Only sepa and sepa_instant are supported for now.

sepa sepa_instant

direction

string

required

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

credit debit

return_type

string

required

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

return refund reversal

connected_account_id

string

required

The ID of the connected account.

related_payment_id

string

required

The ID of the payment being returned, either an incoming payment or a payment order.

related_payment_type

string

required

The type of the payment corresponding to the return. It can be an incoming payment or a payment orders.

payment_order incoming_payment

return_reason

string

required

The reason for returning the payment. Authorised reasons depend on the payment scheme. For SEPA, refer to SEPA reason codes.

status

string

required

The lifecycle stage of this return. It will be updated as the return is processed. See return's lifecycle.

received pending-approval approved canceled failed processing sent executed rejected

status_details

string

required

The details of the status of this return.

metadata

object

required

Additional client data in JSON format. See Metadata.

Has additional fields

bank_data

object

required

Bank data, such as message and transaction IDs, in JSON format.

value_date

date

required

The value date of the return.

returned_amount

int64

required

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

required

The currency of the return. Only EUR is supported for now.

EUR

receiving_account_number

string

required

The account receiving the return.

reconciliation_status

string

required

The reconciliation status of the return, which is either unreconciled, reconciled, or partially_reconciled.

unreconciled partially_reconciled reconciled

reconciled_amount

int64

required

The amount that is already reconciled.
It is the sum of the amount of the reconciliations related to this return.

created_at

date-time

required

The UTC timestamp of the creation of this return.

return_request

object

required

string

required

The UUID of the return request.

object

string

required

Label used to identify this kind of object

return_request

type

string

required

The payment scheme or network. Only sepa and sepa_instant are supported for now.

sepa sepa_instant

connected_account_id

string

required

The ID of the connected account.

related_payment_id

string

required

The ID of the payment being returned, either an incoming payment or a payment order.

related_payment_type

string

required

The type of the payment corresponding to the return request. It can be an incoming payment or a payment order.

payment_order incoming_payment

return_reason

string

required

The reason for asking the payment's return. Authorised reasons depend on the payment scheme. For SEPA, refer to SEPA reason codes.

status

string

required

The lifecycle stage of this return request. It will be updated as the return request is processed. See return request's lifecycle.

received accepted denied rejected pending failed sent

status_details

string

required

The details of the status of this return request.

metadata

object

required

Additional client data in JSON format. See Metadata.

Has additional fields

bank_data

object

required

Bank data, such as message and transaction IDs, in JSON format.

created_at

date-time

required

The UTC timestamp of the creation of this return request.

404

The specified resource was not found.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandbox.numeral.io/v1/return_requests/id/accept \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully accepted return request, and the associated return which has been created.

400Validation error.

409Conflict.

500Internal server error.