Create Payment Intent

This endpoint is used to create a payment intent for e-commerce transactions. It requires the merchant integration to be set up and will return a payment intent object upon successful creation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length ≤ 255

External reference for the payment

integer
required
1 to 9999999

Amount in minor units (pence for GBP)

const
enum
required

Currency code

Allowed:
metadata
object

Additional metadata for the payment

uuid
required

The payment initiator ID (integration ID) to use for this payment

const
enum
required

Whether or not the payment is an 'off session' payment. An off session payment is when the customer Payment Method is charged separately from collecting their Payment Method (e.g. card details).

Allowed:
shippingAddress
object

Address information for shipping or billing

billingAddress
object

Address information for shipping or billing

lineItems
array | null

Array of line items, each being either airline, car rental, lodging, or product data

lineItems
string
required

The payment method ID to charge for this payment.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json