Refunds

Create a full or partial refund

Live XRPay refunds are non-custodial and enter requires_action until the merchant approves and signs them.

post/api/v1/refunds

Request

  • Base URL: https://api.xrpay.it
  • URL: https://api.xrpay.it/api/v1/refunds
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Stable key for one logical operation. Reusing a key with different parameters returns HTTP 409.

Request body

payment_intent_idstring required
amount_minorinteger

Omit to refund the remaining refundable amount.

reasonstring
external_refund_idstring

Response

Idempotent replay

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.