Guides & Tutorials
Refunds API
Create and inspect idempotent refunds for payments.
Consumer services can create refunds for supported payment IDs. The public refund request identifies the payment directly; APICenter keeps provider-specific refund fields inside the payment runtime.
For a Node.js backend, use api.payments.refunds.create(...) from the APICenter SDK. The REST example below is for other runtimes.
Issue Refund
- Endpoint:
POST /api/v1/payments/refunds - Required Scope:
payments:refunds:writeor a broader payment write scope - Required Header:
Idempotency-Key
curl -X POST https://api.apicenter.itsandbox.site/api/v1/payments/refunds \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Idempotency-Key: ref-idem-4412" \
-H "Content-Type: application/json" \
-d '{
"paymentId": "pi_v1_example01",
"amount": {
"amountMinor": 49900,
"currency": "PHP"
},
"reason": "customer_requested"
}'Look up the result with GET /api/v1/payments/refunds/{refundId} and the payments:refunds:read scope.