Embedded Checkout API Specification

Embedded Checkout

Apple Pay

Apple Pay merchant validation and payment token processing.

Pay with Apple Pay payment token

post /api/apple-pay/payment

Request Schema

paymentToken required

Type

object

amount

Type

string

customerChosenAmount

Type

string

tax

Type

string

sealedResult

Type

string

Type

string

phone

Type

string

firstName

Type

string

lastName

Type

string

billing

Type

object

shipping

Type

object

customFields

Type

object

Example

[object Object]

Example Request

{
  "paymentToken": "object",
  "amount": "string",
  "customerChosenAmount": "string",
  "tax": "string",
  "sealedResult": "string",
  "email": "string",
  "phone": "string",
  "firstName": "string",
  "lastName": "string",
  "billing": {
    "address": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string"
  },
  "shipping": {
    "recipientName": "string",
    "address": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string"
  },
  "customFields": {
    "custom_0": "INV-12345"
  }
}

Example Response

200 Payment processed successfully

400 Bad Request

401 Unauthorized

409 Session token already used

417 Expectation Failed

500 Server error

Validate a merchant who is about to use apple pay

post /api/apple-pay/validate-merchant

Request Schema

domain required

Type

string

checkoutName required

Type

string

Example Request

{
  "domain": "string",
  "checkoutName": "string"
}

Example Response

200 Merchant validated successfully

400 Bad Request

401 Unauthorized

417 Expectation Failed

500 Server error