Make multiple payments to email addresses at once.

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

claimPayments

array of objects

claimPayments

paymentMethod

string

enum

This field specifies the payment method for the current payout. Possible values are 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.

Allowed:

paymentMethodCurrency

string

enum

This field specifies currency to be paid from. If FUNDING_BALANCE is specified as paymentMethod, then this field is required.

name

string

Name of the batch.

description

string

Description of the batch.

clientBatchReference

string

Reference of the batch. This field is an optional reference to enrich the batch data for internal tracking.

Responses

404

Server Error

200Success

400Error

401Authentication Error