Create Checkout Wallet
curl --request POST \
--url https://checkout-staging.embedly.ng/api/v1/checkout-wallet \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"organizationId": "<string>",
"expectedAmount": 123,
"organizationPrefixMappingId": "<string>",
"expiryDurationMinutes": 123,
"invoiceReference": "<string>",
"description": "<string>",
"currencyCode": "<string>",
"customerEmail": "<string>",
"customerName": "<string>",
"metadata": "<string>",
"splitType": "<string>",
"incomeSplitConfig": [
{}
],
"accountInquiryResponseName": "<string>"
}
'import requests
url = "https://checkout-staging.embedly.ng/api/v1/checkout-wallet"
payload = {
"organizationId": "<string>",
"expectedAmount": 123,
"organizationPrefixMappingId": "<string>",
"expiryDurationMinutes": 123,
"invoiceReference": "<string>",
"description": "<string>",
"currencyCode": "<string>",
"customerEmail": "<string>",
"customerName": "<string>",
"metadata": "<string>",
"splitType": "<string>",
"incomeSplitConfig": [{}],
"accountInquiryResponseName": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
organizationId: '<string>',
expectedAmount: 123,
organizationPrefixMappingId: '<string>',
expiryDurationMinutes: 123,
invoiceReference: '<string>',
description: '<string>',
currencyCode: '<string>',
customerEmail: '<string>',
customerName: '<string>',
metadata: '<string>',
splitType: '<string>',
incomeSplitConfig: [{}],
accountInquiryResponseName: '<string>'
})
};
fetch('https://checkout-staging.embedly.ng/api/v1/checkout-wallet', 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://checkout-staging.embedly.ng/api/v1/checkout-wallet",
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([
'organizationId' => '<string>',
'expectedAmount' => 123,
'organizationPrefixMappingId' => '<string>',
'expiryDurationMinutes' => 123,
'invoiceReference' => '<string>',
'description' => '<string>',
'currencyCode' => '<string>',
'customerEmail' => '<string>',
'customerName' => '<string>',
'metadata' => '<string>',
'splitType' => '<string>',
'incomeSplitConfig' => [
[
]
],
'accountInquiryResponseName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://checkout-staging.embedly.ng/api/v1/checkout-wallet"
payload := strings.NewReader("{\n \"organizationId\": \"<string>\",\n \"expectedAmount\": 123,\n \"organizationPrefixMappingId\": \"<string>\",\n \"expiryDurationMinutes\": 123,\n \"invoiceReference\": \"<string>\",\n \"description\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"customerEmail\": \"<string>\",\n \"customerName\": \"<string>\",\n \"metadata\": \"<string>\",\n \"splitType\": \"<string>\",\n \"incomeSplitConfig\": [\n {}\n ],\n \"accountInquiryResponseName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://checkout-staging.embedly.ng/api/v1/checkout-wallet")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organizationId\": \"<string>\",\n \"expectedAmount\": 123,\n \"organizationPrefixMappingId\": \"<string>\",\n \"expiryDurationMinutes\": 123,\n \"invoiceReference\": \"<string>\",\n \"description\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"customerEmail\": \"<string>\",\n \"customerName\": \"<string>\",\n \"metadata\": \"<string>\",\n \"splitType\": \"<string>\",\n \"incomeSplitConfig\": [\n {}\n ],\n \"accountInquiryResponseName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://checkout-staging.embedly.ng/api/v1/checkout-wallet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organizationId\": \"<string>\",\n \"expectedAmount\": 123,\n \"organizationPrefixMappingId\": \"<string>\",\n \"expiryDurationMinutes\": 123,\n \"invoiceReference\": \"<string>\",\n \"description\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"customerEmail\": \"<string>\",\n \"customerName\": \"<string>\",\n \"metadata\": \"<string>\",\n \"splitType\": \"<string>\",\n \"incomeSplitConfig\": [\n {}\n ],\n \"accountInquiryResponseName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 200,
"message": "Checkout wallet reactivated successfully",
"data": {
"id": "bfce68af-4b43-4827-abb8-985a2d3b8a79",
"walletNumber": "2225657965",
"organizationId": "02600494-1a3c-11f0-a818-6045bd97b81d",
"walletName": "Embedly Check Demo",
"status": "Reactivated",
"createdAt": "2025-07-14T16:47:32.297357Z",
"expiresAt": "2025-07-24T14:28:01.1254478Z",
"reactivatedAt": "2025-07-24T13:58:01.1254127Z",
"expectedAmount": 20000,
"checkoutRef": "CHK202507241358013544205"
}
}
{
"statusCode": 400,
"message": "Specified organization prefix mapping not found",
"data": null
}
{
"code": "401",
"success": false,
"message": "x-api-key is missing in the header",
"data": null
}
{
"statusCode": 403,
"message": "Access denied. The API key provided is for another organization. You can only access your organization's wallets.",
"data": null
}
{
"code": "500",
"success": false,
"message": "An unexpected error occurred",
"data": null
}
Checkout
Create Checkout Wallet
This endpoint generates a new checkout wallet for an organization. Organization must be active and have configured primary and secondary prefixes.
POST
/
api
/
v1
/
checkout-wallet
Create Checkout Wallet
curl --request POST \
--url https://checkout-staging.embedly.ng/api/v1/checkout-wallet \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"organizationId": "<string>",
"expectedAmount": 123,
"organizationPrefixMappingId": "<string>",
"expiryDurationMinutes": 123,
"invoiceReference": "<string>",
"description": "<string>",
"currencyCode": "<string>",
"customerEmail": "<string>",
"customerName": "<string>",
"metadata": "<string>",
"splitType": "<string>",
"incomeSplitConfig": [
{}
],
"accountInquiryResponseName": "<string>"
}
'import requests
url = "https://checkout-staging.embedly.ng/api/v1/checkout-wallet"
payload = {
"organizationId": "<string>",
"expectedAmount": 123,
"organizationPrefixMappingId": "<string>",
"expiryDurationMinutes": 123,
"invoiceReference": "<string>",
"description": "<string>",
"currencyCode": "<string>",
"customerEmail": "<string>",
"customerName": "<string>",
"metadata": "<string>",
"splitType": "<string>",
"incomeSplitConfig": [{}],
"accountInquiryResponseName": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
organizationId: '<string>',
expectedAmount: 123,
organizationPrefixMappingId: '<string>',
expiryDurationMinutes: 123,
invoiceReference: '<string>',
description: '<string>',
currencyCode: '<string>',
customerEmail: '<string>',
customerName: '<string>',
metadata: '<string>',
splitType: '<string>',
incomeSplitConfig: [{}],
accountInquiryResponseName: '<string>'
})
};
fetch('https://checkout-staging.embedly.ng/api/v1/checkout-wallet', 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://checkout-staging.embedly.ng/api/v1/checkout-wallet",
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([
'organizationId' => '<string>',
'expectedAmount' => 123,
'organizationPrefixMappingId' => '<string>',
'expiryDurationMinutes' => 123,
'invoiceReference' => '<string>',
'description' => '<string>',
'currencyCode' => '<string>',
'customerEmail' => '<string>',
'customerName' => '<string>',
'metadata' => '<string>',
'splitType' => '<string>',
'incomeSplitConfig' => [
[
]
],
'accountInquiryResponseName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://checkout-staging.embedly.ng/api/v1/checkout-wallet"
payload := strings.NewReader("{\n \"organizationId\": \"<string>\",\n \"expectedAmount\": 123,\n \"organizationPrefixMappingId\": \"<string>\",\n \"expiryDurationMinutes\": 123,\n \"invoiceReference\": \"<string>\",\n \"description\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"customerEmail\": \"<string>\",\n \"customerName\": \"<string>\",\n \"metadata\": \"<string>\",\n \"splitType\": \"<string>\",\n \"incomeSplitConfig\": [\n {}\n ],\n \"accountInquiryResponseName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://checkout-staging.embedly.ng/api/v1/checkout-wallet")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organizationId\": \"<string>\",\n \"expectedAmount\": 123,\n \"organizationPrefixMappingId\": \"<string>\",\n \"expiryDurationMinutes\": 123,\n \"invoiceReference\": \"<string>\",\n \"description\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"customerEmail\": \"<string>\",\n \"customerName\": \"<string>\",\n \"metadata\": \"<string>\",\n \"splitType\": \"<string>\",\n \"incomeSplitConfig\": [\n {}\n ],\n \"accountInquiryResponseName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://checkout-staging.embedly.ng/api/v1/checkout-wallet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organizationId\": \"<string>\",\n \"expectedAmount\": 123,\n \"organizationPrefixMappingId\": \"<string>\",\n \"expiryDurationMinutes\": 123,\n \"invoiceReference\": \"<string>\",\n \"description\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"customerEmail\": \"<string>\",\n \"customerName\": \"<string>\",\n \"metadata\": \"<string>\",\n \"splitType\": \"<string>\",\n \"incomeSplitConfig\": [\n {}\n ],\n \"accountInquiryResponseName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 200,
"message": "Checkout wallet reactivated successfully",
"data": {
"id": "bfce68af-4b43-4827-abb8-985a2d3b8a79",
"walletNumber": "2225657965",
"organizationId": "02600494-1a3c-11f0-a818-6045bd97b81d",
"walletName": "Embedly Check Demo",
"status": "Reactivated",
"createdAt": "2025-07-14T16:47:32.297357Z",
"expiresAt": "2025-07-24T14:28:01.1254478Z",
"reactivatedAt": "2025-07-24T13:58:01.1254127Z",
"expectedAmount": 20000,
"checkoutRef": "CHK202507241358013544205"
}
}
{
"statusCode": 400,
"message": "Specified organization prefix mapping not found",
"data": null
}
{
"code": "401",
"success": false,
"message": "x-api-key is missing in the header",
"data": null
}
{
"statusCode": 403,
"message": "Access denied. The API key provided is for another organization. You can only access your organization's wallets.",
"data": null
}
{
"code": "500",
"success": false,
"message": "An unexpected error occurred",
"data": null
}
When a checkout wallet is generated without an ‘expiryDurationMinutes’, the
system default of 30 minutes is applied to that wallet.
Example:
8b4432bc-f3c7-4055-b5e5-e232707e79af. You can get this Id using
the ‘Get Organization Prefix Mapping Endpoint’This can either be Fixed or Percentage. This property is required when it is a
split payment. Example:
Fixed.Required for split payments. Defines the distribution of funds among multiple beneficiaries.
Example:
Show Properties
Show Properties
- beneficiaryId (string): The unique UUID of the recipient.
- splitValue (number): The amount or percentage to be allocated.
- feeValue (number): The specific fee amount to be deducted.
- feeBearer (boolean): Set to
trueif this beneficiary covers the transaction fees.
[{ "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "splitValue": 100, "feeValue": 5, "feeBearer": true }]Pass this to determine the name that should show when you validate the account
number on banking applications. Example:
John Doe.{
"statusCode": 200,
"message": "Checkout wallet reactivated successfully",
"data": {
"id": "bfce68af-4b43-4827-abb8-985a2d3b8a79",
"walletNumber": "2225657965",
"organizationId": "02600494-1a3c-11f0-a818-6045bd97b81d",
"walletName": "Embedly Check Demo",
"status": "Reactivated",
"createdAt": "2025-07-14T16:47:32.297357Z",
"expiresAt": "2025-07-24T14:28:01.1254478Z",
"reactivatedAt": "2025-07-24T13:58:01.1254127Z",
"expectedAmount": 20000,
"checkoutRef": "CHK202507241358013544205"
}
}
{
"statusCode": 400,
"message": "Specified organization prefix mapping not found",
"data": null
}
{
"code": "401",
"success": false,
"message": "x-api-key is missing in the header",
"data": null
}
{
"statusCode": 403,
"message": "Access denied. The API key provided is for another organization. You can only access your organization's wallets.",
"data": null
}
{
"code": "500",
"success": false,
"message": "An unexpected error occurred",
"data": null
}