CX Pay API

Get Payment Intent

Check the status of a payment. Use as a fallback if your webhook didn't arrive.

GET/payment-intents/{paymentIntentId}

Retrieves a Payment Intent by ID. Use this to check if a payment succeeded — especially as a fallback when you haven't received a webhook.

When to use this: You created a checkout session, the customer completed payment, but your webhook hasn't arrived after 5 minutes. Poll this endpoint.

Path Parameters

ParameterTypeDescription
paymentIntentIdstringThe Payment Intent ID (pi_...). You got this from the checkout session response.

Response 200

{
  "id": "pi_01JQX...",
  "object": "payment_intent",
  "status": "succeeded",
  "amount": 5000,
  "currency": "USD",
  "metadata": { "order_id": "ORD-123" },
  "livemode": false,
  "created_at": "2026-04-07T18:30:00.000Z"
}

Status Values

StatusMeaningAction
succeededPayment captured. Money is yours.Fulfill the order
processingPayment submitted, waiting on networkCheck again in a minute
requires_payment_methodWaiting for customer to payCustomer hasn't completed checkout yet
requires_action3DS challenge in progressWe're handling it — wait
canceledPayment was canceledNo action needed
expiredPayment Intent expiredCreate a new checkout session
requires_captureAuth succeeded, awaiting captureCapture when ready (manual capture flow)

Errors

StatusMeaning
401Auth failed
404Payment Intent not found — check the ID
429Rate limited

Try It

GET/payment-intents/pi_01JQX...
test

On this page