Gift Cards · Reference
Gift Cards error codes
The Gift Cards error envelope and the error types a purchase can return.
Error envelope
Except where noted, every error returns HTTP 422 Unprocessable Entity with this body:
Error response
{
"error_type": "PAYEE_SERVICE_UNAVAILABLE",
"error_message": "Payee service is not available at this time, retry in 5 minutes"
}| Field | Description |
|---|---|
error_type |
Machine-readable error code |
error_message |
Human-readable message (localized) |
A missing or invalid Bearer token returns 401 with the same envelope.
Error types
| Error type | Cause | Example message |
|---|---|---|
PAYEE_ID_INVALID |
The payee_id does not exist or has no payment provider. |
Payee ID Invalid |
AMOUNT_INVALID |
The amount is outside the gift card’s allowed range. | Amount is invalid |
AMOUNT_INSUFFICIENT |
Insufficient prepaid balance (Prepay clients). | The Payee minimum amount was not met |
DUPLICATED_PAYMENT_ERROR |
The idempotency_key was already used. |
This payment is already paid, retry in 24 hours |
PAYEE_TIMEOUT |
The provider timed out. An automatic reversal is queued. See Timeouts and reversals. | Not documented |
PAYEE_SERVICE_UNAVAILABLE |
Provider error (fallback). Also returned when the product is not available. | Payee service is not available at this time, retry in 5 minutes |