curl --request POST \
--url https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/global \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'payload=<string>' \
--form document='@example-file' \
--form attachments.items='@example-file'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/global"
files = {
"document": ("example-file", open("example-file", "rb")),
"attachments.items": ("example-file", open("example-file", "rb"))
}
payload = { "payload": "<string>" }
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('payload', '<string>');
form.append('document', '<string>');
form.append('attachments.items', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/global', 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/global",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payload\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachments.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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://api-sandbox.finogates.com/v1/platform/payments/document-mailing/global"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payload\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachments.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/global")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payload\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachments.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/global")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payload\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachments.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"status_code": 201,
"data": {
"document_shipping_id": "9b1e6c2a-4f3d-4a8b-9c7e-2d5f1a6b3c4d",
"payment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "pending",
"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": "pending_review",
"created_at": "2026-08-24T14:30:00Z",
"updated_at": "2026-08-24T14:30: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
},
"query_generated_time": 1712847600000
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Mail a Document (Full Payload)
Mail a document you supply with the recipient sent inline - everything in one call, nothing registered beforehand. The counterpart to POST /document-mailing for a one-off recipient you do not keep.
This shape has no payee_id to anchor ownership on. Send sender to type a one-off sender identity — that address prints on the label instead of the facility address. Omit it and the owner (and mailing label) default to your platform’s own admin/master account. Do not send user_id; it is resolved automatically either way.
This is a multipart/form-data request: document (and optional attachments) are file parts, and payload is this JSON, encoded as a string, alongside them.
Sample payload:
{
"sender": {
"name": "Jane Roe",
"email": "jane@example.com",
"phone": "+12125550123",
"line_1": "123 Main St",
"city": "Austin",
"state": "TX",
"zip": "78701",
"country": "US"
},
"recipient": {
"name": "Dana Reed",
"line_1": "456 Oak Ave",
"city": "Denver",
"state": "CO",
"zip": "80202",
"country": "US"
},
"mail_type": "usps_ground_advantage",
"currency": "USD",
"description": "Signed lease agreement",
"idempotency_key": "doc-mail-2026-08-24-002"
}
sender is optional — omit it entirely to mail as your platform’s own admin/master account instead of a typed one-off sender.
curl --request POST \
--url https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/global \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'payload=<string>' \
--form document='@example-file' \
--form attachments.items='@example-file'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/global"
files = {
"document": ("example-file", open("example-file", "rb")),
"attachments.items": ("example-file", open("example-file", "rb"))
}
payload = { "payload": "<string>" }
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('payload', '<string>');
form.append('document', '<string>');
form.append('attachments.items', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/global', 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/global",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payload\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachments.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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://api-sandbox.finogates.com/v1/platform/payments/document-mailing/global"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payload\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachments.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/global")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payload\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachments.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/payments/document-mailing/global")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payload\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachments.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"status_code": 201,
"data": {
"document_shipping_id": "9b1e6c2a-4f3d-4a8b-9c7e-2d5f1a6b3c4d",
"payment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "pending",
"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": "pending_review",
"created_at": "2026-08-24T14:30:00Z",
"updated_at": "2026-08-24T14:30: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
},
"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.
Body
Response
The mailed document, straight after create.

