Initiate a business payout
curl --request POST \
--url http://localhost:3001/api/v1/business/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"quoteToken": "<string>",
"idempotencyKey": "<string>",
"recipientId": "<string>",
"destination": {},
"amount": "50.00",
"twoFactorCode": "<string>",
"metadata": {}
}
'import requests
url = "http://localhost:3001/api/v1/business/payouts"
payload = {
"quoteToken": "<string>",
"idempotencyKey": "<string>",
"recipientId": "<string>",
"destination": {},
"amount": "50.00",
"twoFactorCode": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
quoteToken: '<string>',
idempotencyKey: '<string>',
recipientId: '<string>',
destination: {},
amount: '50.00',
twoFactorCode: '<string>',
metadata: {}
})
};
fetch('http://localhost:3001/api/v1/business/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/business/payouts",
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([
'quoteToken' => '<string>',
'idempotencyKey' => '<string>',
'recipientId' => '<string>',
'destination' => [
],
'amount' => '50.00',
'twoFactorCode' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://localhost:3001/api/v1/business/payouts"
payload := strings.NewReader("{\n \"quoteToken\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"recipientId\": \"<string>\",\n \"destination\": {},\n \"amount\": \"50.00\",\n \"twoFactorCode\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:3001/api/v1/business/payouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"quoteToken\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"recipientId\": \"<string>\",\n \"destination\": {},\n \"amount\": \"50.00\",\n \"twoFactorCode\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/business/payouts")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quoteToken\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"recipientId\": \"<string>\",\n \"destination\": {},\n \"amount\": \"50.00\",\n \"twoFactorCode\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "<string>",
"partnerId": "<string>",
"partnerEndUserId": "<string>",
"amount": "100.00",
"currency": "USDC",
"destinationType": "<string>",
"destinationDetails": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"partnerWalletId": {},
"failureReason": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}Business Payouts
Initiate a business payout
POST
/
api
/
v1
/
business
/
payouts
Initiate a business payout
curl --request POST \
--url http://localhost:3001/api/v1/business/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"quoteToken": "<string>",
"idempotencyKey": "<string>",
"recipientId": "<string>",
"destination": {},
"amount": "50.00",
"twoFactorCode": "<string>",
"metadata": {}
}
'import requests
url = "http://localhost:3001/api/v1/business/payouts"
payload = {
"quoteToken": "<string>",
"idempotencyKey": "<string>",
"recipientId": "<string>",
"destination": {},
"amount": "50.00",
"twoFactorCode": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
quoteToken: '<string>',
idempotencyKey: '<string>',
recipientId: '<string>',
destination: {},
amount: '50.00',
twoFactorCode: '<string>',
metadata: {}
})
};
fetch('http://localhost:3001/api/v1/business/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/business/payouts",
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([
'quoteToken' => '<string>',
'idempotencyKey' => '<string>',
'recipientId' => '<string>',
'destination' => [
],
'amount' => '50.00',
'twoFactorCode' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://localhost:3001/api/v1/business/payouts"
payload := strings.NewReader("{\n \"quoteToken\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"recipientId\": \"<string>\",\n \"destination\": {},\n \"amount\": \"50.00\",\n \"twoFactorCode\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:3001/api/v1/business/payouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"quoteToken\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"recipientId\": \"<string>\",\n \"destination\": {},\n \"amount\": \"50.00\",\n \"twoFactorCode\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/business/payouts")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"quoteToken\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"recipientId\": \"<string>\",\n \"destination\": {},\n \"amount\": \"50.00\",\n \"twoFactorCode\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "<string>",
"partnerId": "<string>",
"partnerEndUserId": "<string>",
"amount": "100.00",
"currency": "USDC",
"destinationType": "<string>",
"destinationDetails": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"partnerWalletId": {},
"failureReason": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Active business context
Body
application/json
- Option 1
- Option 2
- Option 3
Available options:
CRYPTO, ACH, WIRE, SEPA, SWIFT, LOCAL_BANK, LOCAL_MOMO Signed quote token from POST /v1/business/payouts/quote (required for LOCAL_BANK / LOCAL_MOMO)
Required string length:
8 - 64Saved recipient id (required for LOCAL_BANK / LOCAL_MOMO; mutually exclusive with destination on other rails)
Ad-hoc destination (not supported for LOCAL_BANK / LOCAL_MOMO in v1; mutually exclusive with recipientId)
Decimal string (up to 8 fractional digits). Ignored for LOCAL_* rails — amounts come from quoteToken.
Example:
"50.00"
Ignored for LOCAL_* rails — wallet debit currency is USDC from the quote.
Available options:
USDC, EURC, GBPC Fresh TOTP code when amount >= $10k USD-equivalent
⌘I
