In This Section
In the Internal Contacts API section of the borderless™ documentation you will find:
- Definitions for a borderless™ Contact and Internal Contact
- How to Add Internal Contacts using the borderless™ API
- How to Manage Internal Contacts using the Internal Contact API
Definitions
| Term | Definition |
|---|---|
| Contact | A borderless™ Contact is a payment recipient. A Contact can be a borderless™ user or a non-borderless™ user. Every Contact has a unique borderless™ @handle. To learn more about @handles please visit @Handle Overview. |
| Internal Contact | A borderless™ Internal Contact is a Contact that is a borderless™ user and has a borderless™ Account of their own. Recipients may become a borderless™ user by creating a borderless™ Account by signing up HERE. |
Adding Internal Contacts via API
Use the borderless™ Internal Contacts API to add Internal Contacts via an HTTP POST request. Follow these steps to start adding Internal Contacts via API.
Step 1: Create a borderless™ Account and Get Authenticated
For more information on getting started please visit Getting Started or create a borderless™ Business Account by Creating a borderless™ Account Here.
Step 2: Collect borderless™ @handle (ex: "@borderless")
Collect the unique borderless™ @handle directly from your desired recipient.
Pro Tip
@handles may be collected as part of a profile creation on your platform
For resources on having users sign up to borderless™ and create their own @handles, please reach out to your borderless™ Account Manager or a borderless™ Representative. To learn more about borderless™ @handles, please visit @Handle Overview.
Step 3: Pay Contact - borderless™ Automatically Adds Contacts
The borderless™ system will automatically add Internal Contacts as a Contact on your borderless™ Account when they are a new recipient and its their first payment. You do not need to add Internal Contacts prior to making payments to them. Just execute a payment to a borderless™ user using their own borderless™ @handle even if they are not already a Contact on your borderless™ Account and the borderless™ system will automatically add them. If you wish to add them as a Contact first, please refer to the section below Adding Internal Contacts via Dashboard (No Code).
Adding Internal Contacts via Dashboard (No Code)
Follow these steps to start adding Internal Contacts via the borderless™ Dashboard.
Step 1: Create a borderless™ Account and Get Authenticated
For more information on getting started please visit Getting Started or create a borderless™ Business Account by Creating a borderless™ Account Here.
Step 2: Collect borderless™ @handle (ex: "@borderless")
Collect the unique borderless™ @handle directly from your desired recipient.
Pro Tip
@handles may be collected as part of a profile creation on your platform
For resources on having users sign up to borderless™ and create their own @handles, please reach out to your borderless™ Account Manager or a borderless™ Representative. To learn more about borderless™ @handles, please visit @Handle Overview.
Step 3: Add Contact
In your borderless™ Dashboard:
- Navigate to the Contacts page and click "Add Contact" in the top right corner
- Use the Quick Search option and enter your recipient's @handle
- Select the Contact Card and click "Add Contact" to add them to your borderless™ Account.
Managing Internal Contacts
Follow these steps to manage your Internal Contacts.
Step 1: Add Internal Contacts
Make sure you have created a borderless™ Account, have been authenticated, and that you've added Internal Contacts via the borderless™ Dashboard. For more information on getting started please visit Getting Started or create a borderless™ Business Account by Creating a borderless™ Account Here.
Step 2: Retrieve Internal Contact Information
Use the /contacts/contactInformation endpoint to retrieve the Internal Contact's details such as:
- Display Name
- Client Internal Reference
Step 3: Edit Internal Contact Information
The only field you may update for an Internal Contact is the Client Internal Reference field. You can use the /contacts/updateContactInformation endpoint to update this field. A detailed guide to using this endpoint can be found here.