Zamok Kiosk API
    Preparing search index...
    payBill: {
        failure: PayloadAC<"PAY_BILL_FAILURE", { error: string }>;
        request: PayloadAC<"PAY_BILL_REQUEST", CardBillPaymentRequest>;
        success: PayloadAC<"PAY_BILL_SUCCESS", BillPaymentResponse>;
    } = ...

    Dispatch to submit a bill payment request.

    Type Declaration

    • failure: PayloadAC<"PAY_BILL_FAILURE", { error: string }>
    • request: PayloadAC<"PAY_BILL_REQUEST", CardBillPaymentRequest>
    • success: PayloadAC<"PAY_BILL_SUCCESS", BillPaymentResponse>

    PAY_BILL_REQUEST expects a BillPaymentRequest payload with these properties:

    • billNumber: bill identifier expected by the PayIt integration API.
    • effectiveDate: effective payment date as an ISO date string.
    • transactionId: Zamok transaction identifier.
    • amount: payment amount in dollars.
    • contactPhone: payer phone number.
    • contactEmail: optional payer email address.
    • cashPayment: optional flag identifying a cash payment.
    • paidBy: optional payer display name.

    PAY_BILL_SUCCESS contains a BillPaymentResponse. All response identifiers are optional and nullable: payableId, serviceOfferingId, payItTransactionId, lineItemId, externalTransactionId, and externalReceiptId.

    In the Shelby workflow, billNumber is populated from the selected TaxBill.billId; billId is not a property of BillPaymentRequest.

    {
    type: "PAY_BILL_REQUEST",
    payload: {
    billNumber: "2025-000123",
    effectiveDate: "2026-08-25",
    transactionId: "zamok-transaction-id",
    amount: 125.5,
    contactEmail: "payer@example.com",
    contactPhone: "9015550100",
    cashPayment: false,
    paidBy: "Jane Doe"
    }
    }
    {
    type: "PAY_BILL_SUCCESS",
    payload: {
    payableId: "payable-id",
    serviceOfferingId: "service-offering-id",
    payItTransactionId: "payit-transaction-id",
    lineItemId: "line-item-id",
    externalTransactionId: "external-transaction-id",
    externalReceiptId: "external-receipt-id"
    }
    }
    {
    type: "PAY_BILL_FAILURE",
    payload: {
    error: "Payment failed"
    }
    }