/v1/refunds
POST
/v1/refunds[checkout_api] propose a refund → pending (never posts; RF-2 owns ledger)
Security: gated; the registry declares no role list for this surface.
Header Parameters
Idempotency-Key*string
Client-supplied idempotency key. Required on every registry-idempotent door.
Length
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/refunds" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "payment": "string", "amount": 0 }'{ "id": "string", "object": "refund", "amount": 0, "currency": "string", "status": "string", "payment": "string", "created": 0}{ "request_id": "string", "error": { "type": "invalid_request", "message": "string", "param": "string", "errors": [ { "param": "string", "code": "string", "message": "string", "allowed": [ "string" ] } ], "next_step": { "type": "string", "path": "string", "method": "string" }, "code": "currency_unavailable" }}{ "request_id": "string", "error": { "type": "invalid_request", "message": "string", "param": "string", "errors": [ { "param": "string", "code": "string", "message": "string", "allowed": [ "string" ] } ], "next_step": { "type": "string", "path": "string", "method": "string" }, "code": "invalid_api_key" }}{ "request_id": "string", "error": { "type": "invalid_request", "message": "string", "param": "string", "errors": [ { "param": "string", "code": "string", "message": "string", "allowed": [ "string" ] } ], "next_step": { "type": "string", "path": "string", "method": "string" }, "code": "exceeds_refundable" }}{ "request_id": "string", "error": { "type": "invalid_request", "message": "string", "param": "string", "errors": [ { "param": "string", "code": "string", "message": "string", "allowed": [ "string" ] } ], "next_step": { "type": "string", "path": "string", "method": "string" }, "code": "origin_not_allowed" }}{ "request_id": "string", "error": { "type": "invalid_request", "message": "string", "param": "string", "errors": [ { "param": "string", "code": "string", "message": "string", "allowed": [ "string" ] } ], "next_step": { "type": "string", "path": "string", "method": "string" }, "code": "not_found" }}{ "request_id": "string", "error": { "type": "invalid_request", "message": "string", "param": "string", "errors": [ { "param": "string", "code": "string", "message": "string", "allowed": [ "string" ] } ], "next_step": { "type": "string", "path": "string", "method": "string" }, "code": "idempotency_conflict" }}