Get a Mailed Document
curl --request GET \
--url https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_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-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_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-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_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-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_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-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_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{
"status_code": 200,
"data": {
"document_shipping_id": "9b1e6c2a-4f3d-4a8b-9c7e-2d5f1a6b3c4d",
"payment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "mailed",
"mail_type": "usps_ground_advantage",
"amount": 0,
"fee_amount": 12.35,
"total_amount": 12.35,
"currency": "USD",
"recipient": {
"name": "Dana Reed",
"phone": "+13035550188",
"line_1": "456 Oak Ave",
"line_2": "Suite 200",
"city": "Denver",
"state": "CO",
"zip": "80202",
"country": "US"
},
"description": "Q3 invoice packet",
"invoice_number": "INV-10432",
"intent_status": "succeeded",
"created_at": "2026-08-24T14:30:00Z",
"updated_at": "2026-08-26T17:45:00Z",
"attachments": [
{
"id": "7c4d2e1a-8b3f-4d6c-9a1e-5f2b3c4d5e6f",
"file_name": "remittance_advice.pdf",
"page_count": 2,
"byte_size": 184320,
"ordinal": 0
}
],
"attachment_page_count": 2,
"attachment_fee": 0.5,
"document_page_count": 10,
"document_fee": 4.9,
"shipping_fee": 6.95,
"carrier_cost": 5.2,
"markup": 1.75,
"tracking": {
"trackable": true,
"tracking_number": "9400100000000000000000",
"carrier": "usps",
"carrier_label": "USPS",
"service": "USPS Ground Advantage",
"status": "delivered",
"status_label": "Delivered",
"shipped_at": "2026-08-24T15:02:00Z",
"estimated_delivery_at": "2026-08-27T00:00:00Z",
"delivered_at": "2026-08-26T17:45:00Z",
"delivered_to": "J.SMITH",
"synced_at": "2026-08-26T18:02:00Z",
"carrier_tracking_url": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9400100000000000000000"
}
},
"query_generated_time": 1712847600000
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Get a Mailed Document
One mailed document by its payment id.
GET
/
v1
/
platform
/
payments
/
document-mailing
/
{payment_id}
Get a Mailed Document
curl --request GET \
--url https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_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-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_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-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_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-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_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-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/{payment_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{
"status_code": 200,
"data": {
"document_shipping_id": "9b1e6c2a-4f3d-4a8b-9c7e-2d5f1a6b3c4d",
"payment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "mailed",
"mail_type": "usps_ground_advantage",
"amount": 0,
"fee_amount": 12.35,
"total_amount": 12.35,
"currency": "USD",
"recipient": {
"name": "Dana Reed",
"phone": "+13035550188",
"line_1": "456 Oak Ave",
"line_2": "Suite 200",
"city": "Denver",
"state": "CO",
"zip": "80202",
"country": "US"
},
"description": "Q3 invoice packet",
"invoice_number": "INV-10432",
"intent_status": "succeeded",
"created_at": "2026-08-24T14:30:00Z",
"updated_at": "2026-08-26T17:45:00Z",
"attachments": [
{
"id": "7c4d2e1a-8b3f-4d6c-9a1e-5f2b3c4d5e6f",
"file_name": "remittance_advice.pdf",
"page_count": 2,
"byte_size": 184320,
"ordinal": 0
}
],
"attachment_page_count": 2,
"attachment_fee": 0.5,
"document_page_count": 10,
"document_fee": 4.9,
"shipping_fee": 6.95,
"carrier_cost": 5.2,
"markup": 1.75,
"tracking": {
"trackable": true,
"tracking_number": "9400100000000000000000",
"carrier": "usps",
"carrier_label": "USPS",
"service": "USPS Ground Advantage",
"status": "delivered",
"status_label": "Delivered",
"shipped_at": "2026-08-24T15:02:00Z",
"estimated_delivery_at": "2026-08-27T00:00:00Z",
"delivered_at": "2026-08-26T17:45:00Z",
"delivered_to": "J.SMITH",
"synced_at": "2026-08-26T18:02:00Z",
"carrier_tracking_url": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9400100000000000000000"
}
},
"query_generated_time": 1712847600000
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.

