Skip to main content

ProcessPaymentRequest

achAccountNumberstringnullable

Possible values: Value must match regular expression \d{4,17}

achAccountTypeCheckoutAchAccountTypenullable

Possible values: [CHECKING, SAVINGS]

achAuthorizationAcceptedbooleannullable
achRoutingNumberstringnullable

Possible values: Value must match regular expression \d{9}

billingCitystringnullable
billingCountrystringnullable
billingStatestringnullable
billingStreetstringnullable
billingStreet2stringnullable
billingZipstringnullable
browserEvidence objectnullable
languagestringnullable

Possible values: <= 32 characters, Value must match regular expression ^[^\p{Cntrl}]*[^\p{Cntrl}\s][^\p{Cntrl}]*$

platformDescriptionstringnullable

Possible values: <= 128 characters, Value must match regular expression ^[^\p{Cntrl}]*[^\p{Cntrl}\s][^\p{Cntrl}]*$

screenstringnullable

Possible values: <= 64 characters, Value must match regular expression ^[^\p{Cntrl}]*[^\p{Cntrl}\s][^\p{Cntrl}]*$

timezonestringnullable

Possible values: <= 64 characters, Value must match regular expression ^[^\p{Cntrl}]*[^\p{Cntrl}\s][^\p{Cntrl}]*$

cardEntryAttemptIdstringnullable
cardHolderNamestringnullable
cardNumberstringnullable
cvvstringnullable
emailstring<email>nullable

Possible values: <= 255 characters

expirationDatestringnullable
giftCard objectnullable
cardNumberstringrequired
pinstringnullable
level2 objectnullable
property name*anynullable
level3 objectnullable
property name*anynullable
lineItems object[]nullable
  • Array [
    • commodityCodestringnullable

    Possible values: <= 64 characters

    descriptionstringnullable

    Possible values: <= 255 characters

    discountAmountinteger<int64>nullable

    Possible values: >= 0

    productCodestringnullable

    Possible values: <= 64 characters

    productIdstringnullable

    Possible values: <= 64 characters

    quantityinteger<int32>nullable

    Possible values: >= 1

    taxAmountinteger<int64>nullable

    Possible values: >= 0

    totalAmountinteger<int64>nullable

    Possible values: >= 0

    unitCostinteger<int64>nullable

    Possible values: >= 0

    unitOfMeasurestringnullable

    Possible values: <= 16 characters

  • ]
    • partialAuthSupportbooleannullable
    paymentMethodTypeCheckoutPaymentMethodType

    Possible values: [CARD, ACH]

    recaptchaTokenstringnullable
    saveCardbooleannullable

    The signed-in customer's explicit consent to save this new card. Requires an authenticated customer; only this consent enrolls the card as card-on-file, including on a session whose cardStorageRequested is true.

    savedPaymentMethodIdstringnullable
    shippingAddress objectnullable
    citystringnullable
    countrystringnullable
    line1stringnullable
    line2stringnullable
    namestringnullable
    postalCodestringnullable
    statestringnullable
    storedCredentialReasonStoredCredentialReasonnullable

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

    taxAmountinteger<int64>nullable
    ProcessPaymentRequest
    {
      "achAccountNumber": "string",
      "achAccountType": "CHECKING",
      "achAuthorizationAccepted": true,
      "achRoutingNumber": "string",
      "billingCity": "string",
      "billingCountry": "string",
      "billingState": "string",
      "billingStreet": "string",
      "billingStreet2": "string",
      "billingZip": "string",
      "browserEvidence": {
        "language": "string",
        "platformDescription": "string",
        "screen": "string",
        "timezone": "string"
      },
      "cardEntryAttemptId": "string",
      "cardHolderName": "string",
      "cardNumber": "string",
      "cvv": "string",
      "email": "[email protected]",
      "expirationDate": "string",
      "giftCard": {
        "cardNumber": "string",
        "pin": "string"
      },
      "level2": {},
      "level3": {},
      "lineItems": [
        {
          "commodityCode": "string",
          "description": "string",
          "discountAmount": 0,
          "productCode": "string",
          "productId": "string",
          "quantity": 0,
          "taxAmount": 0,
          "totalAmount": 0,
          "unitCost": 0,
          "unitOfMeasure": "string"
        }
      ],
      "partialAuthSupport": true,
      "paymentMethodType": "CARD",
      "recaptchaToken": "string",
      "saveCard": true,
      "savedPaymentMethodId": "string",
      "shippingAddress": {
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "name": "string",
        "postalCode": "string",
        "state": "string"
      },
      "storedCredentialReason": "RECURRING",
      "taxAmount": 0
    }