Overview

A payment intent represents what you or your customer is selling. It contains the amount and optional line items and tax details. Collect the payment through a hosted checkout link or over the phone.

​

Lifecycle

An intent starts as open, becomes processing during a payment attempt, and becomes completed when payment succeeds. Funds become available after settlement. A declined attempt can be retried while the intent remains open. After five issuer declines, the intent becomes declined. Cancel it and it becomes canceled. Set expiresAt and it becomes expired once that time passes with no successful payment. To change the amount, line items, or other details, update the intent while it is open. A payer who already has the checkout open must review the new terms before paying.

​

Card payments

Each payment attempt creates a card payment. One intent can have several attempts, but only one successful payment. Its cardPayment relationship identifies that successful payment.

​

The checkout link

Share the link in payUrl with the payer. Natural’s hosted checkout takes the card and processes the payment. Treat the link as private. Read more: Create a payment intent and get paid by link.

​

Line items and tax

Specify the amount in US cents. You can include item descriptions, quantities, prices, and tax. Line totals must add up to the payment intent amount. See Create payment intent for the available fields.

​

Collecting for a customer

Invite your customer through Connect and have them complete Accept enrollment. Once approved and authorized, pass their party ID as customerPartyId on calls made on their behalf. Read more: Accept payments.