BPAY Customer Reference Numbers

BPAY Customer Reference Numbers are created by creating a customer and including the query parameter with=bpayref to the URL.

POST: /customers?with=bpayref
{
  "Name":”Bob Smith”,
  “Email”:”bob@yahoo.com”,
  “IsConsumer”:true,
  “firstname”:”Bob” (Only required if IsConsumer is true)
}

 

To create a BPAY Customer Reference Number for an existing customer who does not already have a number this can be done by either including the query parameter with=bpayref during an update:

PUT: /customers/{code}?with=bpayref
{
  “Email”:”new_bob@yahoo.com”,
}

 

Or simply calling the createbpayref helper without any body/content:

PUT: /customers/{code}/createbpayref

 

See customers for more information on creating and maintaining customers.

Have more questions? Submit a request

Comments