Skip to main content
A payment intent (pmi_*) is what you or your customer is selling: its amount, line items and tax, collected by card through a checkout link, over the phone, or from a saved card. To learn more, see Get paid by link and Charge a saved card.

Example

GET /payment-intents/{paymentIntentId}
The object is everything inside data. The field names below are relative to it: attributes.amount is data.attributes.amount in the response.

Fields

string
required
Payment intent ID (pmi_*).
string
required
Resource type. Always paymentIntent.
object
required
The payment intent’s details.
object
required
Related resources, each by type and ID.

Statuses

Events

  • paymentIntent.completed: A payment intent was paid in full by a succeeded card payment.
  • paymentIntent.canceled: A payment intent was canceled: an open intent, or a hold you released.
  • paymentIntent.authorized: Early access (holds). The card issuer approved a hold. Capture the payment intent before captureBefore to charge the card, or cancel it to release the hold.

Errors

See the error codes these endpoints return.

Sandbox simulations