BPAY
| Requirement | Rules |
|---|---|
| BPAY LOGO / App design principles. | When using BPAY Logo design in the App it needs to meet design specifications set out by BPAY. Design guidelines can be found on the BPAY Publicly accessible site https://bpay.com.au/commssupport#brand-logos |
| Create Biller | Biller Code is mandatory |
| Create Biller | Reference (CRN) is mandatory |
| Create Biller | Nickname is mandatory |
| Create Biller - Biller Code | Numeric only |
| Create Biller - Biller Code | Minimum of 3 numbers |
| Create Biller - Biller Code | Maximum of 10 numbers |
| Create Biller - Biller Code | Can have leading zeros |
| Create Biller - Biller Code | Provide error if biller code doesn't match active biller |
| Create Biller - Biller Code | A customer can provide the same Biller code more than once however cannot assign the same reference or nickname as other saved billers |
| Create Biller - Reference | Numeric only |
| Create Biller - Reference | Minimum of 2 numbers (additional BPAY API validations apply please use testing scenarios below as examples) |
| Create Biller - Reference | Maximum of 20 numbers (additional BPAY API validations apply please use testing scenarios below as examples) |
| Create Biller - Reference | Can have leading zeros |
| Create Biller - Reference | Provide error that start number (s) may be specified by biller |
| Create Biller - Reference | Provide error that a check digit logic may apply |
| Create Biller - Reference | Provide error that other specific rules may apply |
| Create Biller - Nickname | Up to 20 characters in length |
| Create Biller - Nickname | Must not match an existing record with same nickname |
| Create Biller validation | If the request is validated the associated details supplied in the response should be captured and held against the details provided by the customer, including: Short name Long name Biller ANZSIC code |
| Retrieve BPAY Biller Logo | We use Look Who's Charging to enrich the logo in the App. We can reliably use the SearchAPI to lookup a merchant by the bpay_biller_code |
| Edit Biller | Customer can edit the Reference and Nickname only |
| Edit Biller | Customer should not be able to edit the Biller Code or Biller Name |
| Make transaction to Biller | Amount is mandatory |
| Make transaction to Biller | Amount limits apply |
| Make transaction to Biller | Amount cannot be a zero |
| Make transaction to Biller | Amount must not be more than the available balance in the account |
| Make transaction to Biller | The Amount must be exactly the expected amount due |
| Make transaction to Biller | Call to Validate BPAY Payment may return validation against specific billers having minimum, maximum or specific values they will allow |
| Make transaction to Biller | Description is an optional field purely for record in mambu / App |
| Make transaction to Biller | Choosing a payment category is also optional, if one is not chosen then |
| Make transaction to Biller - successful submission | Hay needs to generate a 10 digit Receipt Number |
| Send submission to Cuscal to make payment with BPAY | There are 2 cutoff windows Hay will use for submission of Payment files each business day of 1pm and 5pm AEST/AEDT - Non business days will result in the payment being sent the following business day |
| Send submission to Cuscal to make payment with BPAY | There is no restriction of the number of transactions that can be instructed |
| Rejected transaction(s) from BPAY | Payment Files will be returned at approximately 2:45pm and 6:15pm AEST/AEDT each business day for any PDF files submitted in the period prior to the associated cutoff. This will instruct Hay of successful transactions and any unsuccessful transactions. |
| Rejected transaction(s) from BPAY | Record Rejections If the rejection file contains any error codes against a transaction within the range of 100 - 199. This means there has been an issue with the transaction itself which may or may not be related to customer input. Due to the upfront validations this should be a rare occurrence. |
| Delete Biller | Deleting a Biller should remove biller details from appearing on the list of saved billers |
| Delete Biller | Transactions and details should be archived |
| Delete Biller | Transactions and biller should still appear on transaction history list |
| Delete Biller | If the same details are used to create a new biller, the deleted biller record should be reopened |
| Notifications | |
| Failure message for a BPAY Payment being rejected back from Biller/BPAY | BPAY payment to was unsuccessful. Contact the Hay Help team for further assistance. <Transaction amount ($x.xx)> has be returned to your account. Balance: <available balance ($x.xx)> |
| Manual Adjustments - Triggered in a scenario when the Ops triggered posting on the manual_adjustment channel is used | View transaction details for further information. <Transaction amount ($x.xx)> at <time (hh:mm am/pm)> on <date (dd/mm/yyyy)>. Balance: <available balance ($x.xx)> |
| Operations | |
| Manual Adjustments | Triggered in a scenario when the Ops triggered posting on the manual_adjustment channel is used |
| Review all BPAY transactions | Transactions are passed through Appian and ARIC for reviews |
| BPAY Limit | A specific BPAY limit will be set to monitor daily BPAY transactions. The amount a user can send is dependent on the clients instructions. If the daily limit is breached e.g. The BPAY limit is $100 and the user tries to send a BPAY transaction of $101 Hay will send the client a rejection notice of bpayTransfer": { "outcome": "LIMIT_BREACH", "detailedOutcome": "REFUSED_DAILY_BPAY_LIMIT_BREACHED", "transactionId": "Example transaction ID" |
| Testing Scenarios | |
| Active Biller Code 7773 | Industry Code - 1113 - Cured Meat and Smallgoods Manufacturing Long Name - APIBCD SERVICES AV1 Valid CRN Lengths - 8 Variable CRN Indicator - N Valid CRNs - 74177361 / 23915754 / 48165831 / 12914552 / 14525281 Check digit rule - MOD10V01 Payment Methods Accepted - Debit Lower Limit - $20.00 Upper Limit - $50,000.00 |
| Active Biller Code 93849 | Industry Code - 6931 - Legal Services Long Name - APIBCD SERVICES AV8 Valid CRN Lengths - 7, 9, 10 Variable CRN Indicator - N Valid CRNs - 7231016 Check digit rule - MOD11V09 Payment Methods Accepted - Debit Lower Limit - $10.00 Upper Limit - $20,000 |
| Active Biller Code 93880 | Industry Code - 94540 - Religious Services Long Name - APIBCD SERVICES AV12 Valid CRN Lengths - 12 Variable CRN Indicator - N Valid CRNs - 271682361214 / 781133471230 / 351118227898 / 859167654564 / 637933921214 Check digit rule - MOD10V01 Payment Methods - Debit Lower Limit - $20.00 Upper Limit - $4000.00 |
| Active Biller Code 600015 | Industry Code - 3501 - Car Wholesaling Long Name - API2 SERVICES ICRN AMT Valid CRN Lengths - 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 Variable CRN Indicator - Y Valid CRNs - 0808812345678260 Check digit rule - ICRNAMT Payment Methods - Debit Amount: Exact only - $104.00 |
| Deactivated Biller Code 1016 | Industry Code - 3501 - Car Wholesaling Long Name - BILLER LONG NAME 505529 Valid CRN Lengths - 10 Variable CRN Indicator - N Valid CRN - 42741454 Check digit rule - MOD10V01 Payment Methods Accepted - NONE (Inactive Biller) Amount - N/A |
| Rejection Codes | |
| 101 | BPAY Instruction type not valid |
| 102 | BPAY Transaction type not valid |
| 103 | Payer Institution Code not valid |
| 104 | Country of payment is invalid |
| 105 | State of payment is invalid |
| 106 | Currency Code of payment is invalid |
| 107 | Biller Code is invalid |
| 108 | Service Code is invalid |
| 109 | Payment Method is invalid |
| 110 | Biller/Service Code is not current on the Biller File |
| 111 | Payment Method not allowed for this Biller/Service Code |
| 112 | Customer Reference Number not present |
| 113 | Customer Reference Number is invalid |
| 114 | Entry Method is invalid |
| 115 | Amount is not numeric |
| 116 | Amount less than minimum accepted by Biller |
| 117 | Transaction Reference Number is not present |
| 118 | Transaction Reference Number format incorrect |
| 119 | Transaction Reference Number is not unique |
| 120 | Original Reference Number is not present (Error Correction/reversal) |
| 121 | Original Reference Number format incorrect (Error Correction/reversal) |
| 122 | Date Payment Accepted is invalid |
| 123 | Time Payment Accepted is invalid |
| 124 | Additional Reference Number is required but is not present |
| 125 | Additional Reference Number is invalid |
| 126 | Discount Method is invalid |
| 127 | Discount Reference is required but is not present |
| 128 | Settlement Date is invalid |
| 129 | Error Correction Reason must be present for an Error Correction |
| 130 | Error Correction Reason must be zero if not an Error Correction |
| 131 | Error Correction Reason is invalid |
| 132 | Record Type is invalid |
| 133 | Original Reference Number is not blank (Payment) |
| 134 | Additional Reference Number present, but should not be |
| 135 | Discount Reference present, but should not be |
| 136 | Error Correction not allowed for this Biller/Service Code |
| 137 | Account Number invalid for Payment Method |
| 138 | Payer Institution not operative |
| 139 | Biller Institution not operative |
| 140 | Amount greater than maximum accepted by Biller |
| 141 | Amount must be greater than Zero |
| 200 | Submitting institution is not authorised to submit on behalf of Payer Institution |
| 201 | Transaction Reference Number does not contain valid Payer Institution Code |
| 202 | Transaction Reference Number must contain a Date of Payment between current date less one year and current date plus one business day |
| 203 | Transaction Reference Number must contain a Date of Payment equal to or greater than datePaymentAccepted field value |
| 204 | Transaction Reference Number has been previously used |
| 205 | Original Reference Number does not contain valid Payer Institution Code |
| 206 | Original Reference Number must contain a Date of Payment between current date less one year and current date plus one business day |
| 207 | BPAY Settlement Date must be between current date less one year and current date plus one business day |
| 208 | BPAY Settlement Date must be equal to or greater than the Payment Date included in Transaction Reference Number |
| 209 | Date of Payment must be between current date less one year and current date plus one business day |
| 210 | CRN is invalid - Incorrect Check Digit |
| 211 | CRN is invalid - Incorrect length compared to mask |
| 212 | CRN is invalid - Incorrect fixed digits compared to mask |
| 213 | CRN is invalid - Validation rule failed |
| 214 | CRN is invalid - Value of numeric portion must not be zero |
| 215 | Payment Amount is incorrect (iCRN) |
| 216 | Payment Date is incorrect (iCRN) |
| 901 | {field name} is required |
| 902 | {field name} format is invalid |