curl --request GET \
--url https://api.zopay.cash/connect/v1/payment-intents/{payment_intent_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.zopay.cash/connect/v1/payment-intents/{payment_intent_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/payment-intents/{payment_intent_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/payment-intents/{payment_intent_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/payment-intents/{payment_intent_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/payment-intents/{payment_intent_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zopay.cash/connect/v1/payment-intents/{payment_intent_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>",
"currency": "<string>",
"object": "payment_intent",
"amount": 123,
"status": "<string>",
"ref_code": "<string>",
"external_ref": "<string>",
"description": "<string>",
"metadata": {},
"addresses": [
{
"asset": "<string>",
"address": "<string>",
"network": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"deposit": {
"amount_received": 123,
"currency": "<string>",
"network": "<string>",
"address_receiver": "<string>",
"address_sender": "<string>",
"tx_hash": "<string>"
},
"amount_received": 0,
"amount_remaining": 0,
"partial_payment": false
}{
"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"
}
}Get Payment Intent
Single payment intent by UUID.
curl --request GET \
--url https://api.zopay.cash/connect/v1/payment-intents/{payment_intent_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.zopay.cash/connect/v1/payment-intents/{payment_intent_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/payment-intents/{payment_intent_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/payment-intents/{payment_intent_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/payment-intents/{payment_intent_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/payment-intents/{payment_intent_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zopay.cash/connect/v1/payment-intents/{payment_intent_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>",
"currency": "<string>",
"object": "payment_intent",
"amount": 123,
"status": "<string>",
"ref_code": "<string>",
"external_ref": "<string>",
"description": "<string>",
"metadata": {},
"addresses": [
{
"asset": "<string>",
"address": "<string>",
"network": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"deposit": {
"amount_received": 123,
"currency": "<string>",
"network": "<string>",
"address_receiver": "<string>",
"address_sender": "<string>",
"tx_hash": "<string>"
},
"amount_received": 0,
"amount_remaining": 0,
"partial_payment": false
}{
"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"
}
}InvalidRequestError (400
invalid_payment_intent_id) rather than passing through to the
DB where it would crash with a psycopg2 cast error.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
Payment intent UUID as returned from list / create.
Response
Successful Response
Stripe-shaped payment intent envelope.
Payment intent UUID. Pass to GET /payment-intents/:id.
Primary asset code, uppercase (e.g. USDT).
Always payment_intent. Stripe convention.
Requested amount in the intent's primary asset.
Intent status. One of: pending, partial, completed, expired (snake_case, Stripe-compatible).
5-character public-page identifier. Embedded in hosted checkout URLs (zopay.cash/pay/<ref_code>).
Partner-supplied attribution key as passed to POST /payment-intents. Echoed verbatim. Use for your own per-user reconciliation.
Partner-supplied description, echoed verbatim.
Partner-supplied metadata, echoed verbatim. NULL when no metadata was sent at creation.
Per (asset, network) deposit destinations. One row per currency / network pair available on this intent.
Show child attributes
Show child attributes
When the intent was minted.
When the intent stops accepting deposits.
When the intent transitioned to status='completed'. NULL while pending. Idempotency anchor for the completion transition -- a retried call sees the same value, never a fresh one.
Chain-side details of the deposit that fulfilled this intent. NULL while pending; populated on completion. Field-for-field parity with the payment_intent.completed webhook event payload so pull and push reconciliation see one shape. On a partial-then-complete intent this object reflects the LATEST deposit, not the cumulative total; use amount_received for the cumulative figure.
Show child attributes
Show child attributes
Cumulative amount credited against this intent across all completed deposits. Always present; defaults to 0.0 when nothing has landed yet. On a partial payment this is the partial total; once the intent transitions to completed it equals (or slightly exceeds, by up to the 0.01 tolerance) amount.
Raw remaining amount: max(0, amount - amount_received). No tolerance applied -- partners that want to render a 'pay X more' UI should check partial_payment first and read this value as the literal shortfall. A near-complete intent within the 0.01 tolerance shows a small positive value here but partial_payment=false.
True iff the intent has received at least one deposit but is not yet completed: amount_received > 0 AND status == 'pending'. Use this as the canonical 'is incomplete' boolean for partial-payment UI. Tolerance is handled transitively through status: the credit flow only leaves the intent in pending when the cumulative received amount is below the (amount - 0.01) threshold, so a near-complete intent within tolerance has already transitioned to completed and surfaces as partial_payment=false here.