v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

network

Send connection request to a vendor

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

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

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

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

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

post/v3/network/invitation/vendor/{vendorId}

Path parameters

vendorIdstring required

BILL-generated ID of the vendor record in your organization. The value begins with 009.

Example:{{vendor_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}

devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Request body

networkIdstring required

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.

networkType'BILL' | 'RPPS' required

Network type.

Select BILL for BILL Network
Select RPPS for verified national vendor network

Example request

{
  "networkId": "{{network_id}}",
  "networkType": "BILL"
}

Response

Send connection request to a vendor response