Create a disbursement intent
curl --request POST \
--url https://api.mysoleas.com/disbursement/intent \
--header 'Content-Type: application/json' \
--header 'x-sp-auth-token: <api-key>' \
--data '
{
"amount": 2500,
"currency": "XAF",
"transaction_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "mtn_cmr",
"channel": "PROVIDER",
"customer_wallet": "670000000",
"description": "<string>",
"metadata": {},
"distribution": [
{
"matricule": "MS-SELLER-001",
"rate": 80,
"description": "<string>",
"metadata": {}
}
],
"amount_unit": "MAJOR"
}
'import requests
url = "https://api.mysoleas.com/disbursement/intent"
payload = {
"amount": 2500,
"currency": "XAF",
"transaction_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "mtn_cmr",
"channel": "PROVIDER",
"customer_wallet": "670000000",
"description": "<string>",
"metadata": {},
"distribution": [
{
"matricule": "MS-SELLER-001",
"rate": 80,
"description": "<string>",
"metadata": {}
}
],
"amount_unit": "MAJOR"
}
headers = {
"x-sp-auth-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-sp-auth-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 2500,
currency: 'XAF',
transaction_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
provider: 'mtn_cmr',
channel: 'PROVIDER',
customer_wallet: '670000000',
description: '<string>',
metadata: {},
distribution: [{matricule: 'MS-SELLER-001', rate: 80, description: '<string>', metadata: {}}],
amount_unit: 'MAJOR'
})
};
fetch('https://api.mysoleas.com/disbursement/intent', 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.mysoleas.com/disbursement/intent",
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' => 2500,
'currency' => 'XAF',
'transaction_uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'provider' => 'mtn_cmr',
'channel' => 'PROVIDER',
'customer_wallet' => '670000000',
'description' => '<string>',
'metadata' => [
],
'distribution' => [
[
'matricule' => 'MS-SELLER-001',
'rate' => 80,
'description' => '<string>',
'metadata' => [
]
]
],
'amount_unit' => 'MAJOR'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-sp-auth-token: <api-key>"
],
]);
$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.mysoleas.com/disbursement/intent"
payload := strings.NewReader("{\n \"amount\": 2500,\n \"currency\": \"XAF\",\n \"transaction_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"provider\": \"mtn_cmr\",\n \"channel\": \"PROVIDER\",\n \"customer_wallet\": \"670000000\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"distribution\": [\n {\n \"matricule\": \"MS-SELLER-001\",\n \"rate\": 80,\n \"description\": \"<string>\",\n \"metadata\": {}\n }\n ],\n \"amount_unit\": \"MAJOR\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-sp-auth-token", "<api-key>")
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.mysoleas.com/disbursement/intent")
.header("x-sp-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 2500,\n \"currency\": \"XAF\",\n \"transaction_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"provider\": \"mtn_cmr\",\n \"channel\": \"PROVIDER\",\n \"customer_wallet\": \"670000000\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"distribution\": [\n {\n \"matricule\": \"MS-SELLER-001\",\n \"rate\": 80,\n \"description\": \"<string>\",\n \"metadata\": {}\n }\n ],\n \"amount_unit\": \"MAJOR\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mysoleas.com/disbursement/intent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-sp-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 2500,\n \"currency\": \"XAF\",\n \"transaction_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"provider\": \"mtn_cmr\",\n \"channel\": \"PROVIDER\",\n \"customer_wallet\": \"670000000\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"distribution\": [\n {\n \"matricule\": \"MS-SELLER-001\",\n \"rate\": 80,\n \"description\": \"<string>\",\n \"metadata\": {}\n }\n ],\n \"amount_unit\": \"MAJOR\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"success": true,
"locale": "fr",
"message": "<string>",
"meta": {},
"data": {
"transaction_reference": "<string>",
"environment": "prod",
"invoice_reference": "<string>",
"provider_reference": "<string>",
"status": "INITIATED",
"operation": "COLLECTION",
"channel": "PROVIDER",
"amount": 123,
"currency": "<string>",
"confirmation_method": "MSISDN",
"confirmation_url": "<string>",
"fee": 123,
"required_total": 123,
"settlement_mode": "DIRECT",
"split_reference": "<string>",
"split_status": "NONE",
"created_at": "<string>",
"updated_at": "<string>",
"amount_unit": "MAJOR"
}
}{
"success": false,
"code": 400,
"message": "empty_data",
"error": {
"details": {}
}
}Disbursements
Disbursement intent
POST
/
disbursement
/
intent
Create a disbursement intent
curl --request POST \
--url https://api.mysoleas.com/disbursement/intent \
--header 'Content-Type: application/json' \
--header 'x-sp-auth-token: <api-key>' \
--data '
{
"amount": 2500,
"currency": "XAF",
"transaction_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "mtn_cmr",
"channel": "PROVIDER",
"customer_wallet": "670000000",
"description": "<string>",
"metadata": {},
"distribution": [
{
"matricule": "MS-SELLER-001",
"rate": 80,
"description": "<string>",
"metadata": {}
}
],
"amount_unit": "MAJOR"
}
'import requests
url = "https://api.mysoleas.com/disbursement/intent"
payload = {
"amount": 2500,
"currency": "XAF",
"transaction_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "mtn_cmr",
"channel": "PROVIDER",
"customer_wallet": "670000000",
"description": "<string>",
"metadata": {},
"distribution": [
{
"matricule": "MS-SELLER-001",
"rate": 80,
"description": "<string>",
"metadata": {}
}
],
"amount_unit": "MAJOR"
}
headers = {
"x-sp-auth-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-sp-auth-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 2500,
currency: 'XAF',
transaction_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
provider: 'mtn_cmr',
channel: 'PROVIDER',
customer_wallet: '670000000',
description: '<string>',
metadata: {},
distribution: [{matricule: 'MS-SELLER-001', rate: 80, description: '<string>', metadata: {}}],
amount_unit: 'MAJOR'
})
};
fetch('https://api.mysoleas.com/disbursement/intent', 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.mysoleas.com/disbursement/intent",
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' => 2500,
'currency' => 'XAF',
'transaction_uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'provider' => 'mtn_cmr',
'channel' => 'PROVIDER',
'customer_wallet' => '670000000',
'description' => '<string>',
'metadata' => [
],
'distribution' => [
[
'matricule' => 'MS-SELLER-001',
'rate' => 80,
'description' => '<string>',
'metadata' => [
]
]
],
'amount_unit' => 'MAJOR'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-sp-auth-token: <api-key>"
],
]);
$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.mysoleas.com/disbursement/intent"
payload := strings.NewReader("{\n \"amount\": 2500,\n \"currency\": \"XAF\",\n \"transaction_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"provider\": \"mtn_cmr\",\n \"channel\": \"PROVIDER\",\n \"customer_wallet\": \"670000000\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"distribution\": [\n {\n \"matricule\": \"MS-SELLER-001\",\n \"rate\": 80,\n \"description\": \"<string>\",\n \"metadata\": {}\n }\n ],\n \"amount_unit\": \"MAJOR\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-sp-auth-token", "<api-key>")
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.mysoleas.com/disbursement/intent")
.header("x-sp-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 2500,\n \"currency\": \"XAF\",\n \"transaction_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"provider\": \"mtn_cmr\",\n \"channel\": \"PROVIDER\",\n \"customer_wallet\": \"670000000\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"distribution\": [\n {\n \"matricule\": \"MS-SELLER-001\",\n \"rate\": 80,\n \"description\": \"<string>\",\n \"metadata\": {}\n }\n ],\n \"amount_unit\": \"MAJOR\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mysoleas.com/disbursement/intent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-sp-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 2500,\n \"currency\": \"XAF\",\n \"transaction_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"provider\": \"mtn_cmr\",\n \"channel\": \"PROVIDER\",\n \"customer_wallet\": \"670000000\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"distribution\": [\n {\n \"matricule\": \"MS-SELLER-001\",\n \"rate\": 80,\n \"description\": \"<string>\",\n \"metadata\": {}\n }\n ],\n \"amount_unit\": \"MAJOR\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"success": true,
"locale": "fr",
"message": "<string>",
"meta": {},
"data": {
"transaction_reference": "<string>",
"environment": "prod",
"invoice_reference": "<string>",
"provider_reference": "<string>",
"status": "INITIATED",
"operation": "COLLECTION",
"channel": "PROVIDER",
"amount": 123,
"currency": "<string>",
"confirmation_method": "MSISDN",
"confirmation_url": "<string>",
"fee": 123,
"required_total": 123,
"settlement_mode": "DIRECT",
"split_reference": "<string>",
"split_status": "NONE",
"created_at": "<string>",
"updated_at": "<string>",
"amount_unit": "MAJOR"
}
}{
"success": false,
"code": 400,
"message": "empty_data",
"error": {
"details": {}
}
}Amount unit
Sendamount in major units by default: 4.01 for 4.01 USD/EUR. API clients that already send cents can set amount_unit: "MINOR" at the root of the JSON body, alongside amount and currency, rather than in metadata. Public responses return major units even when the request uses MINOR. See amounts and currencies.
Set amount_unit when creating the intent. Subsequent execute and status requests use transaction_reference and do not accept a replacement amount.
USD example
This intent example uses major units. Choose a provider authorized for the operation and currency.{
"amount": 4.01,
"currency": "USD",
"amount_unit": "MAJOR",
"transaction_uuid": "2f8b9a68-1ad3-4a0c-a187-40b91a4c44a1",
"provider": "YOUR_USD_PROVIDER",
"channel": "PROVIDER",
"customer_wallet": "YOUR_CUSTOMER_WALLET"
}
"amount": 401 and "amount_unit": "MINOR". Both representations target 4.01 USD; public responses remain in major units.Authorizations
Bearer token obtained with the client_id and client_secret of the application created in SoleasPay. Format: Bearer <access_token>.
Body
application/json
Amount in major units by default: 4.01 for 4.01 USD/EUR. With root-level amount_unit MINOR, send integer cents (401).
Example:
2500
Example:
"XAF"
Example:
"mtn_cmr"
Available options:
PROVIDER, WALLET, AUTO Example:
"PROVIDER"
Example:
"670000000"
Available options:
DIRECT, SPLIT Show child attributes
Show child attributes
Unit of request amounts. Optional, MAJOR by default. Put this field at the root of the JSON body, not in metadata. MINOR preserves amounts already expressed in the smallest unit.
Available options:
MAJOR, MINOR Example:
"MAJOR"
⌘I