Aller au contenu principal

Refunds

Refund a payment partially or fully.

The Refund object

{
"id": "re_abc123",
"object": "refund",
"amount": 5000,
"currency": "xof",
"payment_intent": "pi_xyz789",
"status": "succeeded",
"reason": "requested_by_customer",
"created": 1708300800
}

Endpoints

MethodEndpointDescription
POST/v1/refundsCreate a refund
GET/v1/refunds/{id}Retrieve a refund
GET/v1/refundsList refunds

Create a Refund

POST /v1/refunds
ParameterTypeRequiredDescription
payment_intentstringPaymentIntent ID to refund
amountintegerAmount to refund (default: full amount)
reasonstringduplicate, fraudulent, or requested_by_customer
metadataobjectKey-value metadata