Get Payout
curl --request GET \
--url https://api.zopay.cash/connect/v1/payouts/{payout_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.zopay.cash/connect/v1/payouts/{payout_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.zopay.cash/connect/v1/payouts/{payout_id}', 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.zopay.cash/connect/v1/payouts/{payout_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zopay.cash/connect/v1/payouts/{payout_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zopay.cash/connect/v1/payouts/{payout_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zopay.cash/connect/v1/payouts/{payout_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "pending",
"timeline": [
{
"step": "queued",
"at": "2023-11-07T05:31:56Z",
"tx_hash": "<string>"
}
],
"fees_paid_usd": "<string>",
"final_recipient_amount": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}Payouts
Get Payout
Status + timeline for an existing payout.
GET
/
payouts
/
{payout_id}
Get Payout
curl --request GET \
--url https://api.zopay.cash/connect/v1/payouts/{payout_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.zopay.cash/connect/v1/payouts/{payout_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.zopay.cash/connect/v1/payouts/{payout_id}', 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.zopay.cash/connect/v1/payouts/{payout_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zopay.cash/connect/v1/payouts/{payout_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zopay.cash/connect/v1/payouts/{payout_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zopay.cash/connect/v1/payouts/{payout_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "pending",
"timeline": [
{
"step": "queued",
"at": "2023-11-07T05:31:56Z",
"tx_hash": "<string>"
}
],
"fees_paid_usd": "<string>",
"final_recipient_amount": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_...",
"doc_url": "https://docs.zopay.cash/errors/authentication_required",
"param": "currencies"
}
}Status + timeline for an existing payout.
Sandbox returns a fully-delivered timeline so partners see the
happy-path shape immediately; production reads
transaction_saga_events for the real progression. Either
way the shape is identical.
Cross-tenant lookups collapse to 404 payout_not_found in
production. Sandbox doesn’t enforce tenant scoping (there is
no real payout to scope) and returns a canned body for any
well-formed id.Authorizations
Paste your Connect API key (sk_live_… for production, sk_test_… for sandbox) without the Bearer prefix. Mint and rotate keys from the admin panel.
Path Parameters
Response
Successful Response
Response body for GET /payouts/:id.
Extends the execute response with the timeline + actual fees + final amount once known.
Available options:
pending, broadcast, delivered, failed Show child attributes
Show child attributes
Actual fee paid, may differ from the quoted fee_total_usd for routes where the gas oracle came in cheaper / more expensive than expected. Stable after status=delivered.
Actual amount that landed at the destination. Equals the quoted recipient_gets for native routes; for bridge routes it may differ marginally.