curl --request POST \
--url https://service-sandbox.tazapay.com/v3/payout \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"beneficiary": "bnf_d3inm6ami8u10oqfh",
"beneficiary_details": null,
"amount": 50000,
"currency": "HKD",
"holding_currency": "USD",
"type": "local",
"charge_type": "shared",
"purpose": "PYR003",
"reference_id": "HK-PAY-2024-156",
"transaction_description": "Supplier payment for electronics order",
"statement_descriptor": "Supplier Payment",
"documents": [],
"local": {
"fund_transfer_network": "chats"
},
"quote": "poq_d3inm6ami8u10oqfk",
"logistics_tracking_details": [
{
"tracking_number": "1Z999AA10123456784",
"logistics_provider": {
"name": "UPS",
"code": "UPS"
}
}
],
"on_behalf_of": "ent_d3inm6ami8u10oqfm",
"items": [
{
"name": "Premium subscription (Jan 2026)",
"quantity": 1,
"amount": 50000,
"category": "Goods",
"description": "Subscription payout"
}
]
}
'import requests
url = "https://service-sandbox.tazapay.com/v3/payout"
payload = {
"beneficiary": "bnf_d3inm6ami8u10oqfh",
"beneficiary_details": None,
"amount": 50000,
"currency": "HKD",
"holding_currency": "USD",
"type": "local",
"charge_type": "shared",
"purpose": "PYR003",
"reference_id": "HK-PAY-2024-156",
"transaction_description": "Supplier payment for electronics order",
"statement_descriptor": "Supplier Payment",
"documents": [],
"local": { "fund_transfer_network": "chats" },
"quote": "poq_d3inm6ami8u10oqfk",
"logistics_tracking_details": [
{
"tracking_number": "1Z999AA10123456784",
"logistics_provider": {
"name": "UPS",
"code": "UPS"
}
}
],
"on_behalf_of": "ent_d3inm6ami8u10oqfm",
"items": [
{
"name": "Premium subscription (Jan 2026)",
"quantity": 1,
"amount": 50000,
"category": "Goods",
"description": "Subscription payout"
}
]
}
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({
beneficiary: 'bnf_d3inm6ami8u10oqfh',
beneficiary_details: null,
amount: 50000,
currency: 'HKD',
holding_currency: 'USD',
type: 'local',
charge_type: 'shared',
purpose: 'PYR003',
reference_id: 'HK-PAY-2024-156',
transaction_description: 'Supplier payment for electronics order',
statement_descriptor: 'Supplier Payment',
documents: [],
local: {fund_transfer_network: 'chats'},
quote: 'poq_d3inm6ami8u10oqfk',
logistics_tracking_details: [
{
tracking_number: '1Z999AA10123456784',
logistics_provider: {name: 'UPS', code: 'UPS'}
}
],
on_behalf_of: 'ent_d3inm6ami8u10oqfm',
items: [
{
name: 'Premium subscription (Jan 2026)',
quantity: 1,
amount: 50000,
category: 'Goods',
description: 'Subscription payout'
}
]
})
};
fetch('https://service-sandbox.tazapay.com/v3/payout', 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://service-sandbox.tazapay.com/v3/payout",
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([
'beneficiary' => 'bnf_d3inm6ami8u10oqfh',
'beneficiary_details' => null,
'amount' => 50000,
'currency' => 'HKD',
'holding_currency' => 'USD',
'type' => 'local',
'charge_type' => 'shared',
'purpose' => 'PYR003',
'reference_id' => 'HK-PAY-2024-156',
'transaction_description' => 'Supplier payment for electronics order',
'statement_descriptor' => 'Supplier Payment',
'documents' => [
],
'local' => [
'fund_transfer_network' => 'chats'
],
'quote' => 'poq_d3inm6ami8u10oqfk',
'logistics_tracking_details' => [
[
'tracking_number' => '1Z999AA10123456784',
'logistics_provider' => [
'name' => 'UPS',
'code' => 'UPS'
]
]
],
'on_behalf_of' => 'ent_d3inm6ami8u10oqfm',
'items' => [
[
'name' => 'Premium subscription (Jan 2026)',
'quantity' => 1,
'amount' => 50000,
'category' => 'Goods',
'description' => 'Subscription payout'
]
]
]),
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://service-sandbox.tazapay.com/v3/payout"
payload := strings.NewReader("{\n \"beneficiary\": \"bnf_d3inm6ami8u10oqfh\",\n \"beneficiary_details\": null,\n \"amount\": 50000,\n \"currency\": \"HKD\",\n \"holding_currency\": \"USD\",\n \"type\": \"local\",\n \"charge_type\": \"shared\",\n \"purpose\": \"PYR003\",\n \"reference_id\": \"HK-PAY-2024-156\",\n \"transaction_description\": \"Supplier payment for electronics order\",\n \"statement_descriptor\": \"Supplier Payment\",\n \"documents\": [],\n \"local\": {\n \"fund_transfer_network\": \"chats\"\n },\n \"quote\": \"poq_d3inm6ami8u10oqfk\",\n \"logistics_tracking_details\": [\n {\n \"tracking_number\": \"1Z999AA10123456784\",\n \"logistics_provider\": {\n \"name\": \"UPS\",\n \"code\": \"UPS\"\n }\n }\n ],\n \"on_behalf_of\": \"ent_d3inm6ami8u10oqfm\",\n \"items\": [\n {\n \"name\": \"Premium subscription (Jan 2026)\",\n \"quantity\": 1,\n \"amount\": 50000,\n \"category\": \"Goods\",\n \"description\": \"Subscription payout\"\n }\n ]\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://service-sandbox.tazapay.com/v3/payout")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"beneficiary\": \"bnf_d3inm6ami8u10oqfh\",\n \"beneficiary_details\": null,\n \"amount\": 50000,\n \"currency\": \"HKD\",\n \"holding_currency\": \"USD\",\n \"type\": \"local\",\n \"charge_type\": \"shared\",\n \"purpose\": \"PYR003\",\n \"reference_id\": \"HK-PAY-2024-156\",\n \"transaction_description\": \"Supplier payment for electronics order\",\n \"statement_descriptor\": \"Supplier Payment\",\n \"documents\": [],\n \"local\": {\n \"fund_transfer_network\": \"chats\"\n },\n \"quote\": \"poq_d3inm6ami8u10oqfk\",\n \"logistics_tracking_details\": [\n {\n \"tracking_number\": \"1Z999AA10123456784\",\n \"logistics_provider\": {\n \"name\": \"UPS\",\n \"code\": \"UPS\"\n }\n }\n ],\n \"on_behalf_of\": \"ent_d3inm6ami8u10oqfm\",\n \"items\": [\n {\n \"name\": \"Premium subscription (Jan 2026)\",\n \"quantity\": 1,\n \"amount\": 50000,\n \"category\": \"Goods\",\n \"description\": \"Subscription payout\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://service-sandbox.tazapay.com/v3/payout")
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 \"beneficiary\": \"bnf_d3inm6ami8u10oqfh\",\n \"beneficiary_details\": null,\n \"amount\": 50000,\n \"currency\": \"HKD\",\n \"holding_currency\": \"USD\",\n \"type\": \"local\",\n \"charge_type\": \"shared\",\n \"purpose\": \"PYR003\",\n \"reference_id\": \"HK-PAY-2024-156\",\n \"transaction_description\": \"Supplier payment for electronics order\",\n \"statement_descriptor\": \"Supplier Payment\",\n \"documents\": [],\n \"local\": {\n \"fund_transfer_network\": \"chats\"\n },\n \"quote\": \"poq_d3inm6ami8u10oqfk\",\n \"logistics_tracking_details\": [\n {\n \"tracking_number\": \"1Z999AA10123456784\",\n \"logistics_provider\": {\n \"name\": \"UPS\",\n \"code\": \"UPS\"\n }\n }\n ],\n \"on_behalf_of\": \"ent_d3inm6ami8u10oqfm\",\n \"items\": [\n {\n \"name\": \"Premium subscription (Jan 2026)\",\n \"quantity\": 1,\n \"amount\": 50000,\n \"category\": \"Goods\",\n \"description\": \"Subscription payout\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "",
"data": {
"amount": 100000,
"balance_transaction": "btr_crv5u81h1l071n2fk1o0",
"beneficiary": "bnf_crv5r71h1l071n2fjvog",
"beneficiary_details": {
"address": {
"city": "test",
"country": "US",
"line1": "test",
"line2": "test",
"postal_code": "10038",
"state": "test"
},
"destination": "bnk_crv5r71gb6vrb4oj77kg",
"destination_details": {
"bank": {
"account_number": "test",
"account_type": "",
"bank_codes": {
"aba_code": "test",
"swift_code": "test"
},
"bank_name": "city bank",
"branch_name": "",
"country": "US",
"currency": "USD",
"firc_required": false,
"purpose_code": ""
},
"type": "bank"
},
"documents": [],
"email": "test@example.com",
"name": "test",
"phone": {
"calling_code": "1",
"number": "12312312345"
},
"tax_id": "test",
"type": "individual"
},
"charge_type": "ours",
"created_at": "2024-10-03T09:08:48.467222Z",
"currency": "USD",
"documents": [],
"holding_currency": "EUR",
"holding_fx_transaction": {
"exchange_rate": 1.059191,
"final": {
"amount": 100000,
"currency": "USD"
},
"id": "fx_crv5u80dj96g452dfr2g",
"initial": {
"amount": 94412,
"currency": "EUR"
},
"object": "fx_transaction"
},
"id": "pot_crv5u81h1l071n2fk1ng",
"local": {
"fund_transfer_network": "ach"
},
"metadata": null,
"mt103": "",
"object": "payout",
"payout_fx_transaction": {
"exchange_rate": 1,
"final": {
"amount": 100000,
"currency": "USD"
},
"id": "fx_crv5u80dj96g452dfr20",
"initial": {
"amount": 100000,
"currency": "USD"
},
"object": "fx_transaction"
},
"purpose": "PYR001",
"quote": "poq_crv5u81h1l071n2fk1n0",
"confirmation_documents": [],
"reference_id": "INV-2024-0912",
"statement_descriptor": "tzp*Consulting Fee",
"status": "processing",
"status_description": "",
"failure": null,
"tracking_details": null,
"transaction_description": "Payment for consulting services",
"items": [
{
"name": "Premium subscription (Jan 2026)",
"quantity": 1,
"amount": 50000,
"category": "Goods",
"description": "Subscription payout"
}
],
"type": "swift",
"on_behalf_of": "ent_d68uqeuid0fvsnsfd1q0",
"logistics_tracking_details": [
{
"tracking_number": "1263",
"logistics_provider": {
"name": "DHL Express",
"code": "IO245"
}
}
]
}
}"{}"Create Payout
This lets you initiate a payout.
curl --request POST \
--url https://service-sandbox.tazapay.com/v3/payout \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"beneficiary": "bnf_d3inm6ami8u10oqfh",
"beneficiary_details": null,
"amount": 50000,
"currency": "HKD",
"holding_currency": "USD",
"type": "local",
"charge_type": "shared",
"purpose": "PYR003",
"reference_id": "HK-PAY-2024-156",
"transaction_description": "Supplier payment for electronics order",
"statement_descriptor": "Supplier Payment",
"documents": [],
"local": {
"fund_transfer_network": "chats"
},
"quote": "poq_d3inm6ami8u10oqfk",
"logistics_tracking_details": [
{
"tracking_number": "1Z999AA10123456784",
"logistics_provider": {
"name": "UPS",
"code": "UPS"
}
}
],
"on_behalf_of": "ent_d3inm6ami8u10oqfm",
"items": [
{
"name": "Premium subscription (Jan 2026)",
"quantity": 1,
"amount": 50000,
"category": "Goods",
"description": "Subscription payout"
}
]
}
'import requests
url = "https://service-sandbox.tazapay.com/v3/payout"
payload = {
"beneficiary": "bnf_d3inm6ami8u10oqfh",
"beneficiary_details": None,
"amount": 50000,
"currency": "HKD",
"holding_currency": "USD",
"type": "local",
"charge_type": "shared",
"purpose": "PYR003",
"reference_id": "HK-PAY-2024-156",
"transaction_description": "Supplier payment for electronics order",
"statement_descriptor": "Supplier Payment",
"documents": [],
"local": { "fund_transfer_network": "chats" },
"quote": "poq_d3inm6ami8u10oqfk",
"logistics_tracking_details": [
{
"tracking_number": "1Z999AA10123456784",
"logistics_provider": {
"name": "UPS",
"code": "UPS"
}
}
],
"on_behalf_of": "ent_d3inm6ami8u10oqfm",
"items": [
{
"name": "Premium subscription (Jan 2026)",
"quantity": 1,
"amount": 50000,
"category": "Goods",
"description": "Subscription payout"
}
]
}
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({
beneficiary: 'bnf_d3inm6ami8u10oqfh',
beneficiary_details: null,
amount: 50000,
currency: 'HKD',
holding_currency: 'USD',
type: 'local',
charge_type: 'shared',
purpose: 'PYR003',
reference_id: 'HK-PAY-2024-156',
transaction_description: 'Supplier payment for electronics order',
statement_descriptor: 'Supplier Payment',
documents: [],
local: {fund_transfer_network: 'chats'},
quote: 'poq_d3inm6ami8u10oqfk',
logistics_tracking_details: [
{
tracking_number: '1Z999AA10123456784',
logistics_provider: {name: 'UPS', code: 'UPS'}
}
],
on_behalf_of: 'ent_d3inm6ami8u10oqfm',
items: [
{
name: 'Premium subscription (Jan 2026)',
quantity: 1,
amount: 50000,
category: 'Goods',
description: 'Subscription payout'
}
]
})
};
fetch('https://service-sandbox.tazapay.com/v3/payout', 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://service-sandbox.tazapay.com/v3/payout",
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([
'beneficiary' => 'bnf_d3inm6ami8u10oqfh',
'beneficiary_details' => null,
'amount' => 50000,
'currency' => 'HKD',
'holding_currency' => 'USD',
'type' => 'local',
'charge_type' => 'shared',
'purpose' => 'PYR003',
'reference_id' => 'HK-PAY-2024-156',
'transaction_description' => 'Supplier payment for electronics order',
'statement_descriptor' => 'Supplier Payment',
'documents' => [
],
'local' => [
'fund_transfer_network' => 'chats'
],
'quote' => 'poq_d3inm6ami8u10oqfk',
'logistics_tracking_details' => [
[
'tracking_number' => '1Z999AA10123456784',
'logistics_provider' => [
'name' => 'UPS',
'code' => 'UPS'
]
]
],
'on_behalf_of' => 'ent_d3inm6ami8u10oqfm',
'items' => [
[
'name' => 'Premium subscription (Jan 2026)',
'quantity' => 1,
'amount' => 50000,
'category' => 'Goods',
'description' => 'Subscription payout'
]
]
]),
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://service-sandbox.tazapay.com/v3/payout"
payload := strings.NewReader("{\n \"beneficiary\": \"bnf_d3inm6ami8u10oqfh\",\n \"beneficiary_details\": null,\n \"amount\": 50000,\n \"currency\": \"HKD\",\n \"holding_currency\": \"USD\",\n \"type\": \"local\",\n \"charge_type\": \"shared\",\n \"purpose\": \"PYR003\",\n \"reference_id\": \"HK-PAY-2024-156\",\n \"transaction_description\": \"Supplier payment for electronics order\",\n \"statement_descriptor\": \"Supplier Payment\",\n \"documents\": [],\n \"local\": {\n \"fund_transfer_network\": \"chats\"\n },\n \"quote\": \"poq_d3inm6ami8u10oqfk\",\n \"logistics_tracking_details\": [\n {\n \"tracking_number\": \"1Z999AA10123456784\",\n \"logistics_provider\": {\n \"name\": \"UPS\",\n \"code\": \"UPS\"\n }\n }\n ],\n \"on_behalf_of\": \"ent_d3inm6ami8u10oqfm\",\n \"items\": [\n {\n \"name\": \"Premium subscription (Jan 2026)\",\n \"quantity\": 1,\n \"amount\": 50000,\n \"category\": \"Goods\",\n \"description\": \"Subscription payout\"\n }\n ]\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://service-sandbox.tazapay.com/v3/payout")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"beneficiary\": \"bnf_d3inm6ami8u10oqfh\",\n \"beneficiary_details\": null,\n \"amount\": 50000,\n \"currency\": \"HKD\",\n \"holding_currency\": \"USD\",\n \"type\": \"local\",\n \"charge_type\": \"shared\",\n \"purpose\": \"PYR003\",\n \"reference_id\": \"HK-PAY-2024-156\",\n \"transaction_description\": \"Supplier payment for electronics order\",\n \"statement_descriptor\": \"Supplier Payment\",\n \"documents\": [],\n \"local\": {\n \"fund_transfer_network\": \"chats\"\n },\n \"quote\": \"poq_d3inm6ami8u10oqfk\",\n \"logistics_tracking_details\": [\n {\n \"tracking_number\": \"1Z999AA10123456784\",\n \"logistics_provider\": {\n \"name\": \"UPS\",\n \"code\": \"UPS\"\n }\n }\n ],\n \"on_behalf_of\": \"ent_d3inm6ami8u10oqfm\",\n \"items\": [\n {\n \"name\": \"Premium subscription (Jan 2026)\",\n \"quantity\": 1,\n \"amount\": 50000,\n \"category\": \"Goods\",\n \"description\": \"Subscription payout\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://service-sandbox.tazapay.com/v3/payout")
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 \"beneficiary\": \"bnf_d3inm6ami8u10oqfh\",\n \"beneficiary_details\": null,\n \"amount\": 50000,\n \"currency\": \"HKD\",\n \"holding_currency\": \"USD\",\n \"type\": \"local\",\n \"charge_type\": \"shared\",\n \"purpose\": \"PYR003\",\n \"reference_id\": \"HK-PAY-2024-156\",\n \"transaction_description\": \"Supplier payment for electronics order\",\n \"statement_descriptor\": \"Supplier Payment\",\n \"documents\": [],\n \"local\": {\n \"fund_transfer_network\": \"chats\"\n },\n \"quote\": \"poq_d3inm6ami8u10oqfk\",\n \"logistics_tracking_details\": [\n {\n \"tracking_number\": \"1Z999AA10123456784\",\n \"logistics_provider\": {\n \"name\": \"UPS\",\n \"code\": \"UPS\"\n }\n }\n ],\n \"on_behalf_of\": \"ent_d3inm6ami8u10oqfm\",\n \"items\": [\n {\n \"name\": \"Premium subscription (Jan 2026)\",\n \"quantity\": 1,\n \"amount\": 50000,\n \"category\": \"Goods\",\n \"description\": \"Subscription payout\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "",
"data": {
"amount": 100000,
"balance_transaction": "btr_crv5u81h1l071n2fk1o0",
"beneficiary": "bnf_crv5r71h1l071n2fjvog",
"beneficiary_details": {
"address": {
"city": "test",
"country": "US",
"line1": "test",
"line2": "test",
"postal_code": "10038",
"state": "test"
},
"destination": "bnk_crv5r71gb6vrb4oj77kg",
"destination_details": {
"bank": {
"account_number": "test",
"account_type": "",
"bank_codes": {
"aba_code": "test",
"swift_code": "test"
},
"bank_name": "city bank",
"branch_name": "",
"country": "US",
"currency": "USD",
"firc_required": false,
"purpose_code": ""
},
"type": "bank"
},
"documents": [],
"email": "test@example.com",
"name": "test",
"phone": {
"calling_code": "1",
"number": "12312312345"
},
"tax_id": "test",
"type": "individual"
},
"charge_type": "ours",
"created_at": "2024-10-03T09:08:48.467222Z",
"currency": "USD",
"documents": [],
"holding_currency": "EUR",
"holding_fx_transaction": {
"exchange_rate": 1.059191,
"final": {
"amount": 100000,
"currency": "USD"
},
"id": "fx_crv5u80dj96g452dfr2g",
"initial": {
"amount": 94412,
"currency": "EUR"
},
"object": "fx_transaction"
},
"id": "pot_crv5u81h1l071n2fk1ng",
"local": {
"fund_transfer_network": "ach"
},
"metadata": null,
"mt103": "",
"object": "payout",
"payout_fx_transaction": {
"exchange_rate": 1,
"final": {
"amount": 100000,
"currency": "USD"
},
"id": "fx_crv5u80dj96g452dfr20",
"initial": {
"amount": 100000,
"currency": "USD"
},
"object": "fx_transaction"
},
"purpose": "PYR001",
"quote": "poq_crv5u81h1l071n2fk1n0",
"confirmation_documents": [],
"reference_id": "INV-2024-0912",
"statement_descriptor": "tzp*Consulting Fee",
"status": "processing",
"status_description": "",
"failure": null,
"tracking_details": null,
"transaction_description": "Payment for consulting services",
"items": [
{
"name": "Premium subscription (Jan 2026)",
"quantity": 1,
"amount": 50000,
"category": "Goods",
"description": "Subscription payout"
}
],
"type": "swift",
"on_behalf_of": "ent_d68uqeuid0fvsnsfd1q0",
"logistics_tracking_details": [
{
"tracking_number": "1263",
"logistics_provider": {
"name": "DHL Express",
"code": "IO245"
}
}
]
}
}"{}"Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
Amount in cents. For example if you want to payout $10.12 pass 1012 as the value. For decimal handling for various currencies, refer to the guide here
ISO 4217 standard. This is the payout currency. The amount will be in the payout currency
Reason for payout. Click here for the detailed list.
PYR001, PYR002, PYR003, PYR004, PYR005, PYR006, PYR007, PYR008, PYR009, PYR010, PYR011, PYR012, PYR013, PYR014, PYR015, PYR016, PYR017, PYR018, PYR019, PYR020, PYR021, PYR022, PYR023, PYR024, PYR025, PYR026, PYR027, PYR028, PYR029, PYR030, PYR031, PYR032, PYR033, PYR034, PYR035, PYR036 Additional Details for the payout
Comprehensive beneficiary information including personal details and destination
Show child attributes
Show child attributes
ID of an existing payout beneficiary
ISO 4217 standard, in uppercase. This is one of your balance currencies whose balance will fund the payout.
Set of key-value pairs to attach to the payout object
Type of payout - local, swift, wallet, tazapay_account, local_payment_network
local, swift, wallet, local_payment_network, tazapay_account For wire transfers only
shared, ours Statement Descriptor for the payout
Reference ID of the payout on your system
Attach documents to the payout
Show child attributes
Show child attributes
ID of the entity the payout is created on behalf of
Logistics tracking details of the order. This is mandatory for CNY local payouts.
Show child attributes
Show child attributes
Quote ID from the payout quote API
Local payout configuration object
Show child attributes
Show child attributes
Optional list of invoice line items for the payout. Strongly advised when purpose is PYR022 (General Goods Trades - Offline trade) for CN-CNY local payouts to satisfy Chinese regulatory requirements. Each item represents a goods entry on the invoice.
Show child attributes
Show child attributes
Was this page helpful?