Class Manager
GET /v1/order/{id}/company-payment-start

Path parameters

  • id string Required

    Order id

Query parameters

  • orderItemId string

    Order item id

  • date string(date)

    Payment date

Responses

  • 200 application/json

    Success response

    Hide response attributes Show response attributes object
    • amountToPay integer Required
    • cardProcessingFee integer Required
    • paymentMethods array[object] Required
      Hide paymentMethods attributes Show paymentMethods attributes object
      • id string Required

        Stripe ID

      • type string Required

        Values are acss_debit, affirm, afterpay_clearpay, alipay, amazon_pay, au_becs_debit, bacs_debit, bancontact, blik, boleto, card, card_present, cashapp, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, klarna, konbini, link, mobilepay, multibanco, oxxo, p24, paynow, paypal, pix, promptpay, revolut_pay, sepa_debit, sofort, swish, twint, us_bank_account, wechat_pay, or zip.

      • isDefault boolean Required

        Is default

      • data object Required

        One of:
        StripePaymentMethodCardDataDto object StripePaymentMethodBacsDebitDataDto object
GET /v1/order/{id}/company-payment-start 
curl \
 --request GET 'https://api-dev.classmanager.io/v1/order/ord_123123123123/company-payment-start'
Response examples (200) 
{
  "amountToPay": "12.34",
  "cardProcessingFee": "1.23",
  "paymentMethods": [
    {
      "id": "pm_123456789",
      "type": "acss_debit",
      "isDefault": true,
      "data": {
        "brand": "amex",
        "country": "US",
        "expiryMonth": 12,
        "expiryYear": 2023,
        "cardNumber": "************4242",
        "last4": "4242"
      }
    }
  ]
}