Simulate Incoming Instant Payment Return Request - Lead

curl --request POST \ --url https://api.sandbox.lead.bank/v1/simulate/instant_payments/{instant_payment_id}/incoming_return_request \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: <idempotency-key>' \ --data ' { "reason": "duplication", "additional_information": "<string>" } '

{ "code": "<string>", "title": "<string>", "detail": "<string>", "status": "<string>", "invalid_parameters": [ { "parameter": "transaction_type", "reason": "<string>" } ], "instance": "<string>" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

required

Idempotency key

Maximum string length: 255

Path Parameters

instant_payment_id

string

required

ID of the instant payment object you want to request a return for.

Pattern: ^instant_payment_\w+$

Body

application/json

reason

enum<string>

required

The reason for the return request.

Available options:

creditor_account_number_invalid,

wrong_amount,

customer_requested,

duplication,

fraud_suspected,

narrative,

service_not_rendered,

technical_problem,

undue_payment

Example:

"duplication"

additional_information

string

Accompanying free text explanation for the reason.

Maximum string length: 140

Response

Intentionally empty - instant payment record will be updated with return request details asynchronously.