Initiate a bulk payout

post

https://api.test.bictorys.com/pay/v1/batch-payout

Use this endpoint to send a bulk payout. After payment is completed merchant webhook is called to notify status
of each transation. For security reason, we do not allow merchant to generate permission for this end point, please contact us
in order to get a secret key for testing bulk payout on sandbox.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

payment_type

string

enum

required

The type parameter allows to select the payout service provider. E.g mtn_money, orange_money, wave_money, move_money

country_code

string

enum

required

Country Code of the beneficiaries

Allowed:

Body Params

Headers

X-Batch-Reference

string

Any reference you want to add to the transaction. This reference will be returned in the webhook payload.

idempotency-key

uuid

The value of this query parameter guarantees the idempotence of the operation.
Several HTTP requests with the same request identified value are interpreted as the same request to be executed only once.
This value may be generated randomly by the caller, but the same value should be used in case of retry.

X-Amzn-Trace-Id

string

The parameter Identifies this HTTP request across all services. It helps to diagnostic request errors. The parameter is added automatically by the API gateway

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

The caller is unauthenticated

403

Access rights not sufficient

202The batch payout transaction is initiated.

400Bad Request

500Internal Server Error.