Bill payment service

Use Cases

1. Check bill info (VNPAY) – /vnpay/check-bill

• Purpose: To verify whether a customer has an outstanding bill to pay.
• Scenario: Customer selects electricity bill payment in NCB app.
• System action: NCB calls /vnpay/check-bill with service code, provider code, and customer code.
• Outcome: Bill info including bill amount, bill period, and bill amount, and customer info are returned.
• Benefit: Allows the customer to review and validate bill details before proceeding with payment.

2. Check K+ subscription (VNPAY) – /vnpay/check-bill-kplus

• Purpose: Enable customers to retrieve available K+ subscription package details.
• Scenario: A customer chooses to renew their K+ subscription in the NCB app.
• System action: NCB calls /vnpay/check-bill-kplus without needing additional bill details.
• Outcome: VNPAY responds with the list of available K+ packages.
• Benefit: Customers can review package options and proceed with the desired subscription payment.

3. Check road toll bill (VNPAY) – /vnpay/check-bill-road

• Purpose: Retrieve billing details for topping up the customer’s ePass account to pay road toll charges.
• Scenario: A customer chooses to top up their road toll account through the NCB app.
• System action: NCB invokes /vnpay/check-bill-road with the customer’s reference information.
• Outcome: VNPAY returns the payable amount, including any applicable fees.
• Benefit: Ensures the customer tops up for uninterrupted toll usage.

4. Check cable TV bill (VNPAY) – /vnpay/check-bill-cab

• Purpose: To retrieve customer’s cable TV billing info.
• Scenario: Customer pays cable TV fee via NCB app.
• System action: NCB calls /vnpay/check-bill-cab.
• Outcome: Bill details are returned from VNPAY.
• Benefit: Provides correct bill info.

5. Check bill info (PAYOO) – /payoo/check-bill

• Purpose: To validate bills via PAYOO for water, internet, tuition, etc.
• Scenario: Customer pays tuition fee through NCB app.
• System action: NCB calls /payoo/check-bill.
• Outcome: PAYOO returns billing info and amount due.
• Benefit: Supports diverse service providers in one API.

6. Check bill info (NAPAS) – /napas/check-bill

• Purpose: To validate airline ticket payment info.
• Scenario: Customer pays for Vietjet flight via NCB app.
• System action: NCB calls /napas/check-bill.
• Outcome: NAPAS returns payment amount.
• Benefit: Ensures ticket info matches before charging customer.

7. Pay bill (VNPAY) – /vnpay/pay-bill

• Purpose: To process bill payment via VNPAY (excluding top-up).
• Scenario: Customer confirms electricity bill payment.
• System action: NCB calls /vnpay/pay-bill with payment details.
• Outcome: VNPAY confirms payment and notifies biller.
• Benefit: Seamless settlement between NCB, VNPAY, and biller.

8. Mobile top-up (VNPAY) – /vnpay/pay-bill-topup

• Purpose: To recharge prepaid mobile accounts.
• Scenario: Customer selects mobile phone number and top-up amount in NCB app.
• System action: NCB calls /vnpay/pay-bill-topup.
• Outcome: Mobile operator balance is updated via VNPAY.
• Benefit: Real-time top-up service for customers.

9. Pay bill (PAYOO) – /payoo/pay-bill

• Purpose: To complete bill payments via PAYOO.
• Scenario: Customer confirms insurance bill payment.
• System action: NCB calls /payoo/pay-bill.
• Outcome: PAYOO processes payment and notifies biller.
• Benefit: Expands payment coverage for NCB customers.

10. Pay bill (NAPAS) – /napas/pay-bill

• Purpose: To complete bill payments via NAPAS.
• Scenario: Customer pays for VN Airlines ticket.
• System action: NCB calls /napas/pay-bill.
• Outcome: NAPAS processes payment and notifies biller.
• Benefit: Enables secure, fast airline payments.