Regionalized Solutions
R24 AMR | Min(s) read
APIs
Please find below the API details for the BPAY (Bill Payments) module.
The API will only be useable if the module has been licensed by the client.
In the URL, vx.x.x denotes the swagger version that client has licensed.
| Endpoint | Method | URL | Description |
|---|---|---|---|
| createStandingOrder | POST | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/order/au/standingOrders/{standingOrderId}/bills | Creates a standing order for bill payment such as utility bills. |
| updateStandingOrder | PUT | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/order/au/standingOrders/{standingOrderId}/bills | Updates a standing order for bill payment such as utility bills. |
| getStandingOrder | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/order/au/standingOrders/{standingOrderId}/bills | Retrieve the details of a standing order pertaining to bill payment such as utility bills. |
| initiateBillerRequest | POST | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/party/au/billers/{billerCode}/billerRequests/initiations | Initiation of biller registration request with details like biller name. |
| updateBillerDetails | POST | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/party/au/billers/{billerCode}/billerRequests/amendments | Initiate request to update biller information such as biller name. |
| initiateBillerTransferRequest | POST | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/party/au/billers/{billerCode}/billerRequests/transfers | Initiate request to transfer biller between financial institutions changing biller institution code. |
| initiateBillerClosureRequest | POST | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/party/au/billers/{billerCode}/billerRequests/closures | Initiate request to close the biller with the closure reason. |
| initiateBillerRequestCancellation | POST | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/party/au/billers/{billerCode}/billerRequests/cancellations | Initiate request to cancel other biller request initiated earlier by changing the status as 'Request deleted'. |
| approveBillerRequest | PUT | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/party/au/billers/{billerCode}/billerRequests/approvals | Approve biller request with details like biller name. |
| getBillerRequestDetails | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/party/au/billers/{billerCode}/billerRequests | Retrieves the details of the biller request such as biller code. |
| getBillerDetails | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/party/au/billers/{billerCode} | Retrieves the details of active billers with the last change date and activation date information. |
| getValidationRuleNames | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/reference/au/lookups/validationRuleNames | Retrieves the list of BPAY validation rule names for creating a Customer Reference Number (CRN). |
| getCheckDigitRuleNames | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/reference/au/lookups/checkDigitRuleNames | Retrieves the list of BPAY check digit rule names for creating a Customer Reference Number (CRN). |
In this topic