Initiate a tokenized payment link session

Creates a PENDING link session and returns a redirectUrl and appToken. The merchant opens redirectUrl in an in-app browser and passes appToken as X-ShopBack-App-Token.

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

Merchant callback URL; must be on the per-channel allowlist.

string
required

Merchant-supplied CSRF nonce; stored verbatim and echoed back unchanged in the callback redirect.

string
required

Merchant's opaque user ID. Used to verify that tokenized payments can only be made to the same customer who initiated the link session.

userHint
object
required

Identity hints from the merchant displayed on the ShopBack consent page so the user can verify the linking request was intended for them. At least one sub-field must be present. ShopBack does not validate these values — they are display-only.

Responses

400

Invalid request body, malformed callbackUrl, callbackUrl not on the channel allowlist, or userHint missing or contains no sub-fields.

401

Missing or invalid merchant JWT.

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