Store APIsRefunds
Create refund
Issues a refund against an order. The order must be completed, have no open dispute, and fall within the 30-day refund window. Requires the REFUNDS_WRITE scope.
AuthorizationBearer <token>
Bearer token authentication. Pass the secret directly in the Authorization header. Token secrets start with sk_.
In: header
Path Parameters
storeId*string
Length
12 <= length <= 48orderId*string
Length
12 <= length <= 48Header Parameters
idempotency-key?string
Length
8 <= length <= 32Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/stores/stringstring/refunds/orders/stringstring" \ -H "Content-Type: application/json" \ -d '{}'{ "ok": true, "data": { "id": "rfd_3kx9p2vqwm5j8h0r1n4tzcbf", "amount": 2900, "status": "COMPLETED", "reason": "REQUESTED_BY_CUSTOMER", "createdAt": "2026-05-14T12:34:56.000Z", "updatedAt": "2026-05-14T12:35:10.000Z", "order": { "id": "ord_p2v8q1mzj0kxw5h7n4tr3bcf", "orderNumber": "cs_abcdef0123456789", "status": "REFUNDED", "amount": 2900, "currency": "USD", "customer": { "id": "cus_j8h0r1n4tzcbfp2v8q1mzwx5", "email": "buyer@example.com", "firstName": "Alex", "lastName": "Doe" } } }}