post https://prod.api.getborderless.com/mass-claim-payouts
Introduction
This endpoint allows you to pay multiple people at once using only their email addresses. By integrating this API endpoint into your own system you will have the flexibility and control to seamlessly pay email addresses in any supported borderless™ country. Below you will find the requirements for sending this POST request.
Data Requirements
Provide the following data requirements when sending a POST request to the Mass Claim Payout endpoint.
Additional Header parameter:
| Parameter | Required? | Description | Type |
|---|---|---|---|
| Client-Id | No | Unique identifier of Child Account (required only for Partner). See Authentication Page to learn more. | String |
The body of the request should contain a key of “claimsPayments” with the requested claim payments contained in an array. Each payment must contain the following information:
| Parameter | Required? | Description | Type |
|---|---|---|---|
| claimPayments[0].email | Yes | The email address of the recipient. | String |
| claimPayments[0].beneCountry | No | The two letter country code identifying the country of recipient. | String |
| claimPayments[0].amount | Yes | Non-negative amount to send to the recipient. | Number |
| claimPayments[0].description | Yes | Description of what the payment being sent is for. | String |
| claimPayments[0].POPCode | Yes | Purpose Of Payment (known as “POP”) code that denotes the reason for the payment required for compliance. You can retrieve those via Reference Section of the API. | String |
| claimPayments[0].payerAcceptedFees | No | 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. | Boolean |
| claimPayments[0].clientPaymentRef | No | 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. | String |
| paymentMethod | No | This field specifies the payment method for the current payout. Possible values are BANK_ACCOUNT | FUNDING_BALANCE. Please Note: This field will only take effect if in your submitted claim payout there will be an email that is already registered and payment will be made. Otherwise, at the time of the recipient claiming the payment you will be deducted from your preferred payment method under your account. | String |
| paymentMethodCurrency | No | This field specifies currency to be paid from. If FUNDING_BALANCE is specified as paymentMethod, then this field is required. | String |