Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Simulation

Simulate Incoming Instant Payment Return Request

Simulate an incoming instant payment return request.

post/v1/simulate/instant_payments/{instant_payment_id}/incoming_return_request

Path parameters

instant_payment_idstring required

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

Headers

Idempotency-Keystring required

Idempotency key

Request body

reason'creditor_account_number_invalid' | 'wrong_amount' | 'customer_requested' | 'duplication' | 'fraud_suspected' | 'narrative' | 'service_not_rendered' | 'technical_problem' | 'undue_payment' required

The reason for initiating a return request.

  • creditor_account_number_invalid - Invalid creditor account number
  • wrong_amount - Wrong amount
  • customer_requested - Requested by customer
  • duplication - Duplicate payment
  • fraud_suspected - Fraud suspected
  • narrative - Narrative reason, additional_information required
  • service_not_rendered - Service not rendered
  • technical_problem - Technical problem
  • undue_payment - Unduly paid
additional_informationstring

Accompanying free text explanation for the reason.

Example request

{
  "reason": "duplication"
}

Response

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