API Reference
Log In
API Reference

Adding Contacts

In This Section

The Contacts API allows you to customize the Contacts experience on your platform, including adding and managing Contacts. In the Adding Contacts section of the borderless™ API you will find:

  • Definitions for Contact, Internal Contact, and External Contact.
  • How to Add Contacts

Definitions

TermDefinition
ContactA 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 ContactA borderless™ Internal Contact is a Contact that is a borderless™ user and has a borderless™ Account of their own.
External ContactA borderless™ External Contact is a Contact that is NOT a borderless™ user and does NOT have a borderless™ Account of their own.

Adding Contacts

Use one of these 3 Methods to add Contacts to your borderless™ Account:

  1. External Contacts API
  2. borderless™ Link™
  3. Contact Registration

Method 1: External Contacts API

Add Contacts programmatically through the borderless™ External Contacts API. This Method is great for companies that already collect recipient information and banking data.

  • Contact Type: External Contact (Contacts do NOT need a borderless™ Account)
  • How it Works:
    • Collect all required personal and banking data from the intended payment recipient.
    • Add the recipient as a Contact through the External Contacts API.
    • borderless™ will create a unique and auto-generated @handle for payouts (example: "@^28291AS"). To learn more about borderless™ @handles please visit @Handle Overview.
    • The contact is created. Save the @handle in your system to execute payments.
  • Resources: to learn more about adding External Contacts through the External Contacts API please visit External Contact API - Getting Started.

Method 2: borderless™ Link™

Use borderless™ Link™ to add a Contact as an embedded experience directly on your platform. This is a great option for enterprises and marketplaces. You can customize the widget to fit the look and feel of your platform.

  • Contact Type: External Contacts (Contacts do NOT need a borderless™ Account)
  • How it Works:
    • Integrate the borderless™ Link™ widget on your platform.
    • Recipients follow the instructions on the borderless™ Link™ widget to add their required personal and banking data. borderless™ Link™ automatically configures and collects the required data for all borderless™ supported countries.
    • borderless™ will create a unique and auto-generated @handle for payouts (example: "@^28291AS"). To learn more about borderless™ @handles please visit @Handle Overview.
    • The contact is created. Save the @handle in your system to execute payments.
  • Resources: to learn more about borderless™ Link™, please visit the Widget page.

Method 3: Contact Registration (Fastest Integration Method)

Use Contact Registration to add Internal Contacts directly through borderless™. If a recipient does not have a borderless™ Account you can ask them to sign up to borderless™ first.

  • Contact Type: Internal Contacts (Contacts DO need a borderless™ Account) Contacts that do not already have a borderless™ Account may create one by signing up to borderless™.
  • How it Works:
    • Collect the Contact's unique borderless™ @handle. To learn more about borderless™ @handles please visit @Handle Overview.
    • That's it! Pay any borderless™ Internal Contact by using their borderless™ @handle. If a recipient is not already a Contact on your Account, borderless™ will automatically add them if they are a new recipient and it's their first payment.
  • Resources: Please reach out to your borderless™ Account Manager or a borderless™ Representative to be provided with resources such as email templates and blog posts that will guide you through Contact Registration.

👍

Pro Tip

  • With this Method, borderless™ will automatically collect the required data for Know Your Customer (KYC) to meet compliance standards.

  • If you would like to add the recipient prior to making payments, you can do so from your borderless™ dashboard.

  • Navigate to the Contacts Page on the borderless™ Dashboard and click the "Add Contact" button 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

🚧

Authentication

Remember that all borderless™ API calls must be Authenticated. To learn more about Authentication, please visit the Authentication page.