Get mandates by filters

curl --request GET \
  --url https://api.nomba.com/v1/direct-debits/mandates \
  --header 'Authorization: Bearer <token>' \
  --header 'accountId: <accountid>'

import requests

url = "https://api.nomba.com/v1/direct-debits/mandates"

headers = {
    "accountId": "<accountid>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {accountId: '<accountid>', Authorization: 'Bearer <token>'}
};

fetch('https://api.nomba.com/v1/direct-debits/mandates', 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/mandates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nomba.com/v1/direct-debits/mandates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accountId", "<accountid>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.nomba.com/v1/direct-debits/mandates")

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

request = Net::HTTP::Get.new(url)
request["accountId"] = '<accountid>'
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "items": {
      "status": "<string>",
      "customerAccountNumber": "<string>",
      "customerAccountName": "<string>",
      "bankCode": "<string>",
      "amount": 123,
      "customerName": "<string>",
      "customerAddress": "<string>",
      "customerEmail": "<string>",
      "customerPhoneNumber": "<string>",
      "merchantReference": "<string>",
      "frequency": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "mandateAdviceStatus": "<string>",
      "mandateId": "<string>"
    },
    "page": 123,
    "pageSize": 123,
    "totalItems": 123,
    "totalPages": 123,
    "hasMore": true
  },
  "message": "<string>",
  "code": "<string>",
  "description": "<string>",
  "status": true
}

{
  "code": "400",
  "description": "Request failed."
}

{
  "code": "401",
  "description": "Unauthorized"
}

{
  "code": "403",
  "description": "Forbidden"
}

{
  "code": "404",
  "description": "Record not found"
}

{
  "code": "429",
  "description": "Too many requests"
}

{
  "code": "500",
  "description": "Server error"
}

{
  "code": "400",
  "description": "Request failed."
}

GET

direct-debits

mandates

Get mandates by filters

curl --request GET \
  --url https://api.nomba.com/v1/direct-debits/mandates \
  --header 'Authorization: Bearer <token>' \
  --header 'accountId: <accountid>'

import requests

url = "https://api.nomba.com/v1/direct-debits/mandates"

headers = {
    "accountId": "<accountid>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {accountId: '<accountid>', Authorization: 'Bearer <token>'}
};

fetch('https://api.nomba.com/v1/direct-debits/mandates', 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/mandates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nomba.com/v1/direct-debits/mandates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accountId", "<accountid>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.nomba.com/v1/direct-debits/mandates")

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

request = Net::HTTP::Get.new(url)
request["accountId"] = '<accountid>'
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "items": {
      "status": "<string>",
      "customerAccountNumber": "<string>",
      "customerAccountName": "<string>",
      "bankCode": "<string>",
      "amount": 123,
      "customerName": "<string>",
      "customerAddress": "<string>",
      "customerEmail": "<string>",
      "customerPhoneNumber": "<string>",
      "merchantReference": "<string>",
      "frequency": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "mandateAdviceStatus": "<string>",
      "mandateId": "<string>"
    },
    "page": 123,
    "pageSize": 123,
    "totalItems": 123,
    "totalPages": 123,
    "hasMore": true
  },
  "message": "<string>",
  "code": "<string>",
  "description": "<string>",
  "status": true
}

{
  "code": "400",
  "description": "Request failed."
}

{
  "code": "401",
  "description": "Unauthorized"
}

{
  "code": "403",
  "description": "Forbidden"
}

{
  "code": "404",
  "description": "Record not found"
}

{
  "code": "429",
  "description": "Too many requests"
}

{
  "code": "500",
  "description": "Server error"
}

{
  "code": "400",
  "description": "Request failed."
}

For a complete guide on response codes and transaction statuses, see Response Codes.

Authorizations

Authorization

string

header

required

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

accountId

string<uuid>

required

The parent accountId of the business.

Example:

"890022ce-bae0-45c1-9b9d-ee7872e6ca27"

Query Parameters

page

integer

required

Example:

0

pageSize

integer

required

Example:

20

from

string<date>

status

string

Response

Page of mandates

data

object

Show child attributes

message

string

code

string

description

string

status

boolean

API Documentation

Authenticate

Accounts

Virtual Accounts

Online Checkout

Charge

Direct Debits

Transfers

Terminals

Transactions

Requery

Global Payout

DRC Collection

Airtime & Data Vending

Cable & Bill Payments

Betting

Get mandates by filters

Authorizations

Headers

Query Parameters

Response