Authentication

The authentication portion of the API call request XML is in the <authenticate> node. For example:

<?xml version="1.0"?>
<request>
  <response>
    <type>xml</type>
  </response>
  <biller>
    <authenticate>
      <id>sample_id</id>
      <password>sample_password</password>
    </authenticate>
    <customerlist />
  </biller>
</request>

In this case Account Authentication for a biller is being used. There are two authentication methods that can be used: Account Authentication and App Authentication.

Account Authentication

The first authentication method is to use the user name and password of the account you are accessing through the API. This works for billers, resellers, and developers. For billers the user name will be their biller number. For this method format your request XML like this:

    <authenticate>
      <id>sample_id</id>
      <password>sample_password</password>
    </authenticate>

App Authentication

The second authentication method is to use app authentication. To use app authentication you must have a developer account and create an profile in the Developer Control Panel. The account you are trying to access must also authorize your app to have API access. Once this is accomplished you can use the following XML format for sending your API request:

    <authenticate>
      <appid>sample_app_id</appid>
      <appkey>sample_app_key</appkey>
      <billerid>sample_biller_id</billerid>
    </authenticate>