Sandbox

Simulate a test refund outcome

post/api/v1/refunds/{id}/simulate

Request

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

Path parameters

idstring required

Request body

outcome'completed' | 'failed' required

Response

Simulated

object'refund' required
idstring required
payment_intent_idstring required
status'pending' | 'requires_action' | 'processing' | 'completed' | 'failed' | 'canceled' required
amount_minorinteger required
currencystring required
type'full' | 'partial'
reasonstring nullable
external_refund_idstring nullable
next_actionobject nullable
livemodeboolean
sandbox_simulatedboolean
created_atstring date-time
updated_atstring date-time
completed_atstring date-time nullable
failed_atstring date-time nullable

Changes

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