Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace <internal>

Index

Type aliases

Account: { id: string; ifsc: string }

Type declaration

  • Readonly id: string
  • Readonly ifsc: string
Amount: { currencyCode: string; value: number }

Type declaration

  • Readonly currencyCode: string
  • Readonly value: number
AmountValidation: { maximum: number; minimum: number }

Type declaration

  • Readonly maximum: number
  • Readonly minimum: number
BatchRefundStatusResponseData: { refunds: readonly RefundResponseSuccessData[] }

Type declaration

BillStatus: "BILL_CREATED" | "PAYMENT_SUCCESSFUL" | "PAYMENT_FAILED" | "CREDIT_RECEIVED" | "SETTLEMENT_SUCCESSFUL" | "SETTLEMENT_FAILED" | "BILL_EXPIRED"
CreatePaymentLinkResponseData: { name: string; paymentLink: PaymentLink; platformBillID: string }

Type declaration

  • Readonly name: string
  • Readonly paymentLink: PaymentLink
  • Readonly platformBillID: string
Deduction: { account: Account; split: Split }

Type declaration

GetPaymentStatusResponseData: { amountPaid: Amount; billerBillID: string; createdAt: string; expiresAt: string; name: string; payerVpa: string; paymentLink: PaymentLink; platformBillID: string; receipt: Receipt; status: BillStatus; transactionNote: string }

Type declaration

  • Readonly amountPaid: Amount
  • Readonly billerBillID: string
  • Readonly createdAt: string
  • Readonly expiresAt: string
  • Readonly name: string
  • Readonly payerVpa: string
  • Readonly paymentLink: PaymentLink
  • Readonly platformBillID: string
  • Readonly receipt: Receipt
  • Readonly status: BillStatus
  • Readonly transactionNote: string
InitiateRefundFullAmount: { refundType: "FULL" }

Type declaration

  • Readonly refundType: "FULL"
InitiateRefundPartialAmountParams: { refundAmount: number; refundType: "PARTIAL" }

Type declaration

  • Readonly refundAmount: number
  • Readonly refundType: "PARTIAL"
InitiateRefundResponseData: { batchID: string; refunds: readonly RefundResponseDataItem[] }

Type declaration

PaymentLink: { shortURL: string; upiID: string; upiLink: string }

Type declaration

  • Readonly shortURL: string
  • Readonly upiID: string
  • Readonly upiLink: string
Receipt: { date: string; id: string }

Type declaration

  • Readonly date: string
  • Readonly id: string
Record<K, T>: { [ P in K]: T }

Construct a type with a set of properties K of type T

Type parameters

  • K: keyof any

  • T

RefundRequest: InitiateRefundAmountParams & { deductions?: readonly Deduction[]; identifier: string; identifierType: "BILL_ID" }
RefundResponseDataItem: ({ seqNo: number; success: true } & RefundResponseSuccessData) | ({ seqNo: number; success: false } & RefundResponseErrorData)
RefundResponseErrorData: { code: string; detail: string; title: string }

Type declaration

  • Readonly code: string
  • Readonly detail: string
  • Readonly title: string
RefundResponseSuccessData: { amount: Amount; billID: string; deductions: readonly Deduction[]; id: string; initiatedAt?: string; status: RefundStatus; transactionRefID: string }

Type declaration

  • Readonly amount: Amount
  • Readonly billID: string
  • Readonly deductions: readonly Deduction[]
  • Readonly id: string
  • Optional Readonly initiatedAt?: string
  • Readonly status: RefundStatus
  • Readonly transactionRefID: string
RefundStatus: "Created" | "MarkedForRefund" | "QueuedForRefund" | "Rejected" | "Initiated"
Settlement: { parts: readonly SettlementPart[]; primaryAccount: Account }

Type declaration

SettlementPart: { account: Account; remarks: string; split: Split }

Type declaration

  • Readonly account: Account
  • Readonly remarks: string
  • Readonly split: Split
SetuUPIDeepLinkParams: { authType: `${AuthScheme}`; mode: `${SetuEnv}`; productInstanceID: string; schemeID: string; secret: string }

Type declaration

  • Readonly authType: `${AuthScheme}`
  • Readonly mode: `${SetuEnv}`
  • Readonly productInstanceID: string
  • Readonly schemeID: string
  • Readonly secret: string
SourceAccountItem: { ifsc: string; number: string }

Type declaration

  • Readonly ifsc: string
  • Readonly number: string
SourceAccounts: { items: readonly SourceAccountItem[] }

Type declaration

Split: { unit: string; value: number }

Type declaration

  • Readonly unit: string
  • Readonly value: number
TriggerMockPaymentResponseData: { utr: string }

Type declaration

  • Readonly utr: string
ValidationRules: { amount?: AmountValidation; sourceAccounts?: SourceAccounts }

Type declaration

Generated using TypeDoc