/proxy_sessions/handoff

POST

/proxy_sessions/handoff

curl --request POST \
  --url https://example.com/proxy_sessions/handoff \
  --header 'Content-Type: application/json' \
  --data '{ "amount_minor": 1, "buyer_reference": "example", "cart_snapshot": {}, "currency": "example", "expires_at": "example", "integration_mode": "elements", "metadata": {}, "payer_contact": { "email": "example", "phone": "example" }, "payer_destination_url": "example", "publishable_key": "example" }'

Creates a Proxy session and atomically marks it ready for hosted payer handoff.

Parameters

Header Parameters

idempotency-key

string

<= 255 characters

Request Body^required

Media typeapplication/json

object

amount_minor

required

integer

<= 2147483647

buyer_reference

required

string

>= 1 characters

cart_snapshot

required

object

key

additional properties

any

currency

required

string

/^[A-Za-z]{3}$/

expires_at

string

integration_mode

string

Allowed values: elements

metadata

object

key

additional properties

any

payer_contact

object

email

string

phone

string

>= 1 characters

payer_destination_url

string

>= 1 characters <= 2048 characters

publishable_key

required

string

>= 1 characters

Responses

201

Default Response

Media typeapplication/json

object

expires_at

required

string

id

required

string

/^psess_/

integration_mode

required

string

Allowed values: elements

status

required

string

Allowed values: payer_handoff_pending payer_opened

Example

{
  "integration_mode": "elements",
  "status": "payer_handoff_pending"
}