Retrieve payment link

POST /v1/payment-links/{paymentLinkId}

Retrieve payment link for given ID

Path parameters

paymentLinkId string Required

Payment link ID

Responses

200 application/json

successful operation
Hide response attributes Show response attributes object
- paymentLink object Required
  
  Payment Link schema
  
  Hide paymentLink attributes Show paymentLink attributes object
  
  id string Required
  
  Payment link ID
  
  companyId string
  
  Company ID
  
  transactionId string
  
  Transaction ID
  
  createdAt string(date-time) Required
  
  Created at date
- aggregateTransaction object Required
  
  Transaction with related details schema
  
  Hide aggregateTransaction attributes Show aggregateTransaction attributes object
  
  aggregateId string Required
  
  aggregateId
  
  transaction object Required
  
  Transaction schema
  
  Hide transaction attributes Show transaction attributes object
  
  id string Required
  
  id
  
  companyId string Required
  
  Company ID
  
  familyId string Required
  
  Family ID
  
  familyName string Required
  
  Family name
  
  relatedTransactionId string | null
  
  Related transaction ID
  
  type string Required
  
  Values are debit or credit.
  
  date string(date) Required
  
  Date of transaction
  
  description string Required
  
  Description of transaction
  
  orderId string | null
  
  Order ID
  
  deletedAt string(date-time) | null
  
  Deleted at date
  
  details array[object] Required
  
  details
  
  Transaction Details with related entities schema
  
  Hide details attributes Show details attributes object
  
  details object Required
  
  Transaction Detail schema
  
  Hide details attributes Show details attributes object
  
  id string Required
  
  id
  
  companyId string Required
  
  Company ID
  
  transactionId string Required
  
  Transaction ID
  
  type string Required
  
  Values are manual-debit, tax, additional-fee, registration-fee, tuition, trial, refund, payment-auto-failed, payment-auto-failed-reversal, product, discount-credit, upcoming-payment-adjustment, payment-manual, payment-manual-account-balance, discount, discount-tax, credit-note, manual-debit-credit, tax-credit, registration-fee-credit, tuition-credit, trial-credit, product-credit, additional-credit, custom-credit, payment-auto, payment-pending-card, payment-auto-account-balance, fee-class-manager, or fee-company.
  
  amount integer Required
  
  Amount of transaction
  
  description string Required
  
  Description of transaction
  
  deletedAt string(date-time) | null
  
  Deleted at date
  
  relatedEntities array[object] Required
  
  relatedEntities
  
  Transaction Detail Entity schema
  
  Hide relatedEntities attributes Show relatedEntities attributes object
  
  id string Required
  
  id
  
  companyId string Required
  
  Company ID
  
  transactionDetailId string Required
  
  Transaction Detail ID
  
  entityId string Required
  
  Entity ID
  
  stats object Required
  
  Transaction stats
  
  Hide stats attributes Show stats attributes object
  
  total integer Required
  
  Total amount of transaction
  
  subtotal integer Required
  
  Subtotal amount of transaction
  
  discountTotal integer Required
  
  Total discount amount of transaction
  
  taxTotal integer Required
  
  Total tax amount of transaction
- paymentSession object Required
  
  Payment session for payment links without customer session
  
  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
  
  Hide attributes Show attributes
  
  brand string Required
  
  Values are amex, diners, discover, eftpos_au, jcb, mastercard, unionpay, visa, or unknown.
  
  country string Required
  
  Country
  
  expiryMonth integer Required
  
  Expiry month
  
  expiryYear integer Required
  
  Expiry year
  
  cardNumber string Required
  
  Card number
  
  last4 string Required
  
  Last 4
  
  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
  
  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
- subtotal integer Required
  
  Subtotal amount in cents before processing fees
- processingFee integer Required
  
  Processing fee amount in cents
- processingFeePercent number(float) Required
  
  Processing fee percentage
- total integer Required
  
  Total amount in cents including processing fees

POST /v1/payment-links/{paymentLinkId}

curl \
 --request POST 'https://api.classmanager.io/v1/payment-links/{paymentLinkId}'

Response examples (200)

{
  "paymentLink": {
    "id": "pay_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "companyId": "co_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "transactionId": "trn_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "createdAt": "2023-12-05 14:30:41"
  },
  "aggregateTransaction": {
    "aggregateId": "trn_xxxxxxxxxxx",
    "transaction": {
      "id": "trn_123123123123",
      "companyId": "co_123123123123",
      "familyId": "fml_123123123123",
      "familyName": "Potter",
      "relatedTransactionId": "trn_123123123123",
      "type": "debit",
      "date": "2023-12-05",
      "description": "This is a transaction",
      "orderId": "ord_xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "deletedAt": "2023-12-05 14:30:41"
    },
    "details": [
      {
        "details": {
          "id": "trn_123123123123",
          "companyId": "co_123123123123",
          "transactionId": "trn_123123123123",
          "type": "manual-debit",
          "amount": 100,
          "description": "This is a transaction",
          "deletedAt": "2023-12-05 14:30:41"
        },
        "relatedEntities": [
          {
            "id": "trn_123123123123",
            "companyId": "co_123123123123",
            "transactionDetailId": "trnd_123123123123",
            "entityId": "cls_123123123123"
          }
        ]
      }
    ],
    "stats": {
      "total": 1000,
      "subtotal": 950,
      "discountTotal": 30,
      "taxTotal": 20
    }
  },
  "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"
          }
        ]
      }
    },
    "ephemeralKey": {
      "id": "ephkey_xxxxxxxx",
      "secret": "ek_xxxxxxxx",
      "associatedObjectId": "cus_xxxxxxxx",
      "associatedObjectType": "customer"
    }
  },
  "subtotal": 1000,
  "processingFee": 29,
  "processingFeePercent": 2.9,
  "total": 1029
}

Retrieve payment link

Path parameters

Responses

data object Required