curl --request POST \
--url https://api.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Numero-Api-Key: <api-key>' \
--header 'X-Numero-Signature: <api-key>' \
--data '
{
"amount": 123,
"destinationAccountNumber": "<string>",
"destinationBankCode": "<string>",
"destinationAccountName": "<string>",
"narrative": "<string>"
}
'import requests
url = "https://api.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout"
payload = {
"amount": 123,
"destinationAccountNumber": "<string>",
"destinationBankCode": "<string>",
"destinationAccountName": "<string>",
"narrative": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-Numero-Api-Key": "<api-key>",
"X-Numero-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-Numero-Api-Key': '<api-key>',
'X-Numero-Signature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 123,
destinationAccountNumber: '<string>',
destinationBankCode: '<string>',
destinationAccountName: '<string>',
narrative: '<string>'
})
};
fetch('https://api.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout', 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.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout",
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' => 123,
'destinationAccountNumber' => '<string>',
'destinationBankCode' => '<string>',
'destinationAccountName' => '<string>',
'narrative' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"X-Numero-Api-Key: <api-key>",
"X-Numero-Signature: <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.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout"
payload := strings.NewReader("{\n \"amount\": 123,\n \"destinationAccountNumber\": \"<string>\",\n \"destinationBankCode\": \"<string>\",\n \"destinationAccountName\": \"<string>\",\n \"narrative\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("X-Numero-Api-Key", "<api-key>")
req.Header.Add("X-Numero-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.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout")
.header("Idempotency-Key", "<idempotency-key>")
.header("X-Numero-Api-Key", "<api-key>")
.header("X-Numero-Signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"destinationAccountNumber\": \"<string>\",\n \"destinationBankCode\": \"<string>\",\n \"destinationAccountName\": \"<string>\",\n \"narrative\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout")
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-Numero-Api-Key"] = '<api-key>'
request["X-Numero-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"destinationAccountNumber\": \"<string>\",\n \"destinationBankCode\": \"<string>\",\n \"destinationAccountName\": \"<string>\",\n \"narrative\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"payoutReference": "<string>",
"walletReference": "<string>",
"amount": 123,
"fee": 123,
"currency": "NGN",
"destinationAccountNumber": "<string>",
"destinationAccountName": "<string>",
"destinationBankCode": "<string>",
"status": "<string>",
"statusReason": "<string>",
"walletAvailableBalance": 123,
"createdAt": "2023-11-07T05:31:56Z"
},
"error": {
"code": "missing_field",
"message": "<string>",
"param": "<string>"
},
"meta": {
"request_id": "<string>",
"pagination": {
"page": 123,
"page_size": 123,
"total": 123,
"has_more": true
}
}
}Pay out from a wallet to a bank account π
Send money from this wallet to an external bank account. Requires KYC tier 2 and must sit within the customerβs velocity limits. Funds are reserved immediately and the payout returns in Held, settling when the bank transfer completes.
curl --request POST \
--url https://api.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Numero-Api-Key: <api-key>' \
--header 'X-Numero-Signature: <api-key>' \
--data '
{
"amount": 123,
"destinationAccountNumber": "<string>",
"destinationBankCode": "<string>",
"destinationAccountName": "<string>",
"narrative": "<string>"
}
'import requests
url = "https://api.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout"
payload = {
"amount": 123,
"destinationAccountNumber": "<string>",
"destinationBankCode": "<string>",
"destinationAccountName": "<string>",
"narrative": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-Numero-Api-Key": "<api-key>",
"X-Numero-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-Numero-Api-Key': '<api-key>',
'X-Numero-Signature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 123,
destinationAccountNumber: '<string>',
destinationBankCode: '<string>',
destinationAccountName: '<string>',
narrative: '<string>'
})
};
fetch('https://api.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout', 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.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout",
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' => 123,
'destinationAccountNumber' => '<string>',
'destinationBankCode' => '<string>',
'destinationAccountName' => '<string>',
'narrative' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"X-Numero-Api-Key: <api-key>",
"X-Numero-Signature: <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.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout"
payload := strings.NewReader("{\n \"amount\": 123,\n \"destinationAccountNumber\": \"<string>\",\n \"destinationBankCode\": \"<string>\",\n \"destinationAccountName\": \"<string>\",\n \"narrative\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("X-Numero-Api-Key", "<api-key>")
req.Header.Add("X-Numero-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.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout")
.header("Idempotency-Key", "<idempotency-key>")
.header("X-Numero-Api-Key", "<api-key>")
.header("X-Numero-Signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"destinationAccountNumber\": \"<string>\",\n \"destinationBankCode\": \"<string>\",\n \"destinationAccountName\": \"<string>\",\n \"narrative\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usenumero.com/numeroaccount/api/v1/wallets/{walletReference}/payout")
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-Numero-Api-Key"] = '<api-key>'
request["X-Numero-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"destinationAccountNumber\": \"<string>\",\n \"destinationBankCode\": \"<string>\",\n \"destinationAccountName\": \"<string>\",\n \"narrative\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"payoutReference": "<string>",
"walletReference": "<string>",
"amount": 123,
"fee": 123,
"currency": "NGN",
"destinationAccountNumber": "<string>",
"destinationAccountName": "<string>",
"destinationBankCode": "<string>",
"status": "<string>",
"statusReason": "<string>",
"walletAvailableBalance": 123,
"createdAt": "2023-11-07T05:31:56Z"
},
"error": {
"code": "missing_field",
"message": "<string>",
"param": "<string>"
},
"meta": {
"request_id": "<string>",
"pagination": {
"page": 123,
"page_size": 123,
"total": 123,
"has_more": true
}
}
}Authorizations
Your business API key (live_key_...). Issued on approval; managed in Dashboard β Settings β Developer.
Base64(HMAC-SHA256(publicApiKey, input)) over the raw request body (POST) or canonicalized
query string (signed GET). Also send X-Numero-Signature-Version: v2. Required on
money-movement / state-changing endpoints (marked π).
The HMAC key is your Public Key as raw UTF-8 bytes β a SECRET despite the name, and a
different value from the X-Numero-Api-Key authentication header. Signing with the API key
will never produce a valid signature.
Headers
A unique string you generate per logical operation. Replaying the same key returns the original result rather than moving money twice; reusing it with a different body is a conflict.
Path Parameters
The wallet's reference, as returned when the wallet was created.
Body
Response
The payout