Create or update checkout session

put

https://sandbox.pingpayments.com/checkout/api/orders/{order_id}/checkout

While there is an ongoing non-terminated session this endpoint can be used to update the currently ongoing session.
A session is non-terminated while in state CREATED, PENDING or PAYING, but the session can only be updated while in state CREATED or PENDING.
If there is no ongoing session this will create a new session.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

order_id

uuid

required

Body Params

CreateOrUpdateSessionRequest

abort_url

string

required

Where to send the user after session was aborted

amount

integer

required

Amount in minor units (e.g. cents)

back_url

string | null

Where to send the user if pressing back button, if not provided a back button will not be displayed.

client_name

string | null

Name of the client, will be displayed on some navigation buttons

designated_merchant_id

uuid

required

designated_merchant_logo_url

string | null

iframed

boolean

Defaults to false

Whether the session will be displayed in an iframe, some payment methods won't be avalible when iframed

language

string

enum

Allowed:

metadata

object

order_lines

array of objects

required

length ≥ 1

List of order lines to be displayed to the payer

order_lines*

amount

integer

required

Amount in minor units (e.g. cents)

description

string

image_url

uri

item_url

uri

merchant_id

uuid

required

metadata

object

name

string

required

product_category

string

enum

required

Allowed:

quantity

integer

required

≥ 1

vat_rate

integer

required

0 to 100

payer

object

payer_can_update_details

boolean

Defaults to true

Whether the payer can update their details

payment_text

string

length ≤ 50

Text to be displayed to the payer, will only be used for methods where setting a custom text is supported.

success_url

string

required

Where to send the user after session was successful

Headers

x-api-secret

string

required

API secret

tenant_id

uuid

required

Tenant ID header

Response

Callback

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200CreateOrUpdateSessionResponse