Sign in

v1

latestOpenAPI 3.1.02026-08-042453938.9 KB
Charges

Refund a charge

Refund a charge back to the customer. Only escrow-based charges can be refunded, and only before the escrow has been settled or expired.

Refund reasons:

  • customer_request - Customer requested a refund
  • merchant_error - Charge was made in error
  • fraud_reversal - Fraudulent transaction reversal

The refund is processed on-chain and the funds are returned to the customer's account.

post/v1/charges/{id}/refund

Path parameters

idstring required

Charge ID

Request body

reason'customer_request' | 'merchant_error' | 'fraud_reversal' required

Reason for the refund

notestring

Optional internal note about the refund

Response

Charge refunded successfully

idstring required

Charge ID

customerIdstring required
usageIdstring
amountUsdcstring required

USDC amount with up to 6 decimal places

amountTokenstring
status'REFUNDED' | 'REFUND_PENDING' required

REFUNDED when on-chain confirmation succeeded, REFUND_PENDING when tx submitted but confirmation failed

refundReason'customer_request' | 'merchant_error' | 'fraud_reversal' required
refundNotestring nullable
refundTxHashstring required

Transaction hash for the refund

refundedAtstring date-time nullable

Set when refund is confirmed on-chain; null when REFUND_PENDING

createdAtstring date-time