Payouts API Experience

In This Section

The Payouts API allows you to programmatically make payments to over 120+ countries in seconds. In the Payouts API section of the borderless™ documentation you will find:

• Definitions for Contacts, Email, POP Codes, Amount, BeneCountry, Payer Accepted Fees, and Description
• How to Make Payments and Make Claim Payments via the Payouts API
• Notifications
• Helpful Tips & Tools

Definitions

Term	Definition	Required Field
Contact	A borderless™ Contact is a payment recipient. A Contact can be a borderless™ user or a non-borderless™ user. To learn more about Contacts please visit the Contacts API Experience page. Every Contact has a unique borderless™ @handle. To learn more about @handles please visit @Handle Overview.	Yes
Email	The Email indicates the email address of the recipient.	Yes
Amount	The Amount is a non-negative value of the payment to send to the recipient. The currency of the Amount will always be that of your preferred payment method or funding balance.	Yes
BeneCountry	The BeneCountry is the two letter country code identifying the country of beneficiary. You can retrieve borderless™ supported countries via Reference Section of the API .	Optional
POPCode	A POP Code is a Purpose of Payment code comprised of 4 letters and is used to identify why the payment is being made. You may View all purpose-of-payment codes and their descriptions.	Yes
Description	The Description has a maximum length of 60 alphanumeric characters (including spaces) that can be used to enrich payment data. The Description is shown to the recipient when the transaction completes either via email or on the borderless™ Dashboard. This field is very useful for internal reconciliation and accounting.	Yes
Payer Accepted Fees	The Payer Accepted Fees is a true/false Boolean which refers to who pays the transaction fee. For the payor to defer the fee to the recipient, indicate "False" (the recipient will receive the Amount minus the transaction fee). For the payor to pay the fee, indicate "True" (the recipient will receive the full Amount).	Optional If left blank, the default is that the recipient pays the fee. When paying External Contacts (non-borderless™ users) the payor always pays the fee (even if indicated otherwise).

Making Payments

Follow these simple steps to start making payments to over 120 countries with just a few lines of code!

Step 1: Create Payment Request Body

For each payment gather the Payment Request Body comprised of the following information:

Field	Required?
@handle	Yes
Amount	Yes
POP Code	Yes
Description	Yes
Payer Accepted Fees	Optional

❗️

IMPORTANT

THE FIRST FOUR FIELDS ARE REQUIRED FOR A PAYMENT API CALL TO SUCCEED. For more information on each field please visit the Definitions section, above.

Step 2: Make Payment

Call the /mass-payout endpoint with the Payment Request Body.

Making Claim Payments

Follow these simple steps to start making claim payments to 120+ countries with just a few lines of code!

Step 1: Create Claim Payment Request Body

For each claim payment gather the Claim Payment Request Body comprised of the following information:

Field	Required?
Email	Yes
Amount	Yes
POP Code	Yes
Description	Yes
BeneCountry	Optional
Payer Accepted Fees	Optional

❗️

IMPORTANT

THE FIRST FOUR FIELDS ARE REQUIRED FOR A CLAIM PAYMENT API CALL TO SUCCEED. For more information on each field please visit the Definitions section, above.

Step 2: Make Claim Payment

Call the /mass-claim-payouts endpoint with the Claim Payment Request Body.

Notifications

Once a payout is successful, borderless™ immediately notifies the recipient via email. You will not be notified for every single payout via email if you are subscribed to Webhooks. To be notified for your mass payout requests, you can use Webhook notifications to keep up-to-date on your mass payouts API requests. You will also receive Webhook notifications for incoming payments. Refer to the Webhooks section for more information on enabling Webhooks..

👍

Tips & Tools

• API Access

  To access the borderless™ API you need to sign up to an API plan. To sign-up for a plan and get access to the borderless™ API, follow the step by step guide on the Getting Started page.

• Authentication

  All API Calls must be authenticated. For information on Authenticating API calls please visit the Authentication page.

• Testing in Sandbox

  Test the Payouts API in our Sandbox environment by creating Sandbox users. Make sure to use real bank routing codes and SWIFT codes as borderless™ validates that data.