API006 — Mass Pay API Implementation Guide

Last updated: October 7, 2026

1. Introduction

The Mass Pay API allows you to disburse funds to multiple recipients in a single HTTP request.

Key concepts:

  • Asynchronous processing — you submit a batch and receive a 202 Accepted immediately. Processing happens in the background.

  • Observability — status is tracked via polling (GET) or pushed via webhooks. You can check status through the API using GET endpoints or manually through the UI.

2. Authentication and base setup

  • Authentication: Bearer token (OAuth2 / API key), scoped to the issuer account.

  • Transport: TLS 1.2+ required.

  • Content-Type: application/json (UTF-8).

3. Creating a batch (the API call)

Endpoint

POST /API/v4/Fund/BatchTransfer

Request body schema

The request consists of a batch "envelope" containing an array of transaction items.

4. Checking batch and transaction status

Via API

Use these endpoints to poll for status:

  • GET /API/v4/Fund/BatchTransfer/{BatchID} — retrieve batch information

  • GET /API/v4/Fund/BatchTransfer/{BatchID}/Items/{TransactionID}?History=true — get transaction item history and status details

Via UI

To manually check transaction status and notification details:

  1. Go to Payments > Batches.

  2. Search for the Batch ID.

  3. Open the batch and locate the specific transaction item.

  4. Read the status and notes for details.

5. Responses

6. Status retrieval (GET)

7. Webhook integration

8. Common error codes