API Reference
System Status

Send connection request to a customer

post
https://gateway.stage.bill.com/connect/v3/network/invitation/customer/

Send a connection request to a customer organization in the BILL Network. BILL automatically connects the customer organization with the customer record in your BILL organization.

If the customer organization has auto-connections disabled, BILL sends an invitation email to the customer email address. When the customer accepts the invitation, BILL connects the customer organization with the customer record in your BILL organization.

If the customer does not respond, you can delete the connection request (with DELETE /v3/network/invitation/customer/{customerId}) before sending a new connection request.

Note: If the customer does not respond to a connection request for 60 days, the request expires.

See BILL Network in the Guides section for more information, sample requests, and responses.

Path Params
string
required
length ≥ 1

BILL-generated ID of the customer record in your organization. The value begins with 0cu.

Body Params
string
required
length ≥ 1

Payment Network ID (PNI) of the organization you want to connect with. For a verified national vendor, the value begins with 0rv. BILL uses the PNI to send and receive electronic payments.

You can retrieve networkId from your GET /v3/network search result.

string
enum
required

Network type.

  • Select BILL for BILL Network
  • Select RPPS for verified national vendor network
Allowed:
rppsInformation
object | null

Additional information required if networkType is RPPS

Headers
string | null

API session ID generated with /v3/login

string | null

Developer key generated with your BILL developer account

Responses
200

Send connection request to a customer response

Updated 6 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago