Checking access…

Skip to main content
Version: v2

Payment Lifecycle

A payment moves through a series of merchant-visible statuses from creation to a terminal outcome. This page documents the statuses GET /v2/payments/{id} can actually return, what each means for your integration, and how to track a payment to completion.

Integration Details
  • Endpoint: GET /v2/payments/{paymentId} β€” poll or check status after any payment operation
  • Scope: merchant
  • Use: Tracking a payment from creation to a terminal state, and deciding when to retry, capture, or cancel

Merchant-Facing Statuses​

StatusTerminal?Meaning
PENDINGNoQueued or in flight β€” no vendor response yet
AUTH_REQUIREDNoCard requires a 3DS challenge before authorization can proceed
CONFIRMATION_REQUIREDNo3DS challenge complete; waiting for the confirm call (handled automatically by the CCG Widget)
CONFIRMATION_INITIALIZEDNoConfirm call received; processor finalizing the authorization
AUTHORIZEDNoPre-auth hold placed; funds held but not captured. Expires after 7 days if not captured.
ACCEPTEDNoACH payment accepted by the processor; settlement pending
CAPTURE_INITIALIZEDNoCapture in progress (PRE-AUTH flow only β€” a SALE flow collapses this to PENDING)
CANCEL_INITIALIZEDNoCancellation in progress (PRE-AUTH flow only β€” a SALE flow collapses this to PENDING)
COMPLETEDβœ…Payment fully processed and settled
FAILEDβœ…Payment permanently failed β€” see Payment Error Codes
CANCELEDβœ…Payment cancelled by the merchant or the system (including a split-tender sibling rollback)
SALE vs. PRE-AUTH

For SALE transactions (authorizeCard=false), the capture/cancel steps happen automatically behind the scenes β€” CAPTURE_INITIALIZED/CANCEL_INITIALIZED never surface; you'll only see PENDING until the payment reaches a terminal state. For PRE-AUTH transactions (authorizeCard=true), these intermediate states are surfaced so you can track the capture/cancel lifecycle explicitly.

Standard Flow Patterns​

FlowStatus Path
Card β€” SalePENDING β†’ COMPLETED / FAILED
Card β€” Pre-Auth + CapturePENDING β†’ AUTHORIZED β†’ CAPTURE_INITIALIZED β†’ COMPLETED / FAILED
Card β€” Pre-Auth + CancelPENDING β†’ AUTHORIZED β†’ CANCEL_INITIALIZED β†’ CANCELED
Card β€” 3DS challengePENDING β†’ AUTH_REQUIRED β†’ CONFIRMATION_REQUIRED β†’ CONFIRMATION_INITIALIZED β†’ COMPLETED / FAILED
Bank Account (ACH)PENDING β†’ ACCEPTED β†’ COMPLETED / FAILED

Status Handling​

Poll GET /v2/payments/{paymentId} or subscribe to payment webhooks β€” webhooks are the recommended primary mechanism; use polling as a fallback. Treat COMPLETED, FAILED, and CANCELED as terminal β€” stop polling once one of these is reached. All other statuses are transient and may still transition.

Cancellation Eligibility​

StatusCancel Allowed?
PENDINGβœ… Before processing starts
AUTHORIZEDβœ… Pre-auth void
ACCEPTEDβœ… ACH reversal
COMPLETED❌ Use a refund instead
FAILED / CANCELED❌ Already terminal

Capture Eligibility​

Only a payment in AUTHORIZED status can be captured (full or partial); all other statuses reject a capture request.

Retry Handling​

A FAILED payment can be retried using the same merchantTransactionId; retry limits and idempotency behavior are documented in Retry Mechanisms, including session-mode-specific flows and webhook payloads.