POST v1/payments/Surcharge

Request Information

URI Parameters

None.

Body Parameters

Common.Dto.Post.Payment

Name	Type	Additional information
reference	string	String length: inclusive between 0 and 500
effectiveTimestamp	date	None.
referenceDate	date	None.
customerId	integer	None.
amount	decimal number	Matching regular expression pattern: ^\d*.?\d{0,2}?$ Range: inclusive between 0.01 and 79228162514264337593543950335
source	string	None.
paymentMethod	string	None.
paymentMethodId	integer	None.
paymentAllocations	Collection of Common.Dto.Post.PaymentAllocation	None.
autoAllocate	boolean	None.
autoAllocateOrder	string	None.
useDefaultPaymentMethod	boolean	None.
creditCard	Common.Dto.Post.CreditCard	None.
sendToNetsuite	boolean	None.
sendToQuickbooksOnline	boolean	None.
pendingSettlement	boolean	None.
bulkPurchase	Common.Dto.Post.BulkPurchase	None.

Request Formats

application/json, text/json

Sample:

{
  "reference": "sample string 1",
  "effectiveTimestamp": "2025-05-21T09:30:46.4961456+00:00",
  "referenceDate": "2025-05-21T09:30:46.4961456+00:00",
  "customerId": 3,
  "amount": 4.0,
  "source": "sample string 5",
  "paymentMethod": "sample string 6",
  "paymentMethodId": 1,
  "paymentAllocations": [
    {
      "invoiceId": 1,
      "amount": 2.0
    },
    {
      "invoiceId": 1,
      "amount": 2.0
    }
  ],
  "autoAllocate": true,
  "autoAllocateOrder": "sample string 8",
  "useDefaultPaymentMethod": true,
  "creditCard": {
    "cardNumber": "sample string 1",
    "expirationMonth": 2,
    "expirationYear": 3,
    "cvv": "sample string 4",
    "firstName": "sample string 5",
    "lastName": "sample string 6",
    "address1": "sample string 7",
    "address2": "sample string 8",
    "city": "sample string 9",
    "stateId": 1,
    "countryId": 1,
    "postalZip": "sample string 10",
    "paymentCollectOptions": {
      "collectionAmount": 1.0,
      "payPendingCharges": true,
      "payBalanceOwing": true
    },
    "email": "sample string 11",
    "makeDefault": true,
    "riskToken": "sample string 13",
    "clientIp": "sample string 14",
    "businessTaxId": "sample string 15",
    "customerId": 16,
    "source": "sample string 17"
  },
  "sendToNetsuite": true,
  "sendToQuickbooksOnline": true,
  "pendingSettlement": true,
  "bulkPurchase": {
    "customerId": 1,
    "autoPurchase": true,
    "purchases": [
      {
        "productId": 1,
        "quantity": 1.0,
        "name": "sample string 2",
        "description": "sample string 3",
        "overridePriceRanges": [
          {
            "min": 1.0,
            "max": 1.0,
            "amount": 2.0
          },
          {
            "min": 1.0,
            "max": 1.0,
            "amount": 2.0
          }
        ],
        "pricingModelType": "sample string 4",
        "pricingFormulaType": "sample string 5",
        "customFields": [
          {
            "key": "sample string 1",
            "value": {}
          },
          {
            "key": "sample string 1",
            "value": {}
          }
        ],
        "discounts": [
          {
            "discountType": "sample string 1",
            "amount": 2.0
          },
          {
            "discountType": "sample string 1",
            "amount": 2.0
          }
        ],
        "productItems": [
          {
            "reference": "sample string 1",
            "name": "sample string 2",
            "description": "sample string 3"
          },
          {
            "reference": "sample string 1",
            "name": "sample string 2",
            "description": "sample string 3"
          }
        ],
        "couponCodes": [
          "sample string 1",
          "sample string 2"
        ],
        "earningSettings": {
          "earningSchedules": [
            {
              "scheduledType": "sample string 1",
              "scheduledInterval": "sample string 2",
              "numberOfIntervals": 1,
              "scheduledAmount": 1.0,
              "reference": "sample string 3"
            },
            {
              "scheduledType": "sample string 1",
              "scheduledInterval": "sample string 2",
              "numberOfIntervals": 1,
              "scheduledAmount": 1.0,
              "reference": "sample string 3"
            }
          ],
          "earningInterval": "sample string 1",
          "earningNumberOfIntervals": 1,
          "earningTimingInterval": "sample string 2",
          "earningTimingType": "sample string 3"
        },
        "netsuiteClassId": "sample string 6",
        "netsuiteLocationId": "sample string 7",
        "targetOrderQuantity": 1.0,
        "netsuiteBinId": "sample string 8",
        "invoiceOwner": "sample string 9",
        "skipCouponValidation": true,
        "hubspotDealId": 11,
        "quickBooksClassId": "sample string 12"
      },
      {
        "productId": 1,
        "quantity": 1.0,
        "name": "sample string 2",
        "description": "sample string 3",
        "overridePriceRanges": [
          {
            "min": 1.0,
            "max": 1.0,
            "amount": 2.0
          },
          {
            "min": 1.0,
            "max": 1.0,
            "amount": 2.0
          }
        ],
        "pricingModelType": "sample string 4",
        "pricingFormulaType": "sample string 5",
        "customFields": [
          {
            "key": "sample string 1",
            "value": {}
          },
          {
            "key": "sample string 1",
            "value": {}
          }
        ],
        "discounts": [
          {
            "discountType": "sample string 1",
            "amount": 2.0
          },
          {
            "discountType": "sample string 1",
            "amount": 2.0
          }
        ],
        "productItems": [
          {
            "reference": "sample string 1",
            "name": "sample string 2",
            "description": "sample string 3"
          },
          {
            "reference": "sample string 1",
            "name": "sample string 2",
            "description": "sample string 3"
          }
        ],
        "couponCodes": [
          "sample string 1",
          "sample string 2"
        ],
        "earningSettings": {
          "earningSchedules": [
            {
              "scheduledType": "sample string 1",
              "scheduledInterval": "sample string 2",
              "numberOfIntervals": 1,
              "scheduledAmount": 1.0,
              "reference": "sample string 3"
            },
            {
              "scheduledType": "sample string 1",
              "scheduledInterval": "sample string 2",
              "numberOfIntervals": 1,
              "scheduledAmount": 1.0,
              "reference": "sample string 3"
            }
          ],
          "earningInterval": "sample string 1",
          "earningNumberOfIntervals": 1,
          "earningTimingInterval": "sample string 2",
          "earningTimingType": "sample string 3"
        },
        "netsuiteClassId": "sample string 6",
        "netsuiteLocationId": "sample string 7",
        "targetOrderQuantity": 1.0,
        "netsuiteBinId": "sample string 8",
        "invoiceOwner": "sample string 9",
        "skipCouponValidation": true,
        "hubspotDealId": 11,
        "quickBooksClassId": "sample string 12"
      }
    ],
    "invoiceCollectOptions": {
      "paymentMethod": 0,
      "paymentMethodId": 1,
      "useAnyAvailableFundsFirst": true,
      "rollbackOnFailedPayment": true
    },
    "view": "sample string 3"
  }
}

Response Information

Resource Description

Common.Dto.Get.Surcharge

Name	Type	Additional information
binType	string	None.
surchargeRate	string	None.
surchargeAmount	string	None.
total	string	None.

Response Formats

application/json, text/json

Sample:

{
  "binType": "sample string 1",
  "surchargeRate": "sample string 2",
  "surchargeAmount": "sample string 3",
  "total": "sample string 4"
}