Create a new checkout session

post

https://api.copperx.dev/api/v1/checkout/sessions

Checkout Sessions allow you to create one-off payments in a fixed or variable amount or start subscriptions for your customers. You should create a new Checkout Session for each payment attempt. Once you create a Checkout Session on your server, you need to redirect user to the Checkout Session URL to complete the payment flow.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

mode

string

enum

The mode of the Checkout Session.

Allowed:

clientReferenceId

string

Unique ID string used to identify the session in your backend. This can be your payment ID, cart ID, or similar used to link this Checkout Session with your internal system.

nameCollection

boolean

Whether to collect the customer's name. Default: false

emailCollection

boolean

Whether to collect the customer's email address. Default: false

phoneNumberCollection

boolean

Whether to collect the customer's phone number Default: false

shippingAddressCollection

boolean

Whether to collect the customer's shipping address. Default: false

billingAddressCollection

boolean

Whether to collect the customer's billing address. Default: false

expiresAt

date-time

The time at which the session will expire. Default: 1 Hour

customFields

object

afterCompletion

string

enum

The action to take after the payment is completed. You can choose to redirect user to your application or use the default payment confirmation page provided by Copperx

Allowed:

afterCompletionConfirmMsg

string

The message to show after successful payment. Only applicable when afterCompletion is set to hosted_confirmation

customerId

string

The ID of the customer if you want to associate the session with a customer

metadata

object

A set of key-value pairs that you can attach to a Checkout Session object

submitType

string

enum

Defaults to pay

The type of submit button to display on the Checkout page

Allowed:

customerCreation

string

enum

Whether to create a customer for the session. If required, a customer will be created for subsequent payments

Allowed:

customerUpdate

object

The customer update settings to use for this checkout to update existing customer details

allowPromotionCodes

boolean

Enables user redeemable promotion codes.

successUrl

string

required

The URL to redirect the customer to after payment is completed. Only applicable when afterCompletion is set to redirect

cancelUrl

string

The URL to redirect the customer to if they decide to cancel payment

customerData

object

The checkout sessions's customer data to be prefilled

lineItems

object

required

The line items to be used in checkout session. Line items are the individual prices that the customer will be charged for

paymentSetting

object

The payment method settings to use for this checkout's payment

taxRateIds

array of strings

taxRateIds

defaultPromotionCode

string

The default promotion code to auto apply to this checkout session, when checkout session is created.If promotion code is invalid or expired still checkout session is created without applying promotion code.You need to check whether promotion code applied or not at your end when get create checkout session response.

Responses

200

401

500