Create Payout
curl --request POST \
--url https://access.utgl.io/v1/payouts \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"source": {
"firstName": "<string>",
"surname": "<string>",
"nationality": "Hong Kong",
"address": "<string>",
"idNumber": "<string>",
"dateOfBirth": "1999-09-09",
"mobileNumber": "+85212345678"
},
"destination": {
"accountNumber": 6225888888888888,
"firstName": "DAWEN",
"firstNameCN": "大文",
"surname": "CHEN",
"surnameCN": "陈",
"address": "上海市黄浦区南京东路333号202室"
},
"quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountId": "6a3176fe-7715-4fe0-a548-034912d7f800",
"type": "BANK_ACCOUNT",
"accountNumber": 123456,
"routingNumber": 1234,
"country": "US",
"bankName": "Bank of America",
"bankAddress": "123 Main St, New York, NY 10001, USA",
"swiftCode": "BOFAUS3N",
"accountHolderName": "John Doe",
"accountHolderAddress": "456 Park Ave, New York, NY 10022, USA",
"remarks": "<string>",
"idempotencyKey": "xeev1she5eegh9daiviethahchoo1muW",
"xid": "<string>",
"xmetadata": "<unknown>"
}
'import requests
url = "https://access.utgl.io/v1/payouts"
payload = {
"source": {
"firstName": "<string>",
"surname": "<string>",
"nationality": "Hong Kong",
"address": "<string>",
"idNumber": "<string>",
"dateOfBirth": "1999-09-09",
"mobileNumber": "+85212345678"
},
"destination": {
"accountNumber": 6225888888888888,
"firstName": "DAWEN",
"firstNameCN": "大文",
"surname": "CHEN",
"surnameCN": "陈",
"address": "上海市黄浦区南京东路333号202室"
},
"quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountId": "6a3176fe-7715-4fe0-a548-034912d7f800",
"type": "BANK_ACCOUNT",
"accountNumber": 123456,
"routingNumber": 1234,
"country": "US",
"bankName": "Bank of America",
"bankAddress": "123 Main St, New York, NY 10001, USA",
"swiftCode": "BOFAUS3N",
"accountHolderName": "John Doe",
"accountHolderAddress": "456 Park Ave, New York, NY 10022, USA",
"remarks": "<string>",
"idempotencyKey": "xeev1she5eegh9daiviethahchoo1muW",
"xid": "<string>",
"xmetadata": "<unknown>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source: {
firstName: '<string>',
surname: '<string>',
nationality: 'Hong Kong',
address: '<string>',
idNumber: '<string>',
dateOfBirth: '1999-09-09',
mobileNumber: '+85212345678'
},
destination: {
accountNumber: 6225888888888888,
firstName: 'DAWEN',
firstNameCN: '大文',
surname: 'CHEN',
surnameCN: '陈',
address: '上海市黄浦区南京东路333号202室'
},
quoteId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
accountId: '6a3176fe-7715-4fe0-a548-034912d7f800',
type: 'BANK_ACCOUNT',
accountNumber: 123456,
routingNumber: 1234,
country: 'US',
bankName: 'Bank of America',
bankAddress: '123 Main St, New York, NY 10001, USA',
swiftCode: 'BOFAUS3N',
accountHolderName: 'John Doe',
accountHolderAddress: '456 Park Ave, New York, NY 10022, USA',
remarks: '<string>',
idempotencyKey: 'xeev1she5eegh9daiviethahchoo1muW',
xid: '<string>',
xmetadata: '<unknown>'
})
};
fetch('https://access.utgl.io/v1/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_URL => "https://access.utgl.io/v1/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([
'source' => [
'firstName' => '<string>',
'surname' => '<string>',
'nationality' => 'Hong Kong',
'address' => '<string>',
'idNumber' => '<string>',
'dateOfBirth' => '1999-09-09',
'mobileNumber' => '+85212345678'
],
'destination' => [
'accountNumber' => 6225888888888888,
'firstName' => 'DAWEN',
'firstNameCN' => '大文',
'surname' => 'CHEN',
'surnameCN' => '陈',
'address' => '上海市黄浦区南京东路333号202室'
],
'quoteId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'accountId' => '6a3176fe-7715-4fe0-a548-034912d7f800',
'type' => 'BANK_ACCOUNT',
'accountNumber' => 123456,
'routingNumber' => 1234,
'country' => 'US',
'bankName' => 'Bank of America',
'bankAddress' => '123 Main St, New York, NY 10001, USA',
'swiftCode' => 'BOFAUS3N',
'accountHolderName' => 'John Doe',
'accountHolderAddress' => '456 Park Ave, New York, NY 10022, USA',
'remarks' => '<string>',
'idempotencyKey' => 'xeev1she5eegh9daiviethahchoo1muW',
'xid' => '<string>',
'xmetadata' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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 := "https://access.utgl.io/v1/payouts"
payload := strings.NewReader("{\n \"source\": {\n \"firstName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nationality\": \"Hong Kong\",\n \"address\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"dateOfBirth\": \"1999-09-09\",\n \"mobileNumber\": \"+85212345678\"\n },\n \"destination\": {\n \"accountNumber\": 6225888888888888,\n \"firstName\": \"DAWEN\",\n \"firstNameCN\": \"大文\",\n \"surname\": \"CHEN\",\n \"surnameCN\": \"陈\",\n \"address\": \"上海市黄浦区南京东路333号202室\"\n },\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountId\": \"6a3176fe-7715-4fe0-a548-034912d7f800\",\n \"type\": \"BANK_ACCOUNT\",\n \"accountNumber\": 123456,\n \"routingNumber\": 1234,\n \"country\": \"US\",\n \"bankName\": \"Bank of America\",\n \"bankAddress\": \"123 Main St, New York, NY 10001, USA\",\n \"swiftCode\": \"BOFAUS3N\",\n \"accountHolderName\": \"John Doe\",\n \"accountHolderAddress\": \"456 Park Ave, New York, NY 10022, USA\",\n \"remarks\": \"<string>\",\n \"idempotencyKey\": \"xeev1she5eegh9daiviethahchoo1muW\",\n \"xid\": \"<string>\",\n \"xmetadata\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://access.utgl.io/v1/payouts")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"source\": {\n \"firstName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nationality\": \"Hong Kong\",\n \"address\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"dateOfBirth\": \"1999-09-09\",\n \"mobileNumber\": \"+85212345678\"\n },\n \"destination\": {\n \"accountNumber\": 6225888888888888,\n \"firstName\": \"DAWEN\",\n \"firstNameCN\": \"大文\",\n \"surname\": \"CHEN\",\n \"surnameCN\": \"陈\",\n \"address\": \"上海市黄浦区南京东路333号202室\"\n },\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountId\": \"6a3176fe-7715-4fe0-a548-034912d7f800\",\n \"type\": \"BANK_ACCOUNT\",\n \"accountNumber\": 123456,\n \"routingNumber\": 1234,\n \"country\": \"US\",\n \"bankName\": \"Bank of America\",\n \"bankAddress\": \"123 Main St, New York, NY 10001, USA\",\n \"swiftCode\": \"BOFAUS3N\",\n \"accountHolderName\": \"John Doe\",\n \"accountHolderAddress\": \"456 Park Ave, New York, NY 10022, USA\",\n \"remarks\": \"<string>\",\n \"idempotencyKey\": \"xeev1she5eegh9daiviethahchoo1muW\",\n \"xid\": \"<string>\",\n \"xmetadata\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://access.utgl.io/v1/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": {\n \"firstName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nationality\": \"Hong Kong\",\n \"address\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"dateOfBirth\": \"1999-09-09\",\n \"mobileNumber\": \"+85212345678\"\n },\n \"destination\": {\n \"accountNumber\": 6225888888888888,\n \"firstName\": \"DAWEN\",\n \"firstNameCN\": \"大文\",\n \"surname\": \"CHEN\",\n \"surnameCN\": \"陈\",\n \"address\": \"上海市黄浦区南京东路333号202室\"\n },\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountId\": \"6a3176fe-7715-4fe0-a548-034912d7f800\",\n \"type\": \"BANK_ACCOUNT\",\n \"accountNumber\": 123456,\n \"routingNumber\": 1234,\n \"country\": \"US\",\n \"bankName\": \"Bank of America\",\n \"bankAddress\": \"123 Main St, New York, NY 10001, USA\",\n \"swiftCode\": \"BOFAUS3N\",\n \"accountHolderName\": \"John Doe\",\n \"accountHolderAddress\": \"456 Park Ave, New York, NY 10022, USA\",\n \"remarks\": \"<string>\",\n \"idempotencyKey\": \"xeev1she5eegh9daiviethahchoo1muW\",\n \"xid\": \"<string>\",\n \"xmetadata\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"xid": "<string>",
"xmetadata": "<unknown>",
"created": "2023-11-07T05:31:56Z",
"method": "BANK_SWIFT",
"destination": {
"type": "BANK_ACCOUNT",
"accountNumber": 123456,
"routingNumber": 1234,
"country": "US",
"bankName": "Bank of America",
"bankAddress": "123 Main St, New York, NY 10001, USA",
"swiftCode": "BOFAUS3N",
"accountHolderName": "John Doe",
"accountHolderAddress": "456 Park Ave, New York, NY 10022, USA"
},
"accountId": "6a3176fe-7715-4fe0-a548-034912d7f800",
"sourceCurrency": "<string>",
"sourceAmount": 123,
"destinationCurrency": "RMB",
"destinationAmount": 123,
"rate": 123,
"updated": "2023-11-07T05:31:56Z",
"status": "requested",
"subStatus": "ORDER_UNDER_AML_REVIEW",
"cancellationReason": "<string>"
}{
"statusCode": 400,
"error": "Bad Request",
"message": {
"code": "DESTINATION_ADDRESS_VALIDATION_FAILED",
"message": "Destination address validation failed. Address must be longer than 20 characters and contain at least one space and one number."
}
}Payouts
Create Payout
Create a payout to an external destination
POST
/
payouts
Create Payout
curl --request POST \
--url https://access.utgl.io/v1/payouts \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"source": {
"firstName": "<string>",
"surname": "<string>",
"nationality": "Hong Kong",
"address": "<string>",
"idNumber": "<string>",
"dateOfBirth": "1999-09-09",
"mobileNumber": "+85212345678"
},
"destination": {
"accountNumber": 6225888888888888,
"firstName": "DAWEN",
"firstNameCN": "大文",
"surname": "CHEN",
"surnameCN": "陈",
"address": "上海市黄浦区南京东路333号202室"
},
"quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountId": "6a3176fe-7715-4fe0-a548-034912d7f800",
"type": "BANK_ACCOUNT",
"accountNumber": 123456,
"routingNumber": 1234,
"country": "US",
"bankName": "Bank of America",
"bankAddress": "123 Main St, New York, NY 10001, USA",
"swiftCode": "BOFAUS3N",
"accountHolderName": "John Doe",
"accountHolderAddress": "456 Park Ave, New York, NY 10022, USA",
"remarks": "<string>",
"idempotencyKey": "xeev1she5eegh9daiviethahchoo1muW",
"xid": "<string>",
"xmetadata": "<unknown>"
}
'import requests
url = "https://access.utgl.io/v1/payouts"
payload = {
"source": {
"firstName": "<string>",
"surname": "<string>",
"nationality": "Hong Kong",
"address": "<string>",
"idNumber": "<string>",
"dateOfBirth": "1999-09-09",
"mobileNumber": "+85212345678"
},
"destination": {
"accountNumber": 6225888888888888,
"firstName": "DAWEN",
"firstNameCN": "大文",
"surname": "CHEN",
"surnameCN": "陈",
"address": "上海市黄浦区南京东路333号202室"
},
"quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountId": "6a3176fe-7715-4fe0-a548-034912d7f800",
"type": "BANK_ACCOUNT",
"accountNumber": 123456,
"routingNumber": 1234,
"country": "US",
"bankName": "Bank of America",
"bankAddress": "123 Main St, New York, NY 10001, USA",
"swiftCode": "BOFAUS3N",
"accountHolderName": "John Doe",
"accountHolderAddress": "456 Park Ave, New York, NY 10022, USA",
"remarks": "<string>",
"idempotencyKey": "xeev1she5eegh9daiviethahchoo1muW",
"xid": "<string>",
"xmetadata": "<unknown>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source: {
firstName: '<string>',
surname: '<string>',
nationality: 'Hong Kong',
address: '<string>',
idNumber: '<string>',
dateOfBirth: '1999-09-09',
mobileNumber: '+85212345678'
},
destination: {
accountNumber: 6225888888888888,
firstName: 'DAWEN',
firstNameCN: '大文',
surname: 'CHEN',
surnameCN: '陈',
address: '上海市黄浦区南京东路333号202室'
},
quoteId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
accountId: '6a3176fe-7715-4fe0-a548-034912d7f800',
type: 'BANK_ACCOUNT',
accountNumber: 123456,
routingNumber: 1234,
country: 'US',
bankName: 'Bank of America',
bankAddress: '123 Main St, New York, NY 10001, USA',
swiftCode: 'BOFAUS3N',
accountHolderName: 'John Doe',
accountHolderAddress: '456 Park Ave, New York, NY 10022, USA',
remarks: '<string>',
idempotencyKey: 'xeev1she5eegh9daiviethahchoo1muW',
xid: '<string>',
xmetadata: '<unknown>'
})
};
fetch('https://access.utgl.io/v1/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_URL => "https://access.utgl.io/v1/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([
'source' => [
'firstName' => '<string>',
'surname' => '<string>',
'nationality' => 'Hong Kong',
'address' => '<string>',
'idNumber' => '<string>',
'dateOfBirth' => '1999-09-09',
'mobileNumber' => '+85212345678'
],
'destination' => [
'accountNumber' => 6225888888888888,
'firstName' => 'DAWEN',
'firstNameCN' => '大文',
'surname' => 'CHEN',
'surnameCN' => '陈',
'address' => '上海市黄浦区南京东路333号202室'
],
'quoteId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'accountId' => '6a3176fe-7715-4fe0-a548-034912d7f800',
'type' => 'BANK_ACCOUNT',
'accountNumber' => 123456,
'routingNumber' => 1234,
'country' => 'US',
'bankName' => 'Bank of America',
'bankAddress' => '123 Main St, New York, NY 10001, USA',
'swiftCode' => 'BOFAUS3N',
'accountHolderName' => 'John Doe',
'accountHolderAddress' => '456 Park Ave, New York, NY 10022, USA',
'remarks' => '<string>',
'idempotencyKey' => 'xeev1she5eegh9daiviethahchoo1muW',
'xid' => '<string>',
'xmetadata' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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 := "https://access.utgl.io/v1/payouts"
payload := strings.NewReader("{\n \"source\": {\n \"firstName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nationality\": \"Hong Kong\",\n \"address\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"dateOfBirth\": \"1999-09-09\",\n \"mobileNumber\": \"+85212345678\"\n },\n \"destination\": {\n \"accountNumber\": 6225888888888888,\n \"firstName\": \"DAWEN\",\n \"firstNameCN\": \"大文\",\n \"surname\": \"CHEN\",\n \"surnameCN\": \"陈\",\n \"address\": \"上海市黄浦区南京东路333号202室\"\n },\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountId\": \"6a3176fe-7715-4fe0-a548-034912d7f800\",\n \"type\": \"BANK_ACCOUNT\",\n \"accountNumber\": 123456,\n \"routingNumber\": 1234,\n \"country\": \"US\",\n \"bankName\": \"Bank of America\",\n \"bankAddress\": \"123 Main St, New York, NY 10001, USA\",\n \"swiftCode\": \"BOFAUS3N\",\n \"accountHolderName\": \"John Doe\",\n \"accountHolderAddress\": \"456 Park Ave, New York, NY 10022, USA\",\n \"remarks\": \"<string>\",\n \"idempotencyKey\": \"xeev1she5eegh9daiviethahchoo1muW\",\n \"xid\": \"<string>\",\n \"xmetadata\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://access.utgl.io/v1/payouts")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"source\": {\n \"firstName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nationality\": \"Hong Kong\",\n \"address\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"dateOfBirth\": \"1999-09-09\",\n \"mobileNumber\": \"+85212345678\"\n },\n \"destination\": {\n \"accountNumber\": 6225888888888888,\n \"firstName\": \"DAWEN\",\n \"firstNameCN\": \"大文\",\n \"surname\": \"CHEN\",\n \"surnameCN\": \"陈\",\n \"address\": \"上海市黄浦区南京东路333号202室\"\n },\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountId\": \"6a3176fe-7715-4fe0-a548-034912d7f800\",\n \"type\": \"BANK_ACCOUNT\",\n \"accountNumber\": 123456,\n \"routingNumber\": 1234,\n \"country\": \"US\",\n \"bankName\": \"Bank of America\",\n \"bankAddress\": \"123 Main St, New York, NY 10001, USA\",\n \"swiftCode\": \"BOFAUS3N\",\n \"accountHolderName\": \"John Doe\",\n \"accountHolderAddress\": \"456 Park Ave, New York, NY 10022, USA\",\n \"remarks\": \"<string>\",\n \"idempotencyKey\": \"xeev1she5eegh9daiviethahchoo1muW\",\n \"xid\": \"<string>\",\n \"xmetadata\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://access.utgl.io/v1/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": {\n \"firstName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nationality\": \"Hong Kong\",\n \"address\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"dateOfBirth\": \"1999-09-09\",\n \"mobileNumber\": \"+85212345678\"\n },\n \"destination\": {\n \"accountNumber\": 6225888888888888,\n \"firstName\": \"DAWEN\",\n \"firstNameCN\": \"大文\",\n \"surname\": \"CHEN\",\n \"surnameCN\": \"陈\",\n \"address\": \"上海市黄浦区南京东路333号202室\"\n },\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountId\": \"6a3176fe-7715-4fe0-a548-034912d7f800\",\n \"type\": \"BANK_ACCOUNT\",\n \"accountNumber\": 123456,\n \"routingNumber\": 1234,\n \"country\": \"US\",\n \"bankName\": \"Bank of America\",\n \"bankAddress\": \"123 Main St, New York, NY 10001, USA\",\n \"swiftCode\": \"BOFAUS3N\",\n \"accountHolderName\": \"John Doe\",\n \"accountHolderAddress\": \"456 Park Ave, New York, NY 10022, USA\",\n \"remarks\": \"<string>\",\n \"idempotencyKey\": \"xeev1she5eegh9daiviethahchoo1muW\",\n \"xid\": \"<string>\",\n \"xmetadata\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"xid": "<string>",
"xmetadata": "<unknown>",
"created": "2023-11-07T05:31:56Z",
"method": "BANK_SWIFT",
"destination": {
"type": "BANK_ACCOUNT",
"accountNumber": 123456,
"routingNumber": 1234,
"country": "US",
"bankName": "Bank of America",
"bankAddress": "123 Main St, New York, NY 10001, USA",
"swiftCode": "BOFAUS3N",
"accountHolderName": "John Doe",
"accountHolderAddress": "456 Park Ave, New York, NY 10022, USA"
},
"accountId": "6a3176fe-7715-4fe0-a548-034912d7f800",
"sourceCurrency": "<string>",
"sourceAmount": 123,
"destinationCurrency": "RMB",
"destinationAmount": 123,
"rate": 123,
"updated": "2023-11-07T05:31:56Z",
"status": "requested",
"subStatus": "ORDER_UNDER_AML_REVIEW",
"cancellationReason": "<string>"
}{
"statusCode": 400,
"error": "Bad Request",
"message": {
"code": "DESTINATION_ADDRESS_VALIDATION_FAILED",
"message": "Destination address validation failed. Address must be longer than 20 characters and contain at least one space and one number."
}
}Authorizations
BasicBearer
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
- Bank Account (SWIFT)
- UnionPay Card Account
- Bank Transfer Account
Required for UNIONPAY method only
Show child attributes
Show child attributes
Payout destination
- UnionPay Card Account
- Bank Account (SWIFT)
- Bank Transfer Account
Show child attributes
Show child attributes
Quote ID
The purpose of the payout. Possible values are
- self-use
- household
- personal-savings
- family-living-expenses
Available options:
self-use, buy-goods, spending, household, payroll, personal-savings, family-living-expenses, company-expense The fund source of this payout
- income
- household
- friends-loan
- company-fund
- personal-investment
- personal-savings
- wages
Available options:
income, household, friends-loan, company-fund, personal-investment, personal-savings, wages Account id to payout from
Example:
"6a3176fe-7715-4fe0-a548-034912d7f800"
The type of bank account
The account number of the bank account
Example:
123456
The routing number of the bank account
Example:
1234
The country of the bank account
Example:
"US"
The name of the bank where the account is held
Example:
"Bank of America"
The address of the bank where the account is held
Example:
"123 Main St, New York, NY 10001, USA"
The SWIFT code of the bank where the account is held
Example:
"BOFAUS3N"
The name of the account holder
Example:
"John Doe"
The address of the account holder
Example:
"456 Park Ave, New York, NY 10022, USA"
Available options:
BANK_SWIFT, UNIONPAY, BANK_TRANSFER The remarks of the payout
Unique idempotency key for ensuring exactly-once execution of mutating requests.
Example:
"xeev1she5eegh9daiviethahchoo1muW"
External identifier, unique across all resources created under this account.
Response
Payout Requested
ID of resource
External identifier, unique across all resources created under this account.
Payout method
Available options:
BANK_SWIFT, UNIONPAY - Bank Account (SWIFT)
- UnionPay Card Account
- UnionPay Card Account
Show child attributes
Show child attributes
Account id to fund the payout from
Example:
"6a3176fe-7715-4fe0-a548-034912d7f800"
Currency to send
Amount to send
Receive currency
Example:
"RMB"
Receive amount
Exchange rate
Overall status of the payout:
requested: Payout has been requested but not yet processingprocessing: Payout is being processed (may include AML review)completed: Payout has been successfully completedfailed: Payout failed to processcancelled: Payout was cancelled
Available options:
requested, processing, completed, failed, cancelled Detailed sub-status providing additional context about the payout state.
Important Sub-Statuses:
ORDER_UNDER_AML_REVIEW: The payout is under Anti-Money Laundering (AML) compliance review. When in this state:- The payout cannot be cancelled by users or API calls
- The transaction is held pending manual compliance review
- Status will remain
processinguntil review is complete - After review, it will move to
completedorcancelledby the payment gateway
Other sub-statuses may exist for different processing stages.
Example:
"ORDER_UNDER_AML_REVIEW"
Reason for cancellation (only present when status is cancelled)
Was this page helpful?