cURL
curl --request POST \
--url https://api.nomba.com/v1/global-payout/transfer/authorize \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'accountId: <accountid>' \
--data '
{
"amount": 500,
"sourceCurrency": "USD",
"destinationCurrency": "USD",
"receiverName": "John Cena",
"sourceCountryIsoCode": "CD",
"destinationCountryIsoCode": "CD",
"paymentMethod": "MobileMoney",
"accountType": "INDIVIDUAL",
"accountNumber": "0903086112",
"institutionCode": "access_bank",
"institutionName": "Mpesa",
"bankAccountType": "CHECKING",
"purposeOfPayment": "FAMILY_SUPPORT",
"narration": "Family support",
"lockedExchangeRateId": "01k7pcakf0t8g03rvny3z5mr1p",
"idempotencyKey": "5e246f9a-3e79-4b11-92f1-dbd98b53b308",
"bankAddress": "383 Madison Avenue",
"bankCity": "New York",
"bankState": "NY",
"bankZipCode": "10017",
"beneficiary": {
"beneficiaryEmail": "[email protected]",
"securityQuestion": "What is your pets name?",
"securityQuestionAnswer": "Fluffy",
"transitNumber": "<string>",
"beneficiaryAddress": "123 Main Street",
"beneficiaryCity": "New York",
"beneficiaryState": "NY",
"beneficiaryPostCode": "10001"
}
}
'import requests
url = "https://api.nomba.com/v1/global-payout/transfer/authorize"
payload = {
"amount": 500,
"sourceCurrency": "USD",
"destinationCurrency": "USD",
"receiverName": "John Cena",
"sourceCountryIsoCode": "CD",
"destinationCountryIsoCode": "CD",
"paymentMethod": "MobileMoney",
"accountType": "INDIVIDUAL",
"accountNumber": "0903086112",
"institutionCode": "access_bank",
"institutionName": "Mpesa",
"bankAccountType": "CHECKING",
"purposeOfPayment": "FAMILY_SUPPORT",
"narration": "Family support",
"lockedExchangeRateId": "01k7pcakf0t8g03rvny3z5mr1p",
"idempotencyKey": "5e246f9a-3e79-4b11-92f1-dbd98b53b308",
"bankAddress": "383 Madison Avenue",
"bankCity": "New York",
"bankState": "NY",
"bankZipCode": "10017",
"beneficiary": {
"beneficiaryEmail": "[email protected]",
"securityQuestion": "What is your pets name?",
"securityQuestionAnswer": "Fluffy",
"transitNumber": "<string>",
"beneficiaryAddress": "123 Main Street",
"beneficiaryCity": "New York",
"beneficiaryState": "NY",
"beneficiaryPostCode": "10001"
}
}
headers = {
"Authorization": "<authorization>",
"accountId": "<accountid>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
accountId: '<accountid>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 500,
sourceCurrency: 'USD',
destinationCurrency: 'USD',
receiverName: 'John Cena',
sourceCountryIsoCode: 'CD',
destinationCountryIsoCode: 'CD',
paymentMethod: 'MobileMoney',
accountType: 'INDIVIDUAL',
accountNumber: '0903086112',
institutionCode: 'access_bank',
institutionName: 'Mpesa',
bankAccountType: 'CHECKING',
purposeOfPayment: 'FAMILY_SUPPORT',
narration: 'Family support',
lockedExchangeRateId: '01k7pcakf0t8g03rvny3z5mr1p',
idempotencyKey: '5e246f9a-3e79-4b11-92f1-dbd98b53b308',
bankAddress: '383 Madison Avenue',
bankCity: 'New York',
bankState: 'NY',
bankZipCode: '10017',
beneficiary: {
beneficiaryEmail: '[email protected]',
securityQuestion: 'What is your pets name?',
securityQuestionAnswer: 'Fluffy',
transitNumber: '<string>',
beneficiaryAddress: '123 Main Street',
beneficiaryCity: 'New York',
beneficiaryState: 'NY',
beneficiaryPostCode: '10001'
}
})
};
fetch('https://api.nomba.com/v1/global-payout/transfer/authorize', 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.nomba.com/v1/global-payout/transfer/authorize",
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' => 500,
'sourceCurrency' => 'USD',
'destinationCurrency' => 'USD',
'receiverName' => 'John Cena',
'sourceCountryIsoCode' => 'CD',
'destinationCountryIsoCode' => 'CD',
'paymentMethod' => 'MobileMoney',
'accountType' => 'INDIVIDUAL',
'accountNumber' => '0903086112',
'institutionCode' => 'access_bank',
'institutionName' => 'Mpesa',
'bankAccountType' => 'CHECKING',
'purposeOfPayment' => 'FAMILY_SUPPORT',
'narration' => 'Family support',
'lockedExchangeRateId' => '01k7pcakf0t8g03rvny3z5mr1p',
'idempotencyKey' => '5e246f9a-3e79-4b11-92f1-dbd98b53b308',
'bankAddress' => '383 Madison Avenue',
'bankCity' => 'New York',
'bankState' => 'NY',
'bankZipCode' => '10017',
'beneficiary' => [
'beneficiaryEmail' => '[email protected]',
'securityQuestion' => 'What is your pets name?',
'securityQuestionAnswer' => 'Fluffy',
'transitNumber' => '<string>',
'beneficiaryAddress' => '123 Main Street',
'beneficiaryCity' => 'New York',
'beneficiaryState' => 'NY',
'beneficiaryPostCode' => '10001'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"accountId: <accountid>"
],
]);
$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.nomba.com/v1/global-payout/transfer/authorize"
payload := strings.NewReader("{\n \"amount\": 500,\n \"sourceCurrency\": \"USD\",\n \"destinationCurrency\": \"USD\",\n \"receiverName\": \"John Cena\",\n \"sourceCountryIsoCode\": \"CD\",\n \"destinationCountryIsoCode\": \"CD\",\n \"paymentMethod\": \"MobileMoney\",\n \"accountType\": \"INDIVIDUAL\",\n \"accountNumber\": \"0903086112\",\n \"institutionCode\": \"access_bank\",\n \"institutionName\": \"Mpesa\",\n \"bankAccountType\": \"CHECKING\",\n \"purposeOfPayment\": \"FAMILY_SUPPORT\",\n \"narration\": \"Family support\",\n \"lockedExchangeRateId\": \"01k7pcakf0t8g03rvny3z5mr1p\",\n \"idempotencyKey\": \"5e246f9a-3e79-4b11-92f1-dbd98b53b308\",\n \"bankAddress\": \"383 Madison Avenue\",\n \"bankCity\": \"New York\",\n \"bankState\": \"NY\",\n \"bankZipCode\": \"10017\",\n \"beneficiary\": {\n \"beneficiaryEmail\": \"[email protected]\",\n \"securityQuestion\": \"What is your pets name?\",\n \"securityQuestionAnswer\": \"Fluffy\",\n \"transitNumber\": \"<string>\",\n \"beneficiaryAddress\": \"123 Main Street\",\n \"beneficiaryCity\": \"New York\",\n \"beneficiaryState\": \"NY\",\n \"beneficiaryPostCode\": \"10001\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("accountId", "<accountid>")
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.nomba.com/v1/global-payout/transfer/authorize")
.header("Authorization", "<authorization>")
.header("accountId", "<accountid>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 500,\n \"sourceCurrency\": \"USD\",\n \"destinationCurrency\": \"USD\",\n \"receiverName\": \"John Cena\",\n \"sourceCountryIsoCode\": \"CD\",\n \"destinationCountryIsoCode\": \"CD\",\n \"paymentMethod\": \"MobileMoney\",\n \"accountType\": \"INDIVIDUAL\",\n \"accountNumber\": \"0903086112\",\n \"institutionCode\": \"access_bank\",\n \"institutionName\": \"Mpesa\",\n \"bankAccountType\": \"CHECKING\",\n \"purposeOfPayment\": \"FAMILY_SUPPORT\",\n \"narration\": \"Family support\",\n \"lockedExchangeRateId\": \"01k7pcakf0t8g03rvny3z5mr1p\",\n \"idempotencyKey\": \"5e246f9a-3e79-4b11-92f1-dbd98b53b308\",\n \"bankAddress\": \"383 Madison Avenue\",\n \"bankCity\": \"New York\",\n \"bankState\": \"NY\",\n \"bankZipCode\": \"10017\",\n \"beneficiary\": {\n \"beneficiaryEmail\": \"[email protected]\",\n \"securityQuestion\": \"What is your pets name?\",\n \"securityQuestionAnswer\": \"Fluffy\",\n \"transitNumber\": \"<string>\",\n \"beneficiaryAddress\": \"123 Main Street\",\n \"beneficiaryCity\": \"New York\",\n \"beneficiaryState\": \"NY\",\n \"beneficiaryPostCode\": \"10001\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nomba.com/v1/global-payout/transfer/authorize")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["accountId"] = '<accountid>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 500,\n \"sourceCurrency\": \"USD\",\n \"destinationCurrency\": \"USD\",\n \"receiverName\": \"John Cena\",\n \"sourceCountryIsoCode\": \"CD\",\n \"destinationCountryIsoCode\": \"CD\",\n \"paymentMethod\": \"MobileMoney\",\n \"accountType\": \"INDIVIDUAL\",\n \"accountNumber\": \"0903086112\",\n \"institutionCode\": \"access_bank\",\n \"institutionName\": \"Mpesa\",\n \"bankAccountType\": \"CHECKING\",\n \"purposeOfPayment\": \"FAMILY_SUPPORT\",\n \"narration\": \"Family support\",\n \"lockedExchangeRateId\": \"01k7pcakf0t8g03rvny3z5mr1p\",\n \"idempotencyKey\": \"5e246f9a-3e79-4b11-92f1-dbd98b53b308\",\n \"bankAddress\": \"383 Madison Avenue\",\n \"bankCity\": \"New York\",\n \"bankState\": \"NY\",\n \"bankZipCode\": \"10017\",\n \"beneficiary\": {\n \"beneficiaryEmail\": \"[email protected]\",\n \"securityQuestion\": \"What is your pets name?\",\n \"securityQuestionAnswer\": \"Fluffy\",\n \"transitNumber\": \"<string>\",\n \"beneficiaryAddress\": \"123 Main Street\",\n \"beneficiaryCity\": \"New York\",\n \"beneficiaryState\": \"NY\",\n \"beneficiaryPostCode\": \"10001\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": "00",
"description": "Successful",
"data": {
"wtTransactionId": "01kky197w3xc6wyjenpc5r0tnp",
"coreTransactionId": "API-FX_TX_DR-08A1B-6add611a-e538-4e67-bcf9-661c77a16804",
"status": "PROCESSING",
"coreStatus": "PAYMENT_SUCCESSFUL",
"type": "TRANSFER",
"idempotencyKey": "5e246f9a-3e79-4b11-92f1-dbd98b53b308",
"idempotentReplay": false,
"prettyStatus": "Successful",
"meta": {
"source_amount": "250.0",
"destination_amount": "250.0",
"source_currency": "USD",
"destination_currency": "USD",
"amount_charged": "255.0",
"currency_pair_name": "USD/USD",
"payment_method": "MobileMoney",
"destination_country": "CD",
"destination_country_name": "Congo DR",
"source_country": "CD",
"narration": "Family support",
"trade_side": "BUY",
"spread_amount": "0.0",
"spread_currency": "USD",
"wt_transaction_id": "01kky197w3xc6wyjenpc5r0tnp",
"trade_context": "default",
"transactionCategory": "General",
"payment_destination_type": "Account",
"tradeType": "FIXED_TRADE"
}
}
}Global Payout
Authorize transfer
Initiate and authorize a cross-border transfer. Manages the complete transfer lifecycle from initiation to final authorization. Supports BANK, MobileMoney, INTERAC, FASTER_PAYMENTS, SEPA, ACH, and WIRE payment methods.
POST
/
v1
/
global-payout
/
transfer
/
authorize
cURL
curl --request POST \
--url https://api.nomba.com/v1/global-payout/transfer/authorize \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'accountId: <accountid>' \
--data '
{
"amount": 500,
"sourceCurrency": "USD",
"destinationCurrency": "USD",
"receiverName": "John Cena",
"sourceCountryIsoCode": "CD",
"destinationCountryIsoCode": "CD",
"paymentMethod": "MobileMoney",
"accountType": "INDIVIDUAL",
"accountNumber": "0903086112",
"institutionCode": "access_bank",
"institutionName": "Mpesa",
"bankAccountType": "CHECKING",
"purposeOfPayment": "FAMILY_SUPPORT",
"narration": "Family support",
"lockedExchangeRateId": "01k7pcakf0t8g03rvny3z5mr1p",
"idempotencyKey": "5e246f9a-3e79-4b11-92f1-dbd98b53b308",
"bankAddress": "383 Madison Avenue",
"bankCity": "New York",
"bankState": "NY",
"bankZipCode": "10017",
"beneficiary": {
"beneficiaryEmail": "[email protected]",
"securityQuestion": "What is your pets name?",
"securityQuestionAnswer": "Fluffy",
"transitNumber": "<string>",
"beneficiaryAddress": "123 Main Street",
"beneficiaryCity": "New York",
"beneficiaryState": "NY",
"beneficiaryPostCode": "10001"
}
}
'import requests
url = "https://api.nomba.com/v1/global-payout/transfer/authorize"
payload = {
"amount": 500,
"sourceCurrency": "USD",
"destinationCurrency": "USD",
"receiverName": "John Cena",
"sourceCountryIsoCode": "CD",
"destinationCountryIsoCode": "CD",
"paymentMethod": "MobileMoney",
"accountType": "INDIVIDUAL",
"accountNumber": "0903086112",
"institutionCode": "access_bank",
"institutionName": "Mpesa",
"bankAccountType": "CHECKING",
"purposeOfPayment": "FAMILY_SUPPORT",
"narration": "Family support",
"lockedExchangeRateId": "01k7pcakf0t8g03rvny3z5mr1p",
"idempotencyKey": "5e246f9a-3e79-4b11-92f1-dbd98b53b308",
"bankAddress": "383 Madison Avenue",
"bankCity": "New York",
"bankState": "NY",
"bankZipCode": "10017",
"beneficiary": {
"beneficiaryEmail": "[email protected]",
"securityQuestion": "What is your pets name?",
"securityQuestionAnswer": "Fluffy",
"transitNumber": "<string>",
"beneficiaryAddress": "123 Main Street",
"beneficiaryCity": "New York",
"beneficiaryState": "NY",
"beneficiaryPostCode": "10001"
}
}
headers = {
"Authorization": "<authorization>",
"accountId": "<accountid>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
accountId: '<accountid>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 500,
sourceCurrency: 'USD',
destinationCurrency: 'USD',
receiverName: 'John Cena',
sourceCountryIsoCode: 'CD',
destinationCountryIsoCode: 'CD',
paymentMethod: 'MobileMoney',
accountType: 'INDIVIDUAL',
accountNumber: '0903086112',
institutionCode: 'access_bank',
institutionName: 'Mpesa',
bankAccountType: 'CHECKING',
purposeOfPayment: 'FAMILY_SUPPORT',
narration: 'Family support',
lockedExchangeRateId: '01k7pcakf0t8g03rvny3z5mr1p',
idempotencyKey: '5e246f9a-3e79-4b11-92f1-dbd98b53b308',
bankAddress: '383 Madison Avenue',
bankCity: 'New York',
bankState: 'NY',
bankZipCode: '10017',
beneficiary: {
beneficiaryEmail: '[email protected]',
securityQuestion: 'What is your pets name?',
securityQuestionAnswer: 'Fluffy',
transitNumber: '<string>',
beneficiaryAddress: '123 Main Street',
beneficiaryCity: 'New York',
beneficiaryState: 'NY',
beneficiaryPostCode: '10001'
}
})
};
fetch('https://api.nomba.com/v1/global-payout/transfer/authorize', 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.nomba.com/v1/global-payout/transfer/authorize",
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' => 500,
'sourceCurrency' => 'USD',
'destinationCurrency' => 'USD',
'receiverName' => 'John Cena',
'sourceCountryIsoCode' => 'CD',
'destinationCountryIsoCode' => 'CD',
'paymentMethod' => 'MobileMoney',
'accountType' => 'INDIVIDUAL',
'accountNumber' => '0903086112',
'institutionCode' => 'access_bank',
'institutionName' => 'Mpesa',
'bankAccountType' => 'CHECKING',
'purposeOfPayment' => 'FAMILY_SUPPORT',
'narration' => 'Family support',
'lockedExchangeRateId' => '01k7pcakf0t8g03rvny3z5mr1p',
'idempotencyKey' => '5e246f9a-3e79-4b11-92f1-dbd98b53b308',
'bankAddress' => '383 Madison Avenue',
'bankCity' => 'New York',
'bankState' => 'NY',
'bankZipCode' => '10017',
'beneficiary' => [
'beneficiaryEmail' => '[email protected]',
'securityQuestion' => 'What is your pets name?',
'securityQuestionAnswer' => 'Fluffy',
'transitNumber' => '<string>',
'beneficiaryAddress' => '123 Main Street',
'beneficiaryCity' => 'New York',
'beneficiaryState' => 'NY',
'beneficiaryPostCode' => '10001'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"accountId: <accountid>"
],
]);
$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.nomba.com/v1/global-payout/transfer/authorize"
payload := strings.NewReader("{\n \"amount\": 500,\n \"sourceCurrency\": \"USD\",\n \"destinationCurrency\": \"USD\",\n \"receiverName\": \"John Cena\",\n \"sourceCountryIsoCode\": \"CD\",\n \"destinationCountryIsoCode\": \"CD\",\n \"paymentMethod\": \"MobileMoney\",\n \"accountType\": \"INDIVIDUAL\",\n \"accountNumber\": \"0903086112\",\n \"institutionCode\": \"access_bank\",\n \"institutionName\": \"Mpesa\",\n \"bankAccountType\": \"CHECKING\",\n \"purposeOfPayment\": \"FAMILY_SUPPORT\",\n \"narration\": \"Family support\",\n \"lockedExchangeRateId\": \"01k7pcakf0t8g03rvny3z5mr1p\",\n \"idempotencyKey\": \"5e246f9a-3e79-4b11-92f1-dbd98b53b308\",\n \"bankAddress\": \"383 Madison Avenue\",\n \"bankCity\": \"New York\",\n \"bankState\": \"NY\",\n \"bankZipCode\": \"10017\",\n \"beneficiary\": {\n \"beneficiaryEmail\": \"[email protected]\",\n \"securityQuestion\": \"What is your pets name?\",\n \"securityQuestionAnswer\": \"Fluffy\",\n \"transitNumber\": \"<string>\",\n \"beneficiaryAddress\": \"123 Main Street\",\n \"beneficiaryCity\": \"New York\",\n \"beneficiaryState\": \"NY\",\n \"beneficiaryPostCode\": \"10001\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("accountId", "<accountid>")
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.nomba.com/v1/global-payout/transfer/authorize")
.header("Authorization", "<authorization>")
.header("accountId", "<accountid>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 500,\n \"sourceCurrency\": \"USD\",\n \"destinationCurrency\": \"USD\",\n \"receiverName\": \"John Cena\",\n \"sourceCountryIsoCode\": \"CD\",\n \"destinationCountryIsoCode\": \"CD\",\n \"paymentMethod\": \"MobileMoney\",\n \"accountType\": \"INDIVIDUAL\",\n \"accountNumber\": \"0903086112\",\n \"institutionCode\": \"access_bank\",\n \"institutionName\": \"Mpesa\",\n \"bankAccountType\": \"CHECKING\",\n \"purposeOfPayment\": \"FAMILY_SUPPORT\",\n \"narration\": \"Family support\",\n \"lockedExchangeRateId\": \"01k7pcakf0t8g03rvny3z5mr1p\",\n \"idempotencyKey\": \"5e246f9a-3e79-4b11-92f1-dbd98b53b308\",\n \"bankAddress\": \"383 Madison Avenue\",\n \"bankCity\": \"New York\",\n \"bankState\": \"NY\",\n \"bankZipCode\": \"10017\",\n \"beneficiary\": {\n \"beneficiaryEmail\": \"[email protected]\",\n \"securityQuestion\": \"What is your pets name?\",\n \"securityQuestionAnswer\": \"Fluffy\",\n \"transitNumber\": \"<string>\",\n \"beneficiaryAddress\": \"123 Main Street\",\n \"beneficiaryCity\": \"New York\",\n \"beneficiaryState\": \"NY\",\n \"beneficiaryPostCode\": \"10001\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nomba.com/v1/global-payout/transfer/authorize")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["accountId"] = '<accountid>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 500,\n \"sourceCurrency\": \"USD\",\n \"destinationCurrency\": \"USD\",\n \"receiverName\": \"John Cena\",\n \"sourceCountryIsoCode\": \"CD\",\n \"destinationCountryIsoCode\": \"CD\",\n \"paymentMethod\": \"MobileMoney\",\n \"accountType\": \"INDIVIDUAL\",\n \"accountNumber\": \"0903086112\",\n \"institutionCode\": \"access_bank\",\n \"institutionName\": \"Mpesa\",\n \"bankAccountType\": \"CHECKING\",\n \"purposeOfPayment\": \"FAMILY_SUPPORT\",\n \"narration\": \"Family support\",\n \"lockedExchangeRateId\": \"01k7pcakf0t8g03rvny3z5mr1p\",\n \"idempotencyKey\": \"5e246f9a-3e79-4b11-92f1-dbd98b53b308\",\n \"bankAddress\": \"383 Madison Avenue\",\n \"bankCity\": \"New York\",\n \"bankState\": \"NY\",\n \"bankZipCode\": \"10017\",\n \"beneficiary\": {\n \"beneficiaryEmail\": \"[email protected]\",\n \"securityQuestion\": \"What is your pets name?\",\n \"securityQuestionAnswer\": \"Fluffy\",\n \"transitNumber\": \"<string>\",\n \"beneficiaryAddress\": \"123 Main Street\",\n \"beneficiaryCity\": \"New York\",\n \"beneficiaryState\": \"NY\",\n \"beneficiaryPostCode\": \"10001\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": "00",
"description": "Successful",
"data": {
"wtTransactionId": "01kky197w3xc6wyjenpc5r0tnp",
"coreTransactionId": "API-FX_TX_DR-08A1B-6add611a-e538-4e67-bcf9-661c77a16804",
"status": "PROCESSING",
"coreStatus": "PAYMENT_SUCCESSFUL",
"type": "TRANSFER",
"idempotencyKey": "5e246f9a-3e79-4b11-92f1-dbd98b53b308",
"idempotentReplay": false,
"prettyStatus": "Successful",
"meta": {
"source_amount": "250.0",
"destination_amount": "250.0",
"source_currency": "USD",
"destination_currency": "USD",
"amount_charged": "255.0",
"currency_pair_name": "USD/USD",
"payment_method": "MobileMoney",
"destination_country": "CD",
"destination_country_name": "Congo DR",
"source_country": "CD",
"narration": "Family support",
"trade_side": "BUY",
"spread_amount": "0.0",
"spread_currency": "USD",
"wt_transaction_id": "01kky197w3xc6wyjenpc5r0tnp",
"trade_context": "default",
"transactionCategory": "General",
"payment_destination_type": "Account",
"tradeType": "FIXED_TRADE"
}
}
}For a complete guide on response codes and transaction statuses, see Response Codes.
Headers
Bearer token for authentication.
Example:
"Bearer <token>"
The parent accountId of the business.
Example:
"890022ce-bae0-45c1-9b9d-ee7872e6ca27"
Body
application/json
Transfer authorization payload
Example:
500
Example:
"USD"
Example:
"USD"
Example:
"John Cena"
Example:
"CD"
Example:
"CD"
Payment rail. Determines which additional fields are required. Use Fetch Payment Methods with code or name to get method-specific requirements.
Available options:
BANK, MobileMoney, INTERAC, FASTER_PAYMENTS, SEPA, ACH, WIRE Example:
"MobileMoney"
Required account type of the recipient. Select one of the values returned in accountTypes from Fetch Payment Methods. ACH supports only INDIVIDUAL; WIRE supports INDIVIDUAL and CORPORATE.
Available options:
INDIVIDUAL, CORPORATE Example:
"INDIVIDUAL"
Account number, IBAN, or phone number for MobileMoney. Required for BANK, MobileMoney, FASTER_PAYMENTS, SEPA.
Example:
"0903086112"
Routing code. Bank code from /bank/providers for BANK (DRC). Sort code for FASTER_PAYMENTS, SWIFT/BIC for SEPA, institution number for BANK (Canada).
Example:
"access_bank"
Bank or provider display name. Use displayName from List Institution Providers.
Example:
"Mpesa"
Recipient bank account type. Required for ACH and WIRE. Select one of the values returned in bankAccountTypes from Fetch Payment Methods.
Available options:
CHECKING, SAVINGS Example:
"CHECKING"
Reason for the transfer. Required for ACH, WIRE, and SEPA. Select one of the values returned in purposeOfPayments from Fetch Payment Methods; do not send arbitrary text.
Example:
"FAMILY_SUPPORT"
Example:
"Family support"
Optional locked exchange rate ID from Convert Money. Use this when you want to lock the exchange rate and destination amount before authorizing.
Example:
"01k7pcakf0t8g03rvny3z5mr1p"
Optional. Your own unique key for this request. Send the same key when retrying and the original transaction is returned instead of a second one being created. A key stays tied to its transaction permanently — use a new key for a new attempt.
Maximum string length:
128Example:
"5e246f9a-3e79-4b11-92f1-dbd98b53b308"
Bank street address. Required for United States WIRE.
Example:
"383 Madison Avenue"
Bank city. Required for United States WIRE.
Example:
"New York"
Bank state. Required for United States WIRE.
Example:
"NY"
Bank ZIP code. Required for United States WIRE.
Example:
"10017"
Required for INTERAC; partially required for BANK (Canada).
Show child attributes
Show child attributes