Refunds
Create refund
Refund a payment, in full or in part.
POST/v1/refunds
Parameters
| Parameter | Description |
|---|---|
| amount_centsinteger | nulloptional | No description in the spec. |
| one_shot_payment_idstring | nulloptional | No description in the spec. |
| payment_idstring | nulloptional | No description in the spec. |
| reasonstring | nulloptional | At most 500 characters. |
| subscription_idstring | nulloptional | No description in the spec. |
Returns
Returns a RefundResponse object.
Errors
| Status | Cause |
|---|---|
| 401 | Missing or invalid API key. |
| 403 | Key is missing the refunds:write scope. |
| 422 | Validation Error |
| 429 | Rate limited. Back off and retry. |
Other refunds operations
- List refunds GET /v1/refunds
- Get refund GET /v1/refunds/{refund_id}
BillKit