v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

PaymentIntent

Retrieves the collection of PaymentIntent resources.

get/payment_intents

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

PaymentIntent collection

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

Unique identifier for each payment intent

amountinteger

The amount intended to collected from the payment intent

amountCapturableinteger nullable

The amount that can be captured from the payment intent

amountReceivedinteger nullable

Amount that was collected by the payment intent

clientSecretstring

The client secret of the payment intent

confirmationMethodstring nullable

The method of confirmation used.

createdstring date-time nullable

The date and time the payment intent was created

currencystring

The currency used in the payment intent

customerIdstring nullable

The ID of the customer the payment intent belongs to

descriptionstring nullable

A description about the payment intent

invoiceIdstring nullable

The ID of the invoice that created this payment intent

paymentMethodIdstring nullable

The ID of the payment method used.

emailstring nullable

The email address that the receipt for the resulting payment will be sent to

shippingNamestring nullable

Recipient name

shippingPhonestring nullable

Recipient phone number

shippingAddressstring nullable

Shipping address for the payment intent

statusstring nullable

Status of the payment intent e.g. "requires_payment_method" e.g. "requires_confirmation" e.g. "succeeded"

Example response

[
  {
    "integration": "quickbooks"
  }
]