Class Manager
GET /v1/order/{id}/family-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
    • paymentSession object
      Hide paymentSession attributes Show paymentSession attributes object
      • paymentIntent object Required
        Hide paymentIntent attributes Show paymentIntent attributes object
        • id string Required

          Payment Intent Id

        • clientSecret string Required

          Payment Intent Client Secret

        • amount integer Required

          Payment Intent Amount

        • status string Required

          Values are canceled, processing, requires_action, requires_capture, requires_confirmation, requires_payment_method, or succeeded.

        • paymentMethod object Required
          Hide paymentMethod attributes Show paymentMethod 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
        • charge object Required
          Hide charge attributes Show charge attributes object
          • id string Required

            Payment Intent Id

          • amount integer Required

            Payment Intent Amount

          • amountCaptured integer

            Payment Intent Amount Captured

          • amountRefunded integer

            Payment Intent Amount Refunded

          • currency string Required

            Payment Intent Currency

          • refunded boolean Required

            Payment Intent Refunded

          • refunds array[object] Required
            Hide refunds attributes Show refunds attributes object
            • id string Required

              Payment Intent Id

            • amount integer Required

              Refund Amount

            • currency string Required

              Currency

            • status string Required

              Values are pending, requires_action, canceled, succeeded, or failed.

            • createdAt string(date) Required

              Created at

      • customerSession object Required
        Hide customerSession attributes Show customerSession attributes object
        • customerId string

          Customer Id

        • clientSecret string Required

          Customer Session Client Secret

      • ephemeralKey object Required
        Hide ephemeralKey attributes Show ephemeralKey attributes object
        • id string Required

          Ephemeral Key Id

        • secret string Required

          Ephemeral Key Secret

        • associatedObjectId string Required

          Associated Object Id

        • associatedObjectType string Required

          Associated Object Type
GET /v1/order/{id}/family-payment-start 
curl \
 --request GET 'https://api-dev.classmanager.io/v1/order/ord_123123123123/family-payment-start'
Response examples (200) 
{
  "amountToPay": "12.34",
  "cardProcessingFee": "1.23",
  "paymentSession": {
    "paymentIntent": {
      "id": "pm_1234567890",
      "clientSecret": "pm_1234567890_secret_xxxxxxxx",
      "amount": 1999,
      "status": "canceled",
      "paymentMethod": {
        "id": "pm_123456789",
        "type": "acss_debit",
        "isDefault": true,
        "data": {
          "brand": "amex",
          "country": "US",
          "expiryMonth": 12,
          "expiryYear": 2023,
          "cardNumber": "************4242",
          "last4": "4242"
        }
      },
      "charge": {
        "id": "pm_1234567890",
        "amount": 1999,
        "amountCaptured": 1999,
        "amountRefunded": 1999,
        "currency": "usd",
        "refunded": false,
        "refunds": [
          {
            "id": "pm_1234567890",
            "amount": 1999,
            "currency": "usd",
            "status": "pending",
            "createdAt": "2023-12-05"
          }
        ]
      }
    },
    "customerSession": {
      "customerId": "cus_1234567890",
      "clientSecret": "cs_1234567890_secret_xxxxxxxx"
    },
    "ephemeralKey": {
      "id": "ephkey_xxxxxxxx",
      "secret": "ek_xxxxxxxx",
      "associatedObjectId": "cus_xxxxxxxx",
      "associatedObjectType": "customer"
    }
  }
}