Debit a mandate
curl --request POST \
--url https://api.nomba.com/v1/direct-debits/debit-mandate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'accountId: <accountid>' \
--data '
{
"mandateId": "89b0efc0-dde5-49e2-8bde-5523ae081c43",
"amount": "110.00"
}
'import requests
url = "https://api.nomba.com/v1/direct-debits/debit-mandate"
payload = {
"mandateId": "89b0efc0-dde5-49e2-8bde-5523ae081c43",
"amount": "110.00"
}
headers = {
"accountId": "<accountid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
accountId: '<accountid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({mandateId: '89b0efc0-dde5-49e2-8bde-5523ae081c43', amount: '110.00'})
};
fetch('https://api.nomba.com/v1/direct-debits/debit-mandate', 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.nomba.com/v1/direct-debits/debit-mandate",
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([
'mandateId' => '89b0efc0-dde5-49e2-8bde-5523ae081c43',
'amount' => '110.00'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"accountId: <accountid>"
],
]);
$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.nomba.com/v1/direct-debits/debit-mandate"
payload := strings.NewReader("{\n \"mandateId\": \"89b0efc0-dde5-49e2-8bde-5523ae081c43\",\n \"amount\": \"110.00\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("accountId", "<accountid>")
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("https://api.nomba.com/v1/direct-debits/debit-mandate")
.header("accountId", "<accountid>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mandateId\": \"89b0efc0-dde5-49e2-8bde-5523ae081c43\",\n \"amount\": \"110.00\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nomba.com/v1/direct-debits/debit-mandate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accountId"] = '<accountid>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mandateId\": \"89b0efc0-dde5-49e2-8bde-5523ae081c43\",\n \"amount\": \"110.00\"\n}"
response = http.request(request)
puts response.read_body{
"code": "00",
"description": "SUCCESS",
"data": {
"mandateId": "89b0efc0-dde5-49e2-8bde-5523ae081c43",
"status": "SUCCESS",
"amount": "110.00",
"message": "Approved or completed successfully"
},
"message": "SUCCESS",
"status": true
}Direct Debits
Debit a mandate
Debits a customer’s account using an active mandate.
POST
/
v1
/
direct-debits
/
debit-mandate
Debit a mandate
curl --request POST \
--url https://api.nomba.com/v1/direct-debits/debit-mandate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'accountId: <accountid>' \
--data '
{
"mandateId": "89b0efc0-dde5-49e2-8bde-5523ae081c43",
"amount": "110.00"
}
'import requests
url = "https://api.nomba.com/v1/direct-debits/debit-mandate"
payload = {
"mandateId": "89b0efc0-dde5-49e2-8bde-5523ae081c43",
"amount": "110.00"
}
headers = {
"accountId": "<accountid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
accountId: '<accountid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({mandateId: '89b0efc0-dde5-49e2-8bde-5523ae081c43', amount: '110.00'})
};
fetch('https://api.nomba.com/v1/direct-debits/debit-mandate', 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.nomba.com/v1/direct-debits/debit-mandate",
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([
'mandateId' => '89b0efc0-dde5-49e2-8bde-5523ae081c43',
'amount' => '110.00'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"accountId: <accountid>"
],
]);
$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.nomba.com/v1/direct-debits/debit-mandate"
payload := strings.NewReader("{\n \"mandateId\": \"89b0efc0-dde5-49e2-8bde-5523ae081c43\",\n \"amount\": \"110.00\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("accountId", "<accountid>")
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("https://api.nomba.com/v1/direct-debits/debit-mandate")
.header("accountId", "<accountid>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mandateId\": \"89b0efc0-dde5-49e2-8bde-5523ae081c43\",\n \"amount\": \"110.00\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nomba.com/v1/direct-debits/debit-mandate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accountId"] = '<accountid>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mandateId\": \"89b0efc0-dde5-49e2-8bde-5523ae081c43\",\n \"amount\": \"110.00\"\n}"
response = http.request(request)
puts response.read_body{
"code": "00",
"description": "SUCCESS",
"data": {
"mandateId": "89b0efc0-dde5-49e2-8bde-5523ae081c43",
"status": "SUCCESS",
"amount": "110.00",
"message": "Approved or completed successfully"
},
"message": "SUCCESS",
"status": true
}For a complete guide on response codes and transaction statuses, see Response Codes.
Authorizations
Nomba authenticates API calls with OAuth2 HTTP bearer tokens. There are two methods of authentication; Client-Credentials method and PKCE (Proof Key for Code Exchange) method. In each of the methods, You will get an ACCESS_TOKEN. You need to use an "Authorization" HTTP header to provide your ACCESS_TOKEN. For example: Authorization: {ACCESS_TOKEN}.
Headers
The vendor account ID
Body
application/json