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

      • 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, discount-credit, payment-manual, discount, discount-tax, credit-note, manual-debit-credit, tax-credit, registration-fee-credit, tuition-credit, trial-credit, payment-auto, payment-pending-card, 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
    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 | null Required
        Hide paymentMethod attributes Show paymentMethod attributes object | null

        • 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

          Hide attributes Show attributes

          • sortCode string Required

            Sort code

          • accountNumber string Required

            Account number

          • last4 string Required

            Last 4

      • charge object | null Required
        Hide charge attributes Show charge attributes object | null

        • 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