Create a payout

POST /v1/payouts/

Create a payout

cURL

curl --request POST \
  --url http://localhost/v1/payouts/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "recipient": {
    "msisdn": "<string>",
    "iban": "<string>",
    "address": "<string>",
    "fullName": "<string>",
    "customerId": "<string>",
    "bankName": "<string>",
    "bankId": "<string>",
    "accountNumber": "<string>"
  },
  "description": "<string>",
  "category": "<string>",
  "counterpartyId": "<string>",
  "paymentPin": "<string>",
  "totp": "<string>"
}
'

import requests

url = "http://localhost/v1/payouts/"

payload = {
    "amount": "<string>",
    "recipient": {
        "msisdn": "<string>",
        "iban": "<string>",
        "address": "<string>",
        "fullName": "<string>",
        "customerId": "<string>",
        "bankName": "<string>",
        "bankId": "<string>",
        "accountNumber": "<string>"
    },
    "description": "<string>",
    "category": "<string>",
    "counterpartyId": "<string>",
    "paymentPin": "<string>",
    "totp": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '<string>',
    recipient: {
      msisdn: '<string>',
      iban: '<string>',
      address: '<string>',
      fullName: '<string>',
      customerId: '<string>',
      bankName: '<string>',
      bankId: '<string>',
      accountNumber: '<string>'
    },
    description: '<string>',
    category: '<string>',
    counterpartyId: '<string>',
    paymentPin: '<string>',
    totp: '<string>'
  })
};

fetch('http://localhost/v1/payouts/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/v1/payouts/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => '<string>',
    'recipient' => [
        'msisdn' => '<string>',
        'iban' => '<string>',
        'address' => '<string>',
        'fullName' => '<string>',
        'customerId' => '<string>',
        'bankName' => '<string>',
        'bankId' => '<string>',
        'accountNumber' => '<string>'
    ],
    'description' => '<string>',
    'category' => '<string>',
    'counterpartyId' => '<string>',
    'paymentPin' => '<string>',
    'totp' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost/v1/payouts/"

	payload := strings.NewReader("{\n  \"amount\": \"<string>\",\n  \"recipient\": {\n    \"msisdn\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"address\": \"<string>\",\n    \"fullName\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"bankName\": \"<string>\",\n    \"bankId\": \"<string>\",\n    \"accountNumber\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"category\": \"<string>\",\n  \"counterpartyId\": \"<string>\",\n  \"paymentPin\": \"<string>\",\n  \"totp\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost/v1/payouts/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"<string>\",\n  \"recipient\": {\n    \"msisdn\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"address\": \"<string>\",\n    \"fullName\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"bankName\": \"<string>\",\n    \"bankId\": \"<string>\",\n    \"accountNumber\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"category\": \"<string>\",\n  \"counterpartyId\": \"<string>\",\n  \"paymentPin\": \"<string>\",\n  \"totp\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost/v1/payouts/")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"<string>\",\n  \"recipient\": {\n    \"msisdn\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"address\": \"<string>\",\n    \"fullName\": \"<string>\",\n    \"customerId\": \"<string>\",\n    \"bankName\": \"<string>\",\n    \"bankId\": \"<string>\",\n    \"accountNumber\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"category\": \"<string>\",\n  \"counterpartyId\": \"<string>\",\n  \"paymentPin\": \"<string>\",\n  \"totp\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "ok": true,
  "data": {
    "id": "<string>",
    "reference": "<string>",
    "amount": "<string>",
    "fee": "<string>",
    "description": "<string>",
    "recipient": {
      "msisdn": "<string>",
      "iban": "<string>",
      "address": "<string>"
    },
    "providerRef": "<string>",
    "failureReason": "<string>",
    "initiatedAt": "<string>",
    "settledAt": "<string>",
    "failedAt": "<string>",
    "idempotencyKey": "<string>",
    "approvedAt": "<string>",
    "autoExecuted": true,
    "frozen": true
  }
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

bearerAuthcookieAuth

Authorization · string · header · required

JWT utilisateur ou clé API kp_<env>_xxx

Headers

idempotency-key · string

Maximum string length: 128

Body

application/json

amount · string · required

Decimal amount with up to 8 fractional digits, e.g. "1500" or "1500.75"

Pattern: ^\d+(\.\d{1,8})?$

currency · enum<string> · required

Available options: XOF, XAF, NGN, GHS, CDF, EUR, USD, USDC, USDT

network · enum<string> · required

Available options: MTN_BJ, MTN_CI, MTN_CM, ORANGE_CI, ORANGE_SN, ORANGE_ML, ORANGE_BF, ORANGE_CM, MOOV_BJ, MOOV_TG, MOOV_CI, MOOV_BF, WAVE_CI, WAVE_SN, FREE_SN, TMONEY_TG, MOBICASH_ML, MOBICASH_BF, DJAMO_CI, MIXX_SN, MTN_CG, AIRTEL_CG, ORANGE_CD, AIRTEL_CD, VODACOM_CD, AFRICELL_CD, AIRTEL_GA, MOMO_NG, AIRTEL_NG, MTN_GH, VODAFONE_GH, AIRTELTIGO_GH, BANK_XOF, BANK_XAF, BANK_NGN, BANK_GHS, BANK_CDF, BANK_EUR, BANK_USD, ETH, POLYGON, TRON

recipient · object · required

Show child attributes

description · string

Maximum string length: 500

category · string

Maximum string length: 50

counterpartyId · string

paymentPin · string

Required string length: 6

Pattern: ^\d{6}$

totp · string

Required string length: 6

Pattern: ^\d{6}$

Response

201

application/json

Default Response

ok · enum<boolean> · required

Available options: true

data · object · required

Show child attributes