The BILL partner API endpoints require sessionId as a header value that is generated with API partner login (POST /v3/partner/login). We learned that API login as user (POST /v3/partner/login-as-user) endpoint is the only BILL partner endpoint where sessionId is required as a body parameter.

For consistency across the BILL partner API endpoints, we now require sessionId as a header value for the API login as user endpoint. See API login as user in the API reference for more information.

When you create a bulk payment with POST /v3/payments/bulk, the error response now includes details about the error at the individual bill level.

See Payments for more information.

As a BILL partner, you can now set a user role when you create a user (POST /v3/partner/users) or update a user (PATCH /v3/partner/users/{userId}).

You can set roleId as the BILL-generated ID of the user role you want to assign. You can get the list of available user roles with GET /v3/partner/roles. If you do not set roleId in your POST /v3/partner/users request, the default ADMINISTRATOR user role is assigned to the created user.

See Users for BILL partners for more information.

As a BILL partner, you can now get partner name information when you create an organization with POST /v3/partner/organizations. In the API response, partnerName is now available for providing information about the partner name.

Note: This field is available only when select BILL partners create an organization. Partner name is part of the information that BILL uses to identify partners.

See Organizations for BILL partners for more information.

When you create a bank account (POST /v3/funding-accounts/banks) in the production environment, you must complete bank account verification (POST /v3/funding-accounts/banks/{bankAccountId}/verify) before the account can be used for other BILL operations.

In the sandbox environment, you can now set depositAmount as 0.50 to complete bank account verification.

See Bank account setup (v3 API) for more information.

We have improved navigation between the Guides and API Reference sections. When you are reviewing the API Reference documentation for an endpoint, you now find links to the relevant Guides sections for more information, sample requests, and responses.

We have updated the webhooks events catalog to include event types for bank accounts and BILL risk verification. You can now set up subscriptions to receive notifications for these new events.

New events

Related documentation

bank-account.created bank-account.updated

Bank account notification payloads

risk-verification.updated

Risk verification notification payloads

See Get events catalog in the API reference for more information.

When you create a new webhook subscription with POST /v3/subscriptions, you now get a one-time securityKey as one of the generated values in the response. All event notifications sent to your notificationUrl are signed with the security key using the HMAC-SHA256 algorithm. The key is sent as the x-bill-sha-signature header value in the notification.

You can use the security key to verify all notifications sent to you. It is good practice to keep the security key for your subscription updated in a timely manner. Use POST /v3/subscriptions/{subscriptionId}/security_key to generate a new security key based on your desired frequency.

See Create a security key in the API reference for more information.

We have introduced PENDING as a new BILL risk verification decision status for your organization.

As a BILL partner, when you create an organization and then create a user for that organization, it is important that you initiate risk verification with POST /v3/risk-verifications. ​​In the API response, the BILL risk verification decision status can now have one of five values.

ValueDescription
REVIEWRisk verification is in progress
PENDINGRisk verification is in progress. BILL waiting for more information about vendors in the organization. BILL requests the vendor in question for more information.
HOLDRisk verification is complete. BILL has set the approval on hold. BILL requests the organization owner for more information.
APPROVERisk verification is complete. BILL has approved the organization for BILL AP and AR operations.
DECLINERisk verification is complete. BILL has declined the organization.

See Users for BILL partners for more information.