Sandbox

Simulate a test payment outcome

Available only with test credentials. No external payment or ledger transaction is submitted. A successful local-currency simulation credits the connected business's isolated test payout balance exactly once; the PaymentIntent response describes that credit in test_balance_credit. Crypto-settlement simulations do not create a local-currency payout balance.

post/api/v1/payment-intents/{id}/simulate

Request

  • Base URL: https://api.xrpay.it
  • URL: https://api.xrpay.it/api/v1/payment-intents/{id}/simulate
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

outcome'succeeded' | 'failed' | 'expired' required

Response

Simulated

object'payment_intent' required
idstring required
status'requires_customer_action' | 'processing' | 'succeeded' | 'failed' | 'expired' | 'canceled' required
amount_minorinteger required
currencystring required
external_order_idstring required
order_numberstring nullable
customer_emailstring nullable
location_idstring nullable
terminal_idstring nullable
operator_idstring nullable
integration_typestring
metadataobject nullable
line_itemsobject[] nullable
payment_method_typesstring[] nullable
payment_methodstring nullable
collection_mode'hosted' | 'direct'
refunded_amount_minorinteger
failure_codestring nullable
livemodeboolean required
sandbox_simulatedboolean required
api_versionstring
created_atstring date-time required
updated_atstring date-time
expires_atstring date-time required
canceled_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.