v1

latestOpenAPI 3.0.32026-07-2455445.8 KB

Checkout Session

Create Session

Enables merchant to create the session/context needed for a native mobile checkout experience. This will return a URL that can be launched in a webView by the merchant for a Paze checkout.

post/v1/checkout/sessions/create

Request body

clientContextstring

Customer-defined transaction identifier, reflected in response. Referred to as “sessionId” in web integration. Session reference identifier generated by the Merchant. If present here, it will be returned in the Checkout response. This is recommended to be identical across the Checkout request and the /wallets/sessions/checkout/complete request.

Example request

{
  "data": {
    "cobrand": [
      {
        "name": "essential",
        "benefitsOffered": true
      }
    ]
  }
}

Response

Successfully located a wallet for the provided identity key

clientContextstring

ewSIDstring required

Globally unique identifier generated by Early Warning. Returned in the response message in response to the initial request. This identifier ties all information about the session together and should be easily accessible by customer staff submitting support requests to Early Warning. Character set a-f, 0-9, -.

timestampISO8601string date-time required

Timestamp of message in ISO8601 extended combined format. Format: {YYYY}-{MM|-{DD}T{HH}:{MM}:{SS}Z Example: 2015-12-31T17:18Z Time stamp when response is sent by the Service Operator Services.

All 5 operations