CheckoutPayRequest

Supply the tender fields appropriate to the checkout session. Raw card payments require billingZip and billingStreet.

cardNumberstringnullable

expirationDatestringnullable

cvvstringnullable

cardHolderNamestringnullable

tokenIdstringnullable

paymentMethodIdstringnullable

billingZipstringnullable

billingStreetstringnullable

billingCitystringnullable

billingStatestringnullable

billingCountrystringnullable

emailstring<email>nullable

Possible values: <= 255 characters

saveCardbooleannullable

shippingAddress objectnullable

namestringnullable

line1stringnullable

line2stringnullable

citystringnullable

statestringnullable

postalCodestringnullable

countrystringnullable

recaptchaTokenstringnullable

lineItems object[]nullable

Array [

productIdstringnullable

Possible values: <= 64 characters

descriptionstringnullable

Possible values: <= 255 characters

quantityintegernullable

Possible values: >= 1

unitCostintegernullable

Possible values: >= 0

discountAmountintegernullable

Possible values: >= 0

taxAmountintegernullable

Possible values: >= 0

totalAmountintegernullable

Possible values: >= 0

commodityCodestringnullable

Possible values: <= 64 characters

productCodestringnullable

Possible values: <= 64 characters

unitOfMeasurestringnullable

Possible values: <= 16 characters

]

taxAmountintegernullable

level2 objectnullable

property name*anynullable

level3 objectnullable

property name*anynullable

partialAuthSupportbooleannullable

storedCredentialReasonstringnullable

Possible values: [RECURRING, SUBSCRIPTION, STANDING_ORDER, UNSCHEDULED]

giftCard objectnullable

cardNumberstringrequired

pinstringnullable

CheckoutPayRequest
{
  "cardNumber": "string",
  "expirationDate": "string",
  "cvv": "string",
  "cardHolderName": "string",
  "tokenId": "string",
  "paymentMethodId": "string",
  "billingZip": "string",
  "billingStreet": "string",
  "billingCity": "string",
  "billingState": "string",
  "billingCountry": "string",
  "email": "user@example.com",
  "saveCard": true,
  "shippingAddress": {
    "name": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string"
  },
  "recaptchaToken": "string",
  "lineItems": [
    {
      "productId": "string",
      "description": "string",
      "quantity": 0,
      "unitCost": 0,
      "discountAmount": 0,
      "taxAmount": 0,
      "totalAmount": 0,
      "commodityCode": "string",
      "productCode": "string",
      "unitOfMeasure": "string"
    }
  ],
  "taxAmount": 0,
  "level2": {},
  "level3": {},
  "partialAuthSupport": true,
  "storedCredentialReason": "RECURRING",
  "giftCard": {
    "cardNumber": "string",
    "pin": "string"
  }
}