Skip to main content

The Payment Intent object

The PaymentIntent object represents a single payment your customer makes toward your account, where the payment_type field identifies the method behind it, such as bank_transfer, card, installment, or cash. It appears when you create a payment, as the payment_resource of a Checkout Session once your customer pays, and in payment webhook events. Its status field tracks the payment through created, in_progress, succeeded, failed, pending, requires_action, expired, and rejected.
Payment Intent Object

The Recipient Account object and the Sender Account object (within the Payment Intent object)

These objects describe the bank accounts on each side of the payment, returned in the recipient_account field for the account that receives the funds and the sender_account field for the customer’s account that pays. They apply only when payment_type is bank_transfer; for other payment types, both fields are null.

The Business Profile object (within the Payment Intent object)

This object describes the business that receives the payment when you collect it on behalf of a sub-merchant, returned in the business_profile field.