Submit Single Disbursement

post

https://prod.api.getborderless.com/payments/claim

Introduction

This endpoint allows you to pay person using only their email addresses or phone number. By integrating this API endpoint into your own system you will have the flexibility and control to seamlessly pay email addresses or phone numbers in any supported borderless™ country. Below you will find the requirements for sending this POST request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

The email address of the recipient. Either email or phoneNumber is required.

phoneNumber

string

The phone number of the recipient without country code. Either email or phoneNumber is required.

beneCountry

string

enum

The two letter country code identifying the country of recipient.

amount

number

required

Non-negative amount to send to the recipient.

description

string

required

Description of what the payment being sent is for.

POPCode

string

required

Purpose Of Payment (known as “POP”) code that denotes the reason for the payment required for compliance.

payerAcceptedFees

boolean

This field indicates who pays the transaction fee. Please note that when paying external contacts (i.e contacts you have created), the payer always pays the fee even if indicated otherwise. If left blank, the default to borderless™ users is that the recipient pays the fee.

clientPaymentRef

string

This field is an optional reference to enrich the payment data for internal tracking or in order to quickly match payments between borderless and third party systems. This reference will be returned in the webhook of payment.

Headers

Client-Id

string

Unique identifier of Child Account (required only for Partner).

Responses

404

Server Error

200Success

400Error

401Authentication Error