What are Statuses and Enums?
Statuses and enums are standardized values used throughout the Revolv3 API. They provide consistent, predictable values that make integration easier. Why they matter:- Consistency: Same values mean the same thing across all endpoints
- Predictability: You know what to expect
- Integration: Easier to build logic around known values
Transaction Statuses
Transaction statuses indicate where a payment is in its lifecycle:| Status | What It Means | When You’ll See It |
|---|---|---|
AUTHORIZED | Funds are authorized (held) but not yet captured | After authorization, before capture |
CAPTURED | Authorized funds have been captured (charged) | After capturing an authorization |
SETTLED | Funds have settled with your merchant bank | A few days after capture |
REFUNDED | Full or partial refund has been issued | After processing a refund |
VOIDED | Authorization was voided before capture | After voiding an authorization |
DECLINED | Processor declined the transaction | When payment fails |
Subscription Status Types
| Status | What It Means |
|---|---|
current | Subscription is active and billing normally |
Refund Statuses
Refund statuses track where a refund is in the process:| Status | What It Means | When You’ll See It |
|---|---|---|
PENDING | Refund requested and waiting to process | Immediately after requesting refund |
PROCESSING | Refund is being executed by the processor | While processor is processing |
COMPLETED | Refund has settled back to customer | After refund completes (may take days) |
FAILED | Refund failed or was rejected | If refund cannot be processed |
Webhook Delivery Status
Webhook delivery statuses indicate whether Revolv3 successfully delivered a webhook to your endpoint:| Status | What It Means | When You’ll See It |
|---|---|---|
PENDING | Webhook is queued for delivery | Immediately after event occurs |
DELIVERED | Webhook delivered successfully (your endpoint returned 2xx) | After your endpoint responds with success |
FAILED | Delivery failed (non-2xx response or network error) | If your endpoint errors or is unreachable |
RETRYING | System will retry delivery | After a failed delivery, before retry |
Payment Method Types
| Type | What It Is |
|---|---|
CreditCard | Credit or debit card |
Payment Processors
Available processors in Revolv3:- WorldPay
- Adyen
- Nuvei
- TSYS
- JPMorgan
- Paymentlync
- BridgePay
Order Processing Channels
| Channel | When to Use |
|---|---|
ECOMMERCE | Online transactions (default) |
MOTO | Mail Order / Telephone Order transactions |
Currency Codes
Use ISO 4217 3-letter currency codes:USD- US DollarEUR- EuroGBP- British PoundCAD- Canadian Dollar- And other ISO 4217 codes
Billing Interval Types
| Type | What It Means |
|---|---|
Days | Billing occurs every N days |
Weeks | Billing occurs every N weeks |
Months | Billing occurs every N months |
Years | Billing occurs every N years |
Address Types
| Type | What It’s For |
|---|---|
BILLING | Address associated with payment method |
SHIPPING | Address for shipping/delivery |
Subscription Cancel Types
| Type | What It Means |
|---|---|
immediate | Cancel right away, stop billing immediately |
endOfCycle | Finish current billing period, then cancel |
Value Types
Used in line items and billing plans:| Type | What It Means |
|---|---|
Standard | Regular charge amount |
Discount | Fixed dollar discount |
DiscountPercentage | Percentage discount |
FinalDiscount | Discount applied to final total |
PriceOverride | Override standard price |
Example Usage
Transaction Status in Response
Subscription Status
Refund Status
Next Steps
- Invoice Status — Detailed guide to invoice statuses
- Subscriptions — See subscription statuses in action
- Refunds — Understand refund statuses