Biller API

info

N.B. The Biller API is for offline billers whereby BillPay will accept payment on behalf of the biller and then notify the biller of the payment. Our preference is to integrate with online billers such that a customer's payment is directly processed by the biller. If you are an online biller, please contact Paynow support to discuss integration options.

In order to use the Biller API, a user must be set up with a role of Biller Admin or Biller User. Please contact the system admin to have an appropriate user created for you.

Authentication

All API requests use HTTP basic authentication. Every HTTP request must have the Authorization header set.

The Authorization header is constructed as follows:

1. Combine username and password with a colon: username:password
2. Base64 encode the string: dXNlcm5hbWU6cGFzc3dvcmQ=
3. Prepend the method: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
4. Set the header: Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Example: For credentials Aladdin / OpenSesame:

Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

For more information, see Basic access authentication on Wikipedia.

Request Format

Each API request body may contain either:

1. Basic form post data

   MyVariable=MyValue

2. JSON

   { "MyVariable": "MyValue" }

3. XML

   <MyVariable>MyValue</MyVariable>