Place an order (buy or sell)
curl --request POST \
--url https://api.myladder.africa/partner/v1/orders \
--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 '
{
"side": "buy",
"investment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"payment_mode": "wallet",
"holding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"units": "<string>",
"client_reference": "<string>",
"customer": {
"reference": "<string>",
"name": "<string>",
"email": "jsmith@example.com"
},
"metadata": {}
}
'import requests
url = "https://api.myladder.africa/partner/v1/orders"
payload = {
"side": "buy",
"investment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"payment_mode": "wallet",
"holding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"units": "<string>",
"client_reference": "<string>",
"customer": {
"reference": "<string>",
"name": "<string>",
"email": "jsmith@example.com"
},
"metadata": {}
}
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({
side: 'buy',
investment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount: '<string>',
payment_mode: 'wallet',
holding_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
units: '<string>',
client_reference: '<string>',
customer: {reference: '<string>', name: '<string>', email: 'jsmith@example.com'},
metadata: {}
})
};
fetch('https://api.myladder.africa/partner/v1/orders', 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/orders",
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([
'side' => 'buy',
'investment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => '<string>',
'payment_mode' => 'wallet',
'holding_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'units' => '<string>',
'client_reference' => '<string>',
'customer' => [
'reference' => '<string>',
'name' => '<string>',
'email' => 'jsmith@example.com'
],
'metadata' => [
]
]),
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/orders"
payload := strings.NewReader("{\n \"side\": \"buy\",\n \"investment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": \"<string>\",\n \"payment_mode\": \"wallet\",\n \"holding_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"units\": \"<string>\",\n \"client_reference\": \"<string>\",\n \"customer\": {\n \"reference\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n },\n \"metadata\": {}\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/orders")
.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 \"side\": \"buy\",\n \"investment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": \"<string>\",\n \"payment_mode\": \"wallet\",\n \"holding_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"units\": \"<string>\",\n \"client_reference\": \"<string>\",\n \"customer\": {\n \"reference\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n },\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.myladder.africa/partner/v1/orders")
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 \"side\": \"buy\",\n \"investment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": \"<string>\",\n \"payment_mode\": \"wallet\",\n \"holding_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"units\": \"<string>\",\n \"client_reference\": \"<string>\",\n \"customer\": {\n \"reference\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n },\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"investment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"investment_name": "<string>",
"amount": "<string>",
"currency": "GHS",
"payment_mode": "wallet",
"status": "awaiting_payment",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"client_reference": "<string>",
"side": "buy",
"units": "<string>",
"proceeds": "<string>",
"customer": "<string>",
"metadata": {},
"failure_reason": "<string>",
"payment": "<string>",
"holding_id": "<string>",
"paid_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"cancelled_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_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": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Orders
Place an order (buy or sell)
Buy (side=buy, default): investment_id, amount, currency. payment_mode=wallet debits the wallet in currency immediately (402 if short). payment_mode=checkout returns payment instructions; the order executes when that funding settles. currency must equal the investment’s currency. Live orders move to pending_fulfilment until the position is placed with the provider, then completed with a holding.
Sell (side=sell): holding_id and optional units (default: everything not already in a pending sell). amount is indicative (units × current price) and currency is the holding’s. The request waits in pending_fulfilment; when Ladder redeems the units the wallet is credited with proceeds and the holding’s units fall (it closes at zero). Test keys settle immediately at the indicative value.
POST
/
partner
/
v1
/
orders
Place an order (buy or sell)
curl --request POST \
--url https://api.myladder.africa/partner/v1/orders \
--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 '
{
"side": "buy",
"investment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"payment_mode": "wallet",
"holding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"units": "<string>",
"client_reference": "<string>",
"customer": {
"reference": "<string>",
"name": "<string>",
"email": "jsmith@example.com"
},
"metadata": {}
}
'import requests
url = "https://api.myladder.africa/partner/v1/orders"
payload = {
"side": "buy",
"investment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"payment_mode": "wallet",
"holding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"units": "<string>",
"client_reference": "<string>",
"customer": {
"reference": "<string>",
"name": "<string>",
"email": "jsmith@example.com"
},
"metadata": {}
}
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({
side: 'buy',
investment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount: '<string>',
payment_mode: 'wallet',
holding_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
units: '<string>',
client_reference: '<string>',
customer: {reference: '<string>', name: '<string>', email: 'jsmith@example.com'},
metadata: {}
})
};
fetch('https://api.myladder.africa/partner/v1/orders', 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/orders",
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([
'side' => 'buy',
'investment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => '<string>',
'payment_mode' => 'wallet',
'holding_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'units' => '<string>',
'client_reference' => '<string>',
'customer' => [
'reference' => '<string>',
'name' => '<string>',
'email' => 'jsmith@example.com'
],
'metadata' => [
]
]),
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/orders"
payload := strings.NewReader("{\n \"side\": \"buy\",\n \"investment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": \"<string>\",\n \"payment_mode\": \"wallet\",\n \"holding_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"units\": \"<string>\",\n \"client_reference\": \"<string>\",\n \"customer\": {\n \"reference\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n },\n \"metadata\": {}\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/orders")
.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 \"side\": \"buy\",\n \"investment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": \"<string>\",\n \"payment_mode\": \"wallet\",\n \"holding_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"units\": \"<string>\",\n \"client_reference\": \"<string>\",\n \"customer\": {\n \"reference\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n },\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.myladder.africa/partner/v1/orders")
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 \"side\": \"buy\",\n \"investment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": \"<string>\",\n \"payment_mode\": \"wallet\",\n \"holding_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"units\": \"<string>\",\n \"client_reference\": \"<string>\",\n \"customer\": {\n \"reference\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n },\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"investment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"investment_name": "<string>",
"amount": "<string>",
"currency": "GHS",
"payment_mode": "wallet",
"status": "awaiting_payment",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"client_reference": "<string>",
"side": "buy",
"units": "<string>",
"proceeds": "<string>",
"customer": "<string>",
"metadata": {},
"failure_reason": "<string>",
"payment": "<string>",
"holding_id": "<string>",
"paid_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"cancelled_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_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": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
Your key id: pk_test_… (sandbox) or pk_live_… (live).
Unix seconds, as a string; must be within 5 minutes of server time.
Lower-case hex HMAC-SHA512 over timestamp, method, path+query and the SHA-256 of the body. See Authentication.
Headers
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
Available options:
buy, sell Available options:
GHS, USD, NGN Available options:
wallet, checkout Maximum string length:
100Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Show child attributes
Show child attributes