Better Payment 0.11.1 API
    Preparing search index...

    Class Parampos

    Parampos Payment Provider

    Hierarchy (View Summary)

    Index
    • Pre-authorization without 3D Secure (TP_Islem_Odeme_OnProv_WMD, NS). Blocks the amount; charge it with capture() or release it with voidAuthorization().

      Parameters

      Returns Promise<PaymentResponse>

    • The amount to charge (paidPrice, Param's Toplam_Tutar) for a card and installment count, using the merchant's rates.

      Parameters

      • request: { binNumber: string; installment?: number; price: string }

      Returns Promise<string>

      ValidationError when the installment count is not available for the card

    • Cancel (void) a same-day payment. paymentId is the order id (Siparis_ID). Param requires the full amount; when price is not given it is read with a status query first.

      Parameters

      Returns Promise<CancelResponse>

    • Capture of a pre-authorization (TP_Islem_Odeme_OnProv_Kapa). amount may be lower than the authorized amount (partial capture).

      Parameters

      • request: CaptureRequest

      Returns Promise<PaymentResponse>

    • Complete 3D Secure payment

      1. Verifies islemHash with the configured GUID (callback values are untrusted).
      2. Requires mdStatus = 1 (full 3D authentication).
      3. Finalizes the payment with TP_WMD_Pay. The payment is only successful when TP_WMD_Pay returns Sonuc > 0 and a Dekont_ID.

      Parameters

      Returns Promise<PaymentResponse>

    • Direct (non-3D) payment

      price is Islem_Tutar and paidPrice is Toplam_Tutar (amount charged to the card, including any installment commission). For installments, calculate paidPrice from the rates configured on your Param account.

      Parameters

      Returns Promise<PaymentResponse>

    • Deletes a saved card

      Parameters

      • _request: DeleteCardRequest

      Returns Promise<DeleteCardResponse>

    • The merchant's customer-facing commission rates per card program (TP_Ozel_Oran_SK_Liste). Negative rates mean "not available" and are left out.

      Returns Promise<ParamposInstallmentRates[]>

    • A customer's saved cards

      Parameters

      • _request: { customerToken: string }

      Returns Promise<ListCardsResponse>

    • Saves a card with the provider without charging it

      Parameters

      • _request: SaveCardRequest

      Returns Promise<SaveCardResponse>

    • Releases a pre-authorization (TP_Islem_Iptal_OnProv); nothing is charged

      Parameters

      • request: VoidAuthorizationRequest

      Returns Promise<CancelResponse>