Create a direct-debit mandate

curl --request POST \
  --url https://api.myladder.africa/partner/v1/mandates \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Ladder-Key: <api-key>' \
  --header 'X-Ladder-Signature: <api-key>' \
  --header 'X-Ladder-Timestamp: <api-key>' \
  --data '
{
  "settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "limit_amount": "<string>"
}
'

import requests

url = "https://api.myladder.africa/partner/v1/mandates"

payload = {
    "settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "limit_amount": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-Ladder-Key": "<api-key>",
    "X-Ladder-Timestamp": "<api-key>",
    "X-Ladder-Signature": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-Ladder-Key': '<api-key>',
    'X-Ladder-Timestamp': '<api-key>',
    'X-Ladder-Signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    settlement_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    limit_amount: '<string>'
  })
};

fetch('https://api.myladder.africa/partner/v1/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.myladder.africa/partner/v1/mandates",
  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([
    'settlement_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'limit_amount' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-Ladder-Key: <api-key>",
    "X-Ladder-Signature: <api-key>",
    "X-Ladder-Timestamp: <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.myladder.africa/partner/v1/mandates"

	payload := strings.NewReader("{\n  \"settlement_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"limit_amount\": \"<string>\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-Ladder-Key", "<api-key>")
	req.Header.Add("X-Ladder-Timestamp", "<api-key>")
	req.Header.Add("X-Ladder-Signature", "<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.myladder.africa/partner/v1/mandates")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-Ladder-Key", "<api-key>")
  .header("X-Ladder-Timestamp", "<api-key>")
  .header("X-Ladder-Signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"settlement_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"limit_amount\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.myladder.africa/partner/v1/mandates")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-Ladder-Key"] = '<api-key>'
request["X-Ladder-Timestamp"] = '<api-key>'
request["X-Ladder-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"settlement_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"limit_amount\": \"<string>\"\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reference": "<string>",
    "status": "pending",
    "currency": "GHS",
    "bank_code": "<string>",
    "bank_name": "<string>",
    "account_number_masked": "<string>",
    "account_name": "<string>",
    "limit_amount": "<string>",
    "settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": "<string>",
    "provider_reference": "<string>",
    "activation": "<string>",
    "activated_at": "2023-11-07T05:31:56Z",
    "revoked_at": "2023-11-07T05:31:56Z",
    "last_debit_at": "2023-11-07T05:31:56Z",
    "failure_reason": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

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

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

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

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

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

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

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

Direct-debit mandates

Create a direct-debit mandate

Takes a NIBSS e-mandate on one of your NGN settlement accounts (Flutterwave). The response is pending with an activation block: the account holder makes the stated token payment (typically NGN 100) from the mandated account into activation.account_number; the bank then confirms, status becomes active, activation becomes null and mandate.activated is sent. A failed mandate carries the provider’s reason in failure_reason and does not block a new attempt. Test keys get an active mandate immediately. Then fund with method=flutterwave_direct_debit.

POST

partner

mandates

curl --request POST \
  --url https://api.myladder.africa/partner/v1/mandates \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Ladder-Key: <api-key>' \
  --header 'X-Ladder-Signature: <api-key>' \
  --header 'X-Ladder-Timestamp: <api-key>' \
  --data '
{
  "settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "limit_amount": "<string>"
}
'

import requests

url = "https://api.myladder.africa/partner/v1/mandates"

payload = {
    "settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "limit_amount": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-Ladder-Key": "<api-key>",
    "X-Ladder-Timestamp": "<api-key>",
    "X-Ladder-Signature": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-Ladder-Key': '<api-key>',
    'X-Ladder-Timestamp': '<api-key>',
    'X-Ladder-Signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    settlement_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    limit_amount: '<string>'
  })
};

fetch('https://api.myladder.africa/partner/v1/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.myladder.africa/partner/v1/mandates",
  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([
    'settlement_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'limit_amount' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-Ladder-Key: <api-key>",
    "X-Ladder-Signature: <api-key>",
    "X-Ladder-Timestamp: <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.myladder.africa/partner/v1/mandates"

	payload := strings.NewReader("{\n  \"settlement_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"limit_amount\": \"<string>\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-Ladder-Key", "<api-key>")
	req.Header.Add("X-Ladder-Timestamp", "<api-key>")
	req.Header.Add("X-Ladder-Signature", "<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.myladder.africa/partner/v1/mandates")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-Ladder-Key", "<api-key>")
  .header("X-Ladder-Timestamp", "<api-key>")
  .header("X-Ladder-Signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"settlement_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"limit_amount\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.myladder.africa/partner/v1/mandates")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-Ladder-Key"] = '<api-key>'
request["X-Ladder-Timestamp"] = '<api-key>'
request["X-Ladder-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"settlement_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"limit_amount\": \"<string>\"\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reference": "<string>",
    "status": "pending",
    "currency": "GHS",
    "bank_code": "<string>",
    "bank_name": "<string>",
    "account_number_masked": "<string>",
    "account_name": "<string>",
    "limit_amount": "<string>",
    "settlement_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": "<string>",
    "provider_reference": "<string>",
    "activation": "<string>",
    "activated_at": "2023-11-07T05:31:56Z",
    "revoked_at": "2023-11-07T05:31:56Z",
    "last_debit_at": "2023-11-07T05:31:56Z",
    "failure_reason": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

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

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

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

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

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

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

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

Authorizations

X-Ladder-Key

string

header

required

Your key id: pk_test_… (sandbox) or pk_live_… (live).

X-Ladder-Timestamp

string

header

required

Unix seconds, as a string; must be within 5 minutes of server time.

X-Ladder-Signature

string

header

required

Lower-case hex HMAC-SHA512 over timestamp, method, path+query and the SHA-256 of the body. See Authentication.

Headers

Idempotency-Key

string

required

Unique per logical request (max 255 chars). A retry with the same key and body returns the original response with Idempotent-Replayed: true; a different body returns 409.

Body

application/json

settlement_account_id

string<uuid>

required

One of your NGN settlement accounts; the mandate is taken on that account.

limit_amount

string<decimal>

required

Maximum NGN per debit the account holder approves.

Response

data

object

required

Show child attributes

Organisation

KYB

Wallets and funding

Direct-debit mandates

Investments

Market data

Orders

Holdings

Webhooks

Sandbox

Create a direct-debit mandate

Authorizations

Headers

Body

Response