Embedded Checkout

Submit a session payment. Activated PSP and all simulator sessions require the exact X-Browser-Token; unactivated PSP sessions temporarily retain the headerless migration path. Session amount, order, mode and return URLs are authoritative; request overrides are ignored. PSP 00307 may include next_action.type=three_ds_redirect. Do not retry unknown outcomes; verify status first.

post/api/v1/embedded/payment/pay

Request

Headers

x-browser-tokenstring

Request body

session_idstring required

Embedded checkout session identifier

payment_typestring

Payment type

order_idstring

Legacy field retained for parsing; session metadata order_id/orderId or session_id is authoritative.

currencystring

ISO currency code. Defaults to session currency.

languagestring

Language code. Defaults to session language.

modestring

Legacy field retained for parsing; the trusted session gateway mode is authoritative.

success_urlstring

Legacy field retained for parsing; the trusted session success URL is authoritative.

fail_urlstring

Legacy field retained for parsing; the trusted session fail URL is authoritative.

parent_originstring

Exact merchant parent origin for Embedded result delivery

is_3dboolean

Whether payment is 3D

card_numberstring required

Card number

card_holder_namestring required

Card holder name

expire_monthstring required

Expiration month

expire_yearstring required

Expiration year

cvcstring required

Card verification code

customerobject

Customer information. Defaults to session customer.

customer_basketobject[]

Basket information. Defaults to session basket.

submerchant_external_idstring

Submerchant external id

is_submerchant_paymentboolean

Whether payment should be routed as submerchant

campaign_namestring

Campaign name

billing_tax_officestring

Billing tax office

billing_tax_numberstring

Billing tax number

Response

Successful Response

unknown required

Changes

    • info

      added the new optional header request parameter x-browser-token

    • info

      added the new optional request property