Payment — request

V1

{
  "body": {
    "agent": {
      "firstName": "string | null",
      "isAccessVerified": "boolean",
      "lastName": "string | null",
      "userId": "string"
    },
    "amount": "integer (int64)",
    "authRequired": "boolean",
    "authorizeCard": "boolean",
    "consent": {
      "collectionDetails": {
        "tel": {
          "inboundPhoneNumber": {
            "countryCode": "string",
            "number": "string"
          }
        },
        "type": "string (WEB | TEL | PPD)",
        "web": {
          "ipAddress": "string",
          "userAgent": "string"
        }
      },
      "collectionTimestamp": "string (date-time)",
      "merchantConsentText": "string"
    },
    "customer": {
      "dateOfBirth": "string (date)",
      "email": "string",
      "enterpriseIdentifier": "string",
      "firstName": "string",
      "hsid": "string (uuid)",
      "lastName": "string",
      "metadata": {
        "<key>": "string"
      },
      "name": "string" <REMOVED>,
      "phoneNumber": {
        "countryCode": "string",
        "number": "string"
      },
      "ssnLastFour": "string",
      "zip5": "string"
    },
    "merchantTransactionId": "string",
    "metadata": {
      "<key>": "string"
    },
    "partialAuthorization": "boolean",
    "paymentDescription": "string" <RENAMED>,
    "paymentMethod": {
        "default": "boolean",
        "savePaymentMethod": "boolean",
        "sourceProvider": {
          "name": "string (CCG | GOOGLE_PAY | APPLE_PAY)"
        },
        "type": "string (CARD)",
        "vendor": "string (STRIPE)",
        "vendorPaymentMethodId": "string"
      } <REMOVED>,
    "paymentMethodId": "string (uuid)" <REMOVED>,
    "paymentType": "string (SALE | PRE_AUTH)" <REMOVED>
  },
  "headers": {
    "Content-Type": "string",
    "X-Checkout-Id": "string (uuid)",
    "X-Customer-Id": "string",
    "X-Merchant-Id": "string (uuid)",
    "x-source": "string"
  },
  "method": "POST",
  "path": "/payments" <MODIFIED>
}

V2

{
  "body": {
    "agent": {
      "firstName": "string | null",
      "isAccessVerified": "boolean",
      "lastName": "string | null",
      "userId": "string"
    },
    "amount": "integer (int64)",
    "authRequired": "boolean",
    "authorizeCard": "boolean",
    "consent": {
      "collectionDetails": {
        "tel": {
          "inboundPhoneNumber": {
            "countryCode": "string",
            "number": "string"
          }
        },
        "type": "string (WEB | TEL | PPD)",
        "web": {
          "ipAddress": "string",
          "userAgent": "string"
        }
      },
      "collectionTimestamp": "string (date-time)",
      "merchantConsentText": "string"
    },
    "currencyCode": "string" <ADDED>,
    "customer": {
      "dateOfBirth": "string (date)",
      "email": "string",
      "enterpriseIdentifier": "string",
      "firstName": "string",
      "hsid": "string (uuid)",
      "lastName": "string",
      "metadata": {
        "<key>": "string"
      },
      "phoneNumber": {
        "countryCode": "string",
        "number": "string"
      },
      "ssnLastFour": "string",
      "zip5": "string"
    },
    "description": "string" <RENAMED>,
    "merchantTransactionId": "string",
    "metadata": {
      "<key>": "string"
    },
    "partialAuthorization": "boolean",
    "paymentAllocations": [
        {
          "----saved-payment-method----": "ignore",
          "amount": "integer",
          "paymentMethodId": "string (uuid)"
        },
        {
          "----inline-payment-method----": "ignore",
          "amount": "integer",
          "paymentMethod": {
            "cardCategory": {
              "medications": [
                {
                  "label": "string",
                  "value": "string"
                }
              ],
              "type": "string (MANUFACTURER_CARD)"
            },
            "default": "boolean",
            "nickName": "string",
            "paymentMethodDetails": {
              "accountType": "string (savings | checking)",
              "last4": "string",
              "nameOnAccount": "string",
              "nameOnCard": "string",
              "routingNumber": "string",
              "type": "string (CARD | BANK_ACCOUNT)",
              "vendorPaymentmethodId": "string"
            },
            "paymentMethodSourceDetails": {
              "channel": "string (WEBFORM | TELEPHONIC_ENTRY)",
              "uiSourceFragment": "string (STRIPE | SYCURIO)"
            },
            "savePaymentMethod": "boolean",
            "sourceProvider": {
              "name": "string (CCG | GOOGLE_PAY | APPLE_PAY)"
            }
          }
        }
      ] <ADDED>,
    "paymentDetails": {
        "healthcare": {
          "iias": {
            "qualifiedAmount": "integer",
            "qualifiedAmountDetails": {
              "prescriptionAmount": "integer"
            }
          },
          "visionAmount": "integer"
        }
      } <ADDED>,
    "statementDescriptorSuffix": "string | null" <ADDED>
  },
  "headers": {
    "Content-Type": "string",
    "X-Checkout-Id": "string (uuid)",
    "X-Customer-Id": "string",
    "X-Merchant-Id": "string (uuid)",
    "x-source": "string"
  },
  "method": "POST",
  "path": "/v2/payments" <MODIFIED>
}