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.
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.
Hide attributes
integer
required
Total amount in US cents.
string
required
Currency code. Always USD.
string | null
required
What the payment is for.
string | null
required
Hosted checkout URL while the intent is open or processing. Null when the intent is closed or no link is available.
string | null
required
Pass to natural.js in the browser to show the payment form. Available whenever payUrl is. Treat it like a password: send it only to the payer’s browser.
string
required
Payment collection status. A completed intent has a successful payment, but funds may not be settled yet. Early access (holds): authorized. One of: open, processing, authorized, completed, canceled, declined, expired. See Statuses.
string
Early access (holds). manual on a hold: the card is charged only when you capture it.
string | null
Early access (holds). RFC 3339 deadline to capture a hold. Null until the card issuer approves the hold. It stays set after the hold is captured, canceled or expires; only an authorized hold can be captured.
integer
Early access (holds). Cents a hold’s capture took: 0 until a capture succeeds, then the full amount.
string
required
Whether tax is added to or included in line amounts. One of: exclusive, inclusive.
integer
required
Tax in cents.
object[]
required
Line items in display order. Replaceable while the intent is open.
Hide lineItems
string
required
Line item ID (pli_*). Replacing the lines issues new IDs.
integer
required
Zero-based display order.
string | null
required
Your own reference for the line, such as a SKU.
string
required
What this line sells.
integer
required
Unit count.
integer
required
Per-unit amount in cents.
integer
required
Line total before tax, in cents. Equals totalAmount minus taxAmount.
integer
required
Line tax in cents.
integer
required
Line total in cents.
string | null
required
Your tax code for this line.
string | null
required
RFC 3339 timestamp after which no new payment attempt may start.
string | null
required
RFC 3339 timestamp when the intent was canceled.
string
required
RFC 3339 creation timestamp.
string
required
RFC 3339 update timestamp.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
The party being paid.
Hide customerParty
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
ID of the party being paid (pty_*).
object
required
The card payment the issuer approved. Null until one is approved.
Hide cardPayment
object | null
required
Related resource identifier.
Hide data
string
required
Resource type. Always cardPayment.
string
required
Card payment ID (cpy_*).
object
Early access (mandates). Card agreement (mdt_*) the intent was charged under. Only on an intent you created with mandateId.
Hide mandate
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always mandate.
string
required
Mandate ID (mdt_*).
object
required
Latest voice session for this intent. Null when no session has been created.
Hide voiceSession
object | null
required
Related resource identifier.
Hide data
string
required
Resource type. Always voiceSession.
string
required
Voice session ID (vos_*).
Statuses
Status
Meaning
Can become
open
Waiting for payment. The payer can pay at payUrl, and you can still update the intent.
processing, canceled, expired
processing
A card payment is in progress. If it fails, the intent goes back to open so the payer can try again. The fifth issuer decline makes it declined instead.
completed, authorized, open, declined
authorized
The issuer approved a hold, and the card isn’t charged until you capture the intent. It stays authorized while a capture is in progress.
completed, canceled, expired
completed
Paid. A card payment succeeded, though its funds may not be settled yet.
Final
canceled
You canceled the intent before it was paid, or released its hold.
Final
declined
The intent had its fifth issuer decline, or a charge or hold you created with mandateId failed.
Final
expired
An open intent passed its expiresAt, or a hold wasn’t captured before captureBefore. The card isn’t charged.
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.