Create offramp account
curl --request POST \
--url https://external.dev.onboardpay.co/ledger/offramp-accounts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"payoutCurrency": "KES",
"beneficiaryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://external.dev.onboardpay.co/ledger/offramp-accounts"
payload = {
"payoutCurrency": "KES",
"beneficiaryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({payoutCurrency: 'KES', beneficiaryId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://external.dev.onboardpay.co/ledger/offramp-accounts', 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://external.dev.onboardpay.co/ledger/offramp-accounts",
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([
'payoutCurrency' => 'KES',
'beneficiaryId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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://external.dev.onboardpay.co/ledger/offramp-accounts"
payload := strings.NewReader("{\n \"payoutCurrency\": \"KES\",\n \"beneficiaryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://external.dev.onboardpay.co/ledger/offramp-accounts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payoutCurrency\": \"KES\",\n \"beneficiaryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://external.dev.onboardpay.co/ledger/offramp-accounts")
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 \"payoutCurrency\": \"KES\",\n \"beneficiaryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"beneficiary": {
"bankCode": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountNumber": "<string>",
"accountName": "<string>",
"currency": "<string>",
"bankName": "<string>",
"bankAddress": {
"streetAddress": "11 Main Street",
"city": "Gbagada",
"state": "Lagos",
"country": "NG",
"postalCode": "200124",
"apartmentNo": "5B"
},
"beneficiaryType": "<string>",
"isThirdParty": false
},
"payoutCurrency": "KES",
"createdDate": "2023-11-07T05:31:56Z"
}{
"code": "BAD_REQUEST",
"message": "Request could not be validated."
}{
"code": "UNAUTHORIZED",
"message": "Either client security header is missing or it is not valid."
}Offramp Accounts
Create Offramp Account
Create offramp account with beneficiary id.
POST
/
ledger
/
offramp-accounts
Create offramp account
curl --request POST \
--url https://external.dev.onboardpay.co/ledger/offramp-accounts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"payoutCurrency": "KES",
"beneficiaryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://external.dev.onboardpay.co/ledger/offramp-accounts"
payload = {
"payoutCurrency": "KES",
"beneficiaryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({payoutCurrency: 'KES', beneficiaryId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://external.dev.onboardpay.co/ledger/offramp-accounts', 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://external.dev.onboardpay.co/ledger/offramp-accounts",
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([
'payoutCurrency' => 'KES',
'beneficiaryId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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://external.dev.onboardpay.co/ledger/offramp-accounts"
payload := strings.NewReader("{\n \"payoutCurrency\": \"KES\",\n \"beneficiaryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://external.dev.onboardpay.co/ledger/offramp-accounts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payoutCurrency\": \"KES\",\n \"beneficiaryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://external.dev.onboardpay.co/ledger/offramp-accounts")
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 \"payoutCurrency\": \"KES\",\n \"beneficiaryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"beneficiary": {
"bankCode": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountNumber": "<string>",
"accountName": "<string>",
"currency": "<string>",
"bankName": "<string>",
"bankAddress": {
"streetAddress": "11 Main Street",
"city": "Gbagada",
"state": "Lagos",
"country": "NG",
"postalCode": "200124",
"apartmentNo": "5B"
},
"beneficiaryType": "<string>",
"isThirdParty": false
},
"payoutCurrency": "KES",
"createdDate": "2023-11-07T05:31:56Z"
}{
"code": "BAD_REQUEST",
"message": "Request could not be validated."
}{
"code": "UNAUTHORIZED",
"message": "Either client security header is missing or it is not valid."
}Creates an offramp account linked to a fiat beneficiary.
Authorizations
Requires authentication via API key and HMAC signature.
x-api-key: Your API key generated from your Onboard Business dashboard.x-timestamp: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 secondsx-signature: SHA256 HMAC HEX signature calculated overt={x-timestamp}&{requestBody}using your API Secret.
Body
application/json
Response
Offramp account created
Unique identifier for the offramp account.
Fiat beneficiary object
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
Example:
"KES"
Status of the offramp account.
Available options:
ACTIVE, INACTIVE, SUSPENDED ⌘I