Regionalized Solutions
R24 AMR | Min(s) read
Generic API's
Please find below the API details for the Ebills Interface module.
The API will only be useable if the module has been licenced by the client.
| API Name | Description | Domain | Method | URL | Resource | Operation Id | End Point Description |
|---|---|---|---|---|---|---|---|
| order-ca-billPayment-service | API to create current/future/recurring bill payments and update/cancel bill payments for a payee. Retrieves the bill payments for given payer | order | POST | /order/ca/billPayments | UB.PAYMENT,CAEBPS.API.PAY.1.0.0 | createCaBillPayment | Create current or future bill payment for a payee i.e vendor |
| order | PUT | /order/ca/billPayments/{billPaymentId}/cancellations | UB.REVERSAL,CAEBPS.API.CANCEL.PAY.1.0.0 | cancelCaBillPayment | Cancels bill payment for a payee i.e vendor for the given bill payment reference. Bill payment reference can be the exact payment reference or the external confirmation number. | ||
| order | POST | /order/ca/billPayments/standingOrders | CAPL.UB.RECURR.PAYMENT,CAEBPS.API.RECUR.PAY.1.0.0 | createCaBillPaymentStandingOrder | Create recurring bill payment for a payee with details such as payer, payer account number, frequency, amount, start date and end date | ||
| order | PUT | /order/ca/billPayments/standingOrders/{standingOrderId}/cancellations | CAPL.UB.RECURR.PAYMENT,CAEBPS.API.RECUR.PAY.1.0.0 | updateCaBillPaymentStandingOrder | Updates the recurring bill payment with details such as frequency and amount . Also the payment can be cancelled by supplying current date as end date. | ||
| order | GET | /order/ca/billPayments/customers/{customerId} | CAEBPS.API.BILL.PAYMENT.LIST.1.0.0 | getCaCustomerBillPayment | Retrieves the bill payments for a given customer with details such as customer, account number, payee, payer account number, frequency, date, amount, end date, external reference and payment id | ||
| party-ca-billPayment-service | API to manage (add/remove) payee details with registered payer and retrieves the payee details associated with payer | party | POST | /party/ca/customers/{customerId}/billPayments/registrations | UB.PAYER.ACCT,CAEBPS.API.CREATE.VENDOR.1.0.0 | createCaBillRegistration | Register the given customer for bill payment process such as paying utility bills and recurring bill payments |
| party | PUT | /party/ca/customers/{customerId}/billPayments/payees/registrations | UB.PAYER.ACCT,CAEBPS.API.ADD.VENDOR.1.0.0 | addCaBillPayeeRegistration | Register the payee details for given customer. This includes adding new set of payee and payee account number. | ||
| party | PUT | /party/ca/customers/{customerId}/billPayments/payees/cancellations | UB.PAYER.ACCT,CAEBPS.API.DELETE.VENDOR.1.0.0 | deleteCaBillPayeeCancellation | Cancel payee details for given Customer. This includes removing existing set of payee and payee account number | ||
| party | GET | /party/ca/customers/{customerId}/billPayments/payees | CAEBPS.API.MEMBER.VENDOR.LIST.1.0.0 | getCaCustomerBillPayee | Retrieves the bill payment payee details for the given customer with details such as payee, payee name and payee account number. | ||
| reference-ca-billPayments-service | API to retrieve the payee classification and payee details for bill payments process | reference | GET | /reference/ca/billPayments/payees/classifications | CAEBPS.API.VENDOR.CATEGORY.1.0.0 | getCaBillPayeeClassification | Retrieves the list of payee classification details for the given groupId and description. |
| reference | GET | /reference/ca/billPayments/payees | CAEBPS.API.VENDOR.LIST.1.0.0 | getCaBillPayee | Retrieves the list of payee details for the given payee, groupId and payeeName. |
In this topic