v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB

BPay Accounts

Create BPay Account

Create a BPay Account to be used as a Disbursement destination.

post/bpay_accounts

Request body

user_idstring required

User ID

account_namestring required

Name assigned by the platform/marketplace to identify the account (similar to a nickname)

biller_codeinteger required

The Biller Code for the biller that will receive the payment. The Biller Code must be a numeric value with 3 to 10 digits.

bpay_crnstring required

Customer reference number (crn) to be used for this bpay account. The CRN must contain between 2 and 20 digits.

Example request

{
  "user_id": "725cc8c0-759b-0138-5d6d-0a58a9feac05",
  "account_name": "My Water Bill Company",
  "bpay_crn": "987654321"
}

Response

Example response

{
  "bpay_accounts": {
    "active": true,
    "id": "46deb476-c1a6-41eb-8eb7-26a695bbe5bc",
    "currency": "AUD",
    "verification_status": "not_verified",
    "bpay_details": {
      "account_name": "My biller 123",
      "biller_code": 123456,
      "biller_name": "ABC Water",
      "crn": 987654321
    }
  }
}