Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Simulation

Simulate Incoming Instant Payment Return

Simulate an incoming instant payment return.

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

Path parameters

instant_payment_idstring required

ID of the instant payment object you want to return.

Headers

Idempotency-Keystring required

Idempotency key

Request body

amountinteger required

The amount of the instant payment in cents.

reason'honor_return_request' | 'wrong_amount' | 'duplication' | 'initiating_party_unrecognized' | 'fraud_suspected' | 'undue_payment' | 'narrative' | 'customer_requested' required

The reason for initiating an return.

  • honor_return_request - Honoring a return request
  • wrong_amount - Wrong amount
  • duplication - Duplicate payment
  • initiating_party_unrecognized - Unknown sender
  • fraud_suspected - Fraud suspected
  • undue_payment - Unduly paid
  • narrative - Narrative reason, additional_information required
  • customer_requested - Requested by customer
additional_informationstring

Accompanying free text explanation for the reason.

Example request

{
  "amount": 5000,
  "reason": "duplication"
}

Response

Intentionally empty - incoming instant payment return will be created asynchronously.