Refund payments collected by the operator when a subscription is cancelled or an item is returned. Issue full or partial refunds, and check the remaining refundable amount at any time.
No amount is needed for a full refund. Once it is refunded in full, this payment cannot be refunded again.
A partial refund requires an amount. Further refunds can be issued later.
Check the remaining refundable amount; 0 means the payment has been fully refunded.
Who can request a refundOnly the service provider that created the original payment can request a refund.
Result notificationsSpecify a notification URL to receive notifications when a refund is complete, denied, or applied to the bill.
Carrier Billing Refund: How it works
- Choose a typeThe service provider requests a total (full) or partial refund for a payment.
- ProcessThe operator processes the refund, with status processing, succeeded, or denied.
- QueryCheck refund records and how much of this payment can still be refunded.
Carrier Billing Refund: API spec
POST /payments/{paymentId}/refunds to refund; GET …/refunds to check records; GET …/refunds/remaining-amount to check the remaining amounttype (total or partial), amount for a partial refund, reason, referenceCode| Response fields | Meaning | Example |
|---|---|---|
| refundId | Refund ID | AK234rfweSBuWGFUEWFGWEVWRV |
| refundStatus | processing, denied, succeeded | succeeded |
| type | total or partial | partial |
| amount (remaining-amount) | Remaining refundable amount; 0 means fully refunded | 50 |
Responses for three scenarios (excerpts)
totalFull refund; no amount neededsucceededRefund completepartialPartial refund100Amount of this refundsucceededRefund complete50Remaining refundable amountTWDCurrencySpec source: CAMARA CarrierBillingCheckOut r3.2 (Carrier Billing Refund v0.3.0)