Create a delegated Transfer
curl --request POST \
--url https://api.example.com/delegated/transfers \
--header 'ApiKey: <apikey>' \
--header 'Content-Type: application/json' \
--header 'Environment: <environment>' \
--header 'MerchantId: <merchantid>' \
--data '
{
"reference": "ref_2020_11_10_001",
"amount": 100,
"currency": "XOF",
"description": "<string>",
"destination": {
"type": "mobile_money",
"country": "CI",
"msisdn": "<string>",
"provider": "orange",
"recipientName": "<string>"
},
"aggregatedMerchantId": "<string>",
"rejectionId": "ndr_V1StGXR8_Z5jdHi6B-myT",
"origin": {
"name": "<string>",
"country": "<string>"
},
"overrideBusinessName": "MyBusiness",
"overrideBusinessId": "e9bb247c-6e3f-4a39-a539-78e3bf115994",
"transferInformation": {
"recipient_name_hashmac": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"transaction_purpose": "SALARY"
}
}
'import requests
url = "https://api.example.com/delegated/transfers"
payload = {
"reference": "ref_2020_11_10_001",
"amount": 100,
"currency": "XOF",
"description": "<string>",
"destination": {
"type": "mobile_money",
"country": "CI",
"msisdn": "<string>",
"provider": "orange",
"recipientName": "<string>"
},
"aggregatedMerchantId": "<string>",
"rejectionId": "ndr_V1StGXR8_Z5jdHi6B-myT",
"origin": {
"name": "<string>",
"country": "<string>"
},
"overrideBusinessName": "MyBusiness",
"overrideBusinessId": "e9bb247c-6e3f-4a39-a539-78e3bf115994",
"transferInformation": {
"recipient_name_hashmac": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"transaction_purpose": "SALARY"
}
}
headers = {
"ApiKey": "<apikey>",
"MerchantId": "<merchantid>",
"Environment": "<environment>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
ApiKey: '<apikey>',
MerchantId: '<merchantid>',
Environment: '<environment>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
reference: 'ref_2020_11_10_001',
amount: 100,
currency: 'XOF',
description: '<string>',
destination: {
type: 'mobile_money',
country: 'CI',
msisdn: '<string>',
provider: 'orange',
recipientName: '<string>'
},
aggregatedMerchantId: '<string>',
rejectionId: 'ndr_V1StGXR8_Z5jdHi6B-myT',
origin: {name: '<string>', country: '<string>'},
overrideBusinessName: 'MyBusiness',
overrideBusinessId: 'e9bb247c-6e3f-4a39-a539-78e3bf115994',
transferInformation: {
recipient_name_hashmac: '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08',
transaction_purpose: 'SALARY'
}
})
};
fetch('https://api.example.com/delegated/transfers', 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 => "https://api.example.com/delegated/transfers",
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([
'reference' => 'ref_2020_11_10_001',
'amount' => 100,
'currency' => 'XOF',
'description' => '<string>',
'destination' => [
'type' => 'mobile_money',
'country' => 'CI',
'msisdn' => '<string>',
'provider' => 'orange',
'recipientName' => '<string>'
],
'aggregatedMerchantId' => '<string>',
'rejectionId' => 'ndr_V1StGXR8_Z5jdHi6B-myT',
'origin' => [
'name' => '<string>',
'country' => '<string>'
],
'overrideBusinessName' => 'MyBusiness',
'overrideBusinessId' => 'e9bb247c-6e3f-4a39-a539-78e3bf115994',
'transferInformation' => [
'recipient_name_hashmac' => '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08',
'transaction_purpose' => 'SALARY'
]
]),
CURLOPT_HTTPHEADER => [
"ApiKey: <apikey>",
"Content-Type: application/json",
"Environment: <environment>",
"MerchantId: <merchantid>"
],
]);
$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 := "https://api.example.com/delegated/transfers"
payload := strings.NewReader("{\n \"reference\": \"ref_2020_11_10_001\",\n \"amount\": 100,\n \"currency\": \"XOF\",\n \"description\": \"<string>\",\n \"destination\": {\n \"type\": \"mobile_money\",\n \"country\": \"CI\",\n \"msisdn\": \"<string>\",\n \"provider\": \"orange\",\n \"recipientName\": \"<string>\"\n },\n \"aggregatedMerchantId\": \"<string>\",\n \"rejectionId\": \"ndr_V1StGXR8_Z5jdHi6B-myT\",\n \"origin\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"overrideBusinessName\": \"MyBusiness\",\n \"overrideBusinessId\": \"e9bb247c-6e3f-4a39-a539-78e3bf115994\",\n \"transferInformation\": {\n \"recipient_name_hashmac\": \"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08\",\n \"transaction_purpose\": \"SALARY\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ApiKey", "<apikey>")
req.Header.Add("MerchantId", "<merchantid>")
req.Header.Add("Environment", "<environment>")
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("https://api.example.com/delegated/transfers")
.header("ApiKey", "<apikey>")
.header("MerchantId", "<merchantid>")
.header("Environment", "<environment>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"ref_2020_11_10_001\",\n \"amount\": 100,\n \"currency\": \"XOF\",\n \"description\": \"<string>\",\n \"destination\": {\n \"type\": \"mobile_money\",\n \"country\": \"CI\",\n \"msisdn\": \"<string>\",\n \"provider\": \"orange\",\n \"recipientName\": \"<string>\"\n },\n \"aggregatedMerchantId\": \"<string>\",\n \"rejectionId\": \"ndr_V1StGXR8_Z5jdHi6B-myT\",\n \"origin\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"overrideBusinessName\": \"MyBusiness\",\n \"overrideBusinessId\": \"e9bb247c-6e3f-4a39-a539-78e3bf115994\",\n \"transferInformation\": {\n \"recipient_name_hashmac\": \"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08\",\n \"transaction_purpose\": \"SALARY\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/delegated/transfers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reference\": \"ref_2020_11_10_001\",\n \"amount\": 100,\n \"currency\": \"XOF\",\n \"description\": \"<string>\",\n \"destination\": {\n \"type\": \"mobile_money\",\n \"country\": \"CI\",\n \"msisdn\": \"<string>\",\n \"provider\": \"orange\",\n \"recipientName\": \"<string>\"\n },\n \"aggregatedMerchantId\": \"<string>\",\n \"rejectionId\": \"ndr_V1StGXR8_Z5jdHi6B-myT\",\n \"origin\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"overrideBusinessName\": \"MyBusiness\",\n \"overrideBusinessId\": \"e9bb247c-6e3f-4a39-a539-78e3bf115994\",\n \"transferInformation\": {\n \"recipient_name_hashmac\": \"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08\",\n \"transaction_purpose\": \"SALARY\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "tr_z1urYtVFgEebtcj8fxp4v",
"merchantId": "<string>",
"createdAt": "2020-10-15T12:09:49.355Z",
"updatedAt": "2020-10-15T12:16:26.128Z",
"reference": "ref_2020_11_10_001",
"description": "<string>",
"status": "successful",
"amount": 100,
"currency": "XOF",
"mode": "live",
"destination": {
"type": "mobile_money",
"country": "CI",
"number": "<string>",
"provider": "orange",
"recipientName": "<string>"
},
"fees": [
{
"id": "lAe5HnFpvOjwdT9vSIgPA",
"rate": 123,
"type": "flat",
"amount": 5,
"currency": "XOF",
"taxes": [
"<string>"
],
"label": "<string>"
}
],
"isIrt": true,
"providerReference": "<string>",
"isDelegated": true,
"aggregatedMerchantId": "<string>",
"failureCause": {
"code": "<string>",
"message": "<string>",
"params": [
"<string>"
]
},
"origin": {
"name": "<string>",
"country": "<string>"
},
"overrideBusinessName": "<string>",
"overrideBusinessId": "<string>",
"subMerchantId": "submerchant_123",
"transferInformation": {
"recipient_name_hashmac": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"transaction_purpose": "SALARY"
},
"idempotentReplay": true,
"balanceBefore": 123,
"balanceAfter": 123
}{
"id": "tr_z1urYtVFgEebtcj8fxp4v",
"merchantId": "<string>",
"createdAt": "2020-10-15T12:09:49.355Z",
"updatedAt": "2020-10-15T12:16:26.128Z",
"reference": "ref_2020_11_10_001",
"description": "<string>",
"status": "successful",
"amount": 100,
"currency": "XOF",
"mode": "live",
"destination": {
"type": "mobile_money",
"country": "CI",
"number": "<string>",
"provider": "orange",
"recipientName": "<string>"
},
"fees": [
{
"id": "lAe5HnFpvOjwdT9vSIgPA",
"rate": 123,
"type": "flat",
"amount": 5,
"currency": "XOF",
"taxes": [
"<string>"
],
"label": "<string>"
}
],
"isIrt": true,
"providerReference": "<string>",
"isDelegated": true,
"aggregatedMerchantId": "<string>",
"failureCause": {
"code": "<string>",
"message": "<string>",
"params": [
"<string>"
]
},
"origin": {
"name": "<string>",
"country": "<string>"
},
"overrideBusinessName": "<string>",
"overrideBusinessId": "<string>",
"subMerchantId": "submerchant_123",
"transferInformation": {
"recipient_name_hashmac": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"transaction_purpose": "SALARY"
},
"idempotentReplay": true,
"balanceBefore": 123,
"balanceAfter": 123
}{
"status": 400,
"code": "wrong_provider",
"message": "Provider 'unknown_provider' does not exist for country 'CI' and method 'mobile_money'.",
"request_id": "<string>"
}{
"status": 401,
"error": {
"type": "authorization_error",
"code": "wrong_credentials",
"message": "L'ID marchand et/ou la clé d'API sont incorrects."
}
}{
"status": 403,
"error": {
"statusCode": 403,
"message": "Forbidden",
"error": "<string>"
}
}{
"httpStatus": 404,
"message": "X not found",
"error": "Not found"
}{
"status": 409,
"code": "duplicate_reference",
"message": "This refusal does not mean that a payout failed. A payout with this reference already exists. When original_transaction_id is present, fetch that payout to know its status. Do not reuse a reference for a different payout.",
"request_id": "<string>",
"rejection_id": "ndr_V1StGXR8_Z5jdHi6B-myT",
"expires_at": "2026-10-19T14:20:00.000Z",
"original_transaction_id": "trf_V1StGXR8_Z5jdHi6B",
"matching_transfers": [
{
"id": "trf_V1StGXR8_Z5jdHi6B",
"reference": "payout-2026-10-19-0042",
"status": "pending",
"created_at": "2026-10-19T14:05:00.000Z",
"operator": "orange",
"amount": 50000,
"currency": "XOF"
}
],
"end_user_message": {
"en": "A transfer of 50,000 XOF to this number was already made at 10:00 UTC and is in progress.",
"fr": "Un transfert de 50 000 XOF vers ce numéro a déjà été effectué à 10:00 UTC et est en cours."
}
}{
"status": 422,
"code": "invalid_duplicate_confirmation",
"message": "This rejectionId cannot confirm this payout; reason says why. Resend the payout without rejectionId: it is created if it is no longer a possible duplicate, or refused with a new rejection_id.",
"request_id": "<string>",
"reason": "expired"
}{
"status": 429,
"error": "ThrottlerException: Too Many Requests"
}{
"type": "internal_error",
"code": [
"internal_error",
"wrong_credentials",
"not_granted",
"live_mode_not_granted"
],
"message": "An error occurred on our system. Please try again later."
}{
"status": 503,
"code": "merchant_group_unavailable",
"message": "Your merchant group could not be verified. Please retry in a few moments.",
"request_id": "<string>"
}Processing Only
Create a delegated Transfer
This endpoint allows you to make a transfer (PAY-OUT) using your own provider credentials.
POST
/
delegated
/
transfers
Create a delegated Transfer
curl --request POST \
--url https://api.example.com/delegated/transfers \
--header 'ApiKey: <apikey>' \
--header 'Content-Type: application/json' \
--header 'Environment: <environment>' \
--header 'MerchantId: <merchantid>' \
--data '
{
"reference": "ref_2020_11_10_001",
"amount": 100,
"currency": "XOF",
"description": "<string>",
"destination": {
"type": "mobile_money",
"country": "CI",
"msisdn": "<string>",
"provider": "orange",
"recipientName": "<string>"
},
"aggregatedMerchantId": "<string>",
"rejectionId": "ndr_V1StGXR8_Z5jdHi6B-myT",
"origin": {
"name": "<string>",
"country": "<string>"
},
"overrideBusinessName": "MyBusiness",
"overrideBusinessId": "e9bb247c-6e3f-4a39-a539-78e3bf115994",
"transferInformation": {
"recipient_name_hashmac": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"transaction_purpose": "SALARY"
}
}
'import requests
url = "https://api.example.com/delegated/transfers"
payload = {
"reference": "ref_2020_11_10_001",
"amount": 100,
"currency": "XOF",
"description": "<string>",
"destination": {
"type": "mobile_money",
"country": "CI",
"msisdn": "<string>",
"provider": "orange",
"recipientName": "<string>"
},
"aggregatedMerchantId": "<string>",
"rejectionId": "ndr_V1StGXR8_Z5jdHi6B-myT",
"origin": {
"name": "<string>",
"country": "<string>"
},
"overrideBusinessName": "MyBusiness",
"overrideBusinessId": "e9bb247c-6e3f-4a39-a539-78e3bf115994",
"transferInformation": {
"recipient_name_hashmac": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"transaction_purpose": "SALARY"
}
}
headers = {
"ApiKey": "<apikey>",
"MerchantId": "<merchantid>",
"Environment": "<environment>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
ApiKey: '<apikey>',
MerchantId: '<merchantid>',
Environment: '<environment>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
reference: 'ref_2020_11_10_001',
amount: 100,
currency: 'XOF',
description: '<string>',
destination: {
type: 'mobile_money',
country: 'CI',
msisdn: '<string>',
provider: 'orange',
recipientName: '<string>'
},
aggregatedMerchantId: '<string>',
rejectionId: 'ndr_V1StGXR8_Z5jdHi6B-myT',
origin: {name: '<string>', country: '<string>'},
overrideBusinessName: 'MyBusiness',
overrideBusinessId: 'e9bb247c-6e3f-4a39-a539-78e3bf115994',
transferInformation: {
recipient_name_hashmac: '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08',
transaction_purpose: 'SALARY'
}
})
};
fetch('https://api.example.com/delegated/transfers', 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 => "https://api.example.com/delegated/transfers",
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([
'reference' => 'ref_2020_11_10_001',
'amount' => 100,
'currency' => 'XOF',
'description' => '<string>',
'destination' => [
'type' => 'mobile_money',
'country' => 'CI',
'msisdn' => '<string>',
'provider' => 'orange',
'recipientName' => '<string>'
],
'aggregatedMerchantId' => '<string>',
'rejectionId' => 'ndr_V1StGXR8_Z5jdHi6B-myT',
'origin' => [
'name' => '<string>',
'country' => '<string>'
],
'overrideBusinessName' => 'MyBusiness',
'overrideBusinessId' => 'e9bb247c-6e3f-4a39-a539-78e3bf115994',
'transferInformation' => [
'recipient_name_hashmac' => '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08',
'transaction_purpose' => 'SALARY'
]
]),
CURLOPT_HTTPHEADER => [
"ApiKey: <apikey>",
"Content-Type: application/json",
"Environment: <environment>",
"MerchantId: <merchantid>"
],
]);
$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 := "https://api.example.com/delegated/transfers"
payload := strings.NewReader("{\n \"reference\": \"ref_2020_11_10_001\",\n \"amount\": 100,\n \"currency\": \"XOF\",\n \"description\": \"<string>\",\n \"destination\": {\n \"type\": \"mobile_money\",\n \"country\": \"CI\",\n \"msisdn\": \"<string>\",\n \"provider\": \"orange\",\n \"recipientName\": \"<string>\"\n },\n \"aggregatedMerchantId\": \"<string>\",\n \"rejectionId\": \"ndr_V1StGXR8_Z5jdHi6B-myT\",\n \"origin\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"overrideBusinessName\": \"MyBusiness\",\n \"overrideBusinessId\": \"e9bb247c-6e3f-4a39-a539-78e3bf115994\",\n \"transferInformation\": {\n \"recipient_name_hashmac\": \"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08\",\n \"transaction_purpose\": \"SALARY\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ApiKey", "<apikey>")
req.Header.Add("MerchantId", "<merchantid>")
req.Header.Add("Environment", "<environment>")
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("https://api.example.com/delegated/transfers")
.header("ApiKey", "<apikey>")
.header("MerchantId", "<merchantid>")
.header("Environment", "<environment>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"ref_2020_11_10_001\",\n \"amount\": 100,\n \"currency\": \"XOF\",\n \"description\": \"<string>\",\n \"destination\": {\n \"type\": \"mobile_money\",\n \"country\": \"CI\",\n \"msisdn\": \"<string>\",\n \"provider\": \"orange\",\n \"recipientName\": \"<string>\"\n },\n \"aggregatedMerchantId\": \"<string>\",\n \"rejectionId\": \"ndr_V1StGXR8_Z5jdHi6B-myT\",\n \"origin\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"overrideBusinessName\": \"MyBusiness\",\n \"overrideBusinessId\": \"e9bb247c-6e3f-4a39-a539-78e3bf115994\",\n \"transferInformation\": {\n \"recipient_name_hashmac\": \"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08\",\n \"transaction_purpose\": \"SALARY\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/delegated/transfers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reference\": \"ref_2020_11_10_001\",\n \"amount\": 100,\n \"currency\": \"XOF\",\n \"description\": \"<string>\",\n \"destination\": {\n \"type\": \"mobile_money\",\n \"country\": \"CI\",\n \"msisdn\": \"<string>\",\n \"provider\": \"orange\",\n \"recipientName\": \"<string>\"\n },\n \"aggregatedMerchantId\": \"<string>\",\n \"rejectionId\": \"ndr_V1StGXR8_Z5jdHi6B-myT\",\n \"origin\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"overrideBusinessName\": \"MyBusiness\",\n \"overrideBusinessId\": \"e9bb247c-6e3f-4a39-a539-78e3bf115994\",\n \"transferInformation\": {\n \"recipient_name_hashmac\": \"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08\",\n \"transaction_purpose\": \"SALARY\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "tr_z1urYtVFgEebtcj8fxp4v",
"merchantId": "<string>",
"createdAt": "2020-10-15T12:09:49.355Z",
"updatedAt": "2020-10-15T12:16:26.128Z",
"reference": "ref_2020_11_10_001",
"description": "<string>",
"status": "successful",
"amount": 100,
"currency": "XOF",
"mode": "live",
"destination": {
"type": "mobile_money",
"country": "CI",
"number": "<string>",
"provider": "orange",
"recipientName": "<string>"
},
"fees": [
{
"id": "lAe5HnFpvOjwdT9vSIgPA",
"rate": 123,
"type": "flat",
"amount": 5,
"currency": "XOF",
"taxes": [
"<string>"
],
"label": "<string>"
}
],
"isIrt": true,
"providerReference": "<string>",
"isDelegated": true,
"aggregatedMerchantId": "<string>",
"failureCause": {
"code": "<string>",
"message": "<string>",
"params": [
"<string>"
]
},
"origin": {
"name": "<string>",
"country": "<string>"
},
"overrideBusinessName": "<string>",
"overrideBusinessId": "<string>",
"subMerchantId": "submerchant_123",
"transferInformation": {
"recipient_name_hashmac": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"transaction_purpose": "SALARY"
},
"idempotentReplay": true,
"balanceBefore": 123,
"balanceAfter": 123
}{
"id": "tr_z1urYtVFgEebtcj8fxp4v",
"merchantId": "<string>",
"createdAt": "2020-10-15T12:09:49.355Z",
"updatedAt": "2020-10-15T12:16:26.128Z",
"reference": "ref_2020_11_10_001",
"description": "<string>",
"status": "successful",
"amount": 100,
"currency": "XOF",
"mode": "live",
"destination": {
"type": "mobile_money",
"country": "CI",
"number": "<string>",
"provider": "orange",
"recipientName": "<string>"
},
"fees": [
{
"id": "lAe5HnFpvOjwdT9vSIgPA",
"rate": 123,
"type": "flat",
"amount": 5,
"currency": "XOF",
"taxes": [
"<string>"
],
"label": "<string>"
}
],
"isIrt": true,
"providerReference": "<string>",
"isDelegated": true,
"aggregatedMerchantId": "<string>",
"failureCause": {
"code": "<string>",
"message": "<string>",
"params": [
"<string>"
]
},
"origin": {
"name": "<string>",
"country": "<string>"
},
"overrideBusinessName": "<string>",
"overrideBusinessId": "<string>",
"subMerchantId": "submerchant_123",
"transferInformation": {
"recipient_name_hashmac": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"transaction_purpose": "SALARY"
},
"idempotentReplay": true,
"balanceBefore": 123,
"balanceAfter": 123
}{
"status": 400,
"code": "wrong_provider",
"message": "Provider 'unknown_provider' does not exist for country 'CI' and method 'mobile_money'.",
"request_id": "<string>"
}{
"status": 401,
"error": {
"type": "authorization_error",
"code": "wrong_credentials",
"message": "L'ID marchand et/ou la clé d'API sont incorrects."
}
}{
"status": 403,
"error": {
"statusCode": 403,
"message": "Forbidden",
"error": "<string>"
}
}{
"httpStatus": 404,
"message": "X not found",
"error": "Not found"
}{
"status": 409,
"code": "duplicate_reference",
"message": "This refusal does not mean that a payout failed. A payout with this reference already exists. When original_transaction_id is present, fetch that payout to know its status. Do not reuse a reference for a different payout.",
"request_id": "<string>",
"rejection_id": "ndr_V1StGXR8_Z5jdHi6B-myT",
"expires_at": "2026-10-19T14:20:00.000Z",
"original_transaction_id": "trf_V1StGXR8_Z5jdHi6B",
"matching_transfers": [
{
"id": "trf_V1StGXR8_Z5jdHi6B",
"reference": "payout-2026-10-19-0042",
"status": "pending",
"created_at": "2026-10-19T14:05:00.000Z",
"operator": "orange",
"amount": 50000,
"currency": "XOF"
}
],
"end_user_message": {
"en": "A transfer of 50,000 XOF to this number was already made at 10:00 UTC and is in progress.",
"fr": "Un transfert de 50 000 XOF vers ce numéro a déjà été effectué à 10:00 UTC et est en cours."
}
}{
"status": 422,
"code": "invalid_duplicate_confirmation",
"message": "This rejectionId cannot confirm this payout; reason says why. Resend the payout without rejectionId: it is created if it is no longer a possible duplicate, or refused with a new rejection_id.",
"request_id": "<string>",
"reason": "expired"
}{
"status": 429,
"error": "ThrottlerException: Too Many Requests"
}{
"type": "internal_error",
"code": [
"internal_error",
"wrong_credentials",
"not_granted",
"live_mode_not_granted"
],
"message": "An error occurred on our system. Please try again later."
}{
"status": 503,
"code": "merchant_group_unavailable",
"message": "Your merchant group could not be verified. Please retry in a few moments.",
"request_id": "<string>"
}Headers
Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.
Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.
Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.
Available options:
live, sandbox Body
application/json
A reference provided by the client during the creation of this Transfer, at most 255 characters
Maximum string length:
255Example:
"ref_2020_11_10_001"
Amount intended to be sent to the recipient. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency).
Example:
100
Three-letter ISO currency code.
Example:
"XOF"
An arbitrary string attached to the Transfer. Mostly useful for displaying to user.
Information about the recipient of this Transfer
- Destination
- Destination
- Destination
- Destination
Show child attributes
Show child attributes
Aggregated merchant id
Confirms a payout refused with 409 possible_duplicate: the rejection_id of that response. Resend the refused payout unchanged, to the same endpoint and with the same reference (the externalId, for a cross-border transaction), before the response's expires_at. A rejection confirms one payout only: resending the confirmed payout again gets the idempotent replay, while an unknown or expired rejection, one replaced by a later refusal of its confirmation, one already used by another payout, or one that refused a different payout is answered 422 invalid_duplicate_confirmation. Ignored unless duplicate protection and near-duplicate protection are both enforced for your account.
Pattern:
^ndr_[A-Za-z0-9_-]{21}$Example:
"ndr_V1StGXR8_Z5jdHi6B-myT"
Information about the sender
Show child attributes
Show child attributes
This field is mandatory for aggregators and allows you to override the business name displayed to the end users. This is useful if you don't want your clients to see "Hub2" as the target of their payment but your company name instead.
Example:
"MyBusiness"
This field is mandatory for merchants that have the corresponding setting enabled, It allows to send a custom name
Example:
"e9bb247c-6e3f-4a39-a539-78e3bf115994"
Optional merchant-defined payment metadata. Persisted and returned on the transfer.
Show child attributes
Show child attributes
Example:
{
"recipient_name_hashmac": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"transaction_purpose": "SALARY"
}
Response
Idempotent replay. Duplicate protection is enforced for your account, and a payout with this reference and the same payout details already exists: it is returned as it is now, and nothing is created or charged. Only ever sent with the X-Idempotent-Replay: true header and the body field idempotentReplay: true, which is absent from a normal creation. The payout details compared are the destination type, country, beneficiary, operator, requested amount and currency; on IRT and cross-border routes, also the sender identity and, on cross-border, the rateId, unless the reference was recorded by an earlier version of this check, which compared neither; other names (recipient, bank, display name), descriptions and metadata are ignored.
Unique identifier for the Transfer
Example:
"tr_z1urYtVFgEebtcj8fxp4v"
Identifier of the merchant owning this Transfer
Datetime in UTC timezone at which this object was created. Follows the Datetime ISO.
Example:
"2020-10-15T12:09:49.355Z"
Datetime in UTC timezone at which this object was updated for the last time . Follows the Datetime ISO.
Example:
"2020-10-15T12:16:26.128Z"
A reference provided by the client during the creation of this Transfer
Example:
"ref_2020_11_10_001"
An arbitrary string attached to the Transfer. Mostly useful for displaying to user.
The current status of this Transfer
Available options:
created, successful, pending, failed Example:
"successful"
Amount intended to be sent to the recipient. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency).
Example:
100
Three-letter ISO currency code.
Example:
"XOF"
Mode in which this transfer exists. The sandbox mode can be used during the integration phase and is available as soon as the merchant account is created. No real transactions are made in this mode. The live mode has to be used to make real transactions.
Available options:
live, sandbox Example:
"live"
Information about the recipient of this Transfer
- Destination
- Destination
- Destination
- Destination
Show child attributes
Show child attributes
Fees applied to merchant's transfer-account uppon success
Show child attributes
Show child attributes
indicate if the transfer was international
provider reference that identify this transfer
Indicates if the transfer is delegated
Aggregated merchant id
In case of failure, this object will describe the reason of the failure
Show child attributes
Show child attributes
Information about the origin of this transfer
Show child attributes
Show child attributes
override business name for aggregator
override business id for merchant
Submerchant ID
Example:
"submerchant_123"
Merchant-defined payment metadata from transfer creation.
Show child attributes
Show child attributes
Example:
{
"recipient_name_hashmac": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"transaction_purpose": "SALARY"
}
Present, and true, only when the response replays an existing payout (idempotent replay, HTTP 200 with the X-Idempotent-Replay: true header). Absent when the transfer has just been created.
Available options:
true Example:
true
Computed balance before the transfer is executed.
Real available balance right after the transfer is executed.