LogoLogo
  • GENERAL
    • Introduction
    • Overview
    • Authentification
    • ENUM description
  • ACQUIRING
    • Customer wallets
    • Invoices
    • Onramp
  • EXCHANGE
    • Crypto exchange
  • PAYOUTS
    • Single Payout
    • Mass Payout
  • WEBHOOKS
    • Overview
    • Types of events
    • Webhook payload
    • Webhook sign check
  • GUIDES
    • General questions
      • What is Calypso Pay?
      • Which blockchains and tokens we support?
    • Calypso UI guides and questions
      • Introduction to Calypso Pay
      • Sandbox mode and limits
      • General
        • How to create new API key
        • How to create an additional account
        • How to add a new asset to account
        • How to add funds to your wallet
        • Protect your withdrawals with additional signatures
        • How to change your top-up address
        • How to use address book
        • How to set up auto currency conversion
        • How to transfer money within Calypso pay
        • Create a webhook
      • Accept Payments via UI
        • How to create an invoice via UI
        • Accept Payments FAQ
      • Make Payments via UI
        • How to create a single payout via UI
        • How to create mass payout via UI
        • Make Payments FAQ
      • Make Exchanges via UI
        • How to exchange one crypto asset to the other
      • Reports
        • How to get reports
        • Report contents description
    • Integration guides and questions
      • Get started with API
      • Use Customer purse via API
        • How create a customer
        • How to get a purse
        • How to get a transaction data
      • Accept Payments via API
        • How to create a Limited Invoice via API
        • How to create a Limited Fiat Invoice via API
        • How to create an Unlimited Invoice via API
        • How to manage interventions via API
        • How to embed invoice data to your payment page
      • Payment widget
        • How to create a limited fiat payment widget via API
        • How to create unlimited payment widget
        • How to embed a payment widget on a web page
      • Make Exchange via API
        • How to create a exchange
        • Get balance information via API
      • Make Payments via API
        • Get balance information via API
        • How to create a single payout via API
        • How to create a mass payout via API
  • API REFERENCE
    • Report API
    • Settlement Payout API
    • Webhook API
    • Payout API
    • Exchange API
    • Fiat API
    • User API
    • Rate API
    • Settlement Wallet API
    • Fiat withdrawal API
    • Account API
    • Currency API
    • Invoice API
    • Settlement Report API
    • Crypto to fiat API
    • Customer Purse API
    • Fiat deposit API
    • Payment Widget API
    • Models
Powered by GitBook
On this page
Export as PDF
  1. PAYOUTS

Mass Payout

PreviousSingle PayoutNextWEBHOOKS

Last updated 3 days ago

What are Mass Payouts?

Mass Payout is a method of paying up to 10,000 recipients simultaneously. Since mass payouts are submitted online, they are processed instantly which helps organizations to save time, money and resources.

How does it work?

The principle of Mass Payout is based on the use of the API:

  • First, the company sends a request for a balance to check if funds are available.

  • Next, you need to get the network commission coefficient. This value is required to create a request for Mass Payout.

  • Next, the company sends a request to Calypso Payout API to conduct a Mass Payout.

  • Next, Calypso handles a request.

  • Next, Calypso verifies if there are enough funds on the balance.

  • Next, the funds are sent to the recipients.

The Calypso Payout API is great for merchants needing to automate sending payments in real time. The company provides the ability to simultaneously make up to 10,000 payments.

Mass payouts are perfect for sending salaries to subordinates, payouts to partners or e-commerce marketplaces.

How to implement this via API?

Below is an example of creating Mass Payout from the client’s site or application.

Names of requests on the scheme indicate certain payment API methods.

Mass payout statuses

ENUM value
Description

CREATION_IN_PROGRESS

Payout started creation

PENDING_CONFIRMATION

A payout is created via UI and is awaiting confirmation from other process participants.

CONFIRMED

• A payout is created via UI and confirmed by other process participants. • A payout created via API is automatically created with this status.

IN_PROGRESS

• Transaction for a payout is created and is awaiting to be sent to the network. •Transaction for a payout is sent to the network to be sent to a block and is awaiting confirmation from nodes.

COMPLETED

Funds are successfully credited to destination wallet.

FAILED

An error occurred when sending funds. There can be many reasons of the error. You may follow these remediation steps: 1. Wait a while and create a new similar payout. 2. Contact our technical support.

CANCELED

A payout has been canceled by merchant.

Limits

Currently, there is a limit for quantity of transactions in one mass payout:

  • 1000 transactions for ETH and tokens ERC-20;

  • 100 transactions for other currencies.