Tableau de bordAPI ReferenceObtenir une clé API
API Reference

Initiate a payout transaction

post
https://api.test.bictorys.com/pay/v1/payouts

Use this endpoint to send money to a mobile money.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

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

Body Params
double
required

This is the amount to be sent to the customer.

string
required

The currency to use.

string

The iSO country code of the phone number used for payout. This field is mandatory except for card payment

uuid

Optional. Unique Id of the customer. If provided, customer object below is ignored.

customerObject
object

Optional. Customer information. If you have not created the customer representation in the system, you can provided using this object.

string
enum

The type can be transfer or refund

Allowed:
string

An optional message with a payment reason that is shown to customers in the payment receipt

string

reference passed by client in the request

merchant
object
Headers
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.

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

Updated 11 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 11 months ago