Create a pledged advance request
curl --request POST \
--url https://api.sandbox.trio.com.br/v2/pledged/advance_requests \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'Trio-Version: <trio-version>' \
--data '
{
"amount": 100000,
"assignor": {
"bank_account_digit": "2",
"bank_account_number": "0023123",
"branch_code": "0001",
"tax_number": "63558804023"
},
"bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010",
"description": "Antecipação de recebíveis",
"file_binary": "Q09OVFJBVE8=",
"payer": {
"tax_number": "80617053000195"
},
"pledged_by": "payer_tax_number"
}
'import requests
url = "https://api.sandbox.trio.com.br/v2/pledged/advance_requests"
payload = {
"amount": 100000,
"assignor": {
"bank_account_digit": "2",
"bank_account_number": "0023123",
"branch_code": "0001",
"tax_number": "63558804023"
},
"bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010",
"description": "Antecipação de recebíveis",
"file_binary": "Q09OVFJBVE8=",
"payer": { "tax_number": "80617053000195" },
"pledged_by": "payer_tax_number"
}
headers = {
"Trio-Version": "<trio-version>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Trio-Version': '<trio-version>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 100000,
assignor: {
bank_account_digit: '2',
bank_account_number: '0023123',
branch_code: '0001',
tax_number: '63558804023'
},
bank_account_id: '1a760495-cb95-4023-96e8-0cff5776b010',
description: 'Antecipação de recebíveis',
file_binary: 'Q09OVFJBVE8=',
payer: {tax_number: '80617053000195'},
pledged_by: 'payer_tax_number'
})
};
fetch('https://api.sandbox.trio.com.br/v2/pledged/advance_requests', 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.trio.com.br/v2/pledged/advance_requests",
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([
'amount' => 100000,
'assignor' => [
'bank_account_digit' => '2',
'bank_account_number' => '0023123',
'branch_code' => '0001',
'tax_number' => '63558804023'
],
'bank_account_id' => '1a760495-cb95-4023-96e8-0cff5776b010',
'description' => 'Antecipação de recebíveis',
'file_binary' => 'Q09OVFJBVE8=',
'payer' => [
'tax_number' => '80617053000195'
],
'pledged_by' => 'payer_tax_number'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"Trio-Version: <trio-version>"
],
]);
$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.trio.com.br/v2/pledged/advance_requests"
payload := strings.NewReader("{\n \"amount\": 100000,\n \"assignor\": {\n \"bank_account_digit\": \"2\",\n \"bank_account_number\": \"0023123\",\n \"branch_code\": \"0001\",\n \"tax_number\": \"63558804023\"\n },\n \"bank_account_id\": \"1a760495-cb95-4023-96e8-0cff5776b010\",\n \"description\": \"Antecipação de recebíveis\",\n \"file_binary\": \"Q09OVFJBVE8=\",\n \"payer\": {\n \"tax_number\": \"80617053000195\"\n },\n \"pledged_by\": \"payer_tax_number\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Trio-Version", "<trio-version>")
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://api.sandbox.trio.com.br/v2/pledged/advance_requests")
.header("Trio-Version", "<trio-version>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 100000,\n \"assignor\": {\n \"bank_account_digit\": \"2\",\n \"bank_account_number\": \"0023123\",\n \"branch_code\": \"0001\",\n \"tax_number\": \"63558804023\"\n },\n \"bank_account_id\": \"1a760495-cb95-4023-96e8-0cff5776b010\",\n \"description\": \"Antecipação de recebíveis\",\n \"file_binary\": \"Q09OVFJBVE8=\",\n \"payer\": {\n \"tax_number\": \"80617053000195\"\n },\n \"pledged_by\": \"payer_tax_number\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.trio.com.br/v2/pledged/advance_requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Trio-Version"] = '<trio-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 100000,\n \"assignor\": {\n \"bank_account_digit\": \"2\",\n \"bank_account_number\": \"0023123\",\n \"branch_code\": \"0001\",\n \"tax_number\": \"63558804023\"\n },\n \"bank_account_id\": \"1a760495-cb95-4023-96e8-0cff5776b010\",\n \"description\": \"Antecipação de recebíveis\",\n \"file_binary\": \"Q09OVFJBVE8=\",\n \"payer\": {\n \"tax_number\": \"80617053000195\"\n },\n \"pledged_by\": \"payer_tax_number\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"amount": {
"amount": 100000,
"currency": "BRL"
},
"approved_at": null,
"assignor": {
"bank_account_digit": "2",
"bank_account_id": "019084f3-ea10-3691-38dc-bda6ac03cb7c",
"bank_account_number": "0023123",
"tax_number": "63558804023"
},
"bank_account_id": "019084f3-ea10-3691-38dc-bda6ac03cb7b",
"canceled_at": null,
"charges": [],
"contract_file_reference": "pledged/contracts/1_contract.pdf",
"description": "Antecipação de recebíveis",
"entity_id": "019084f3-ea10-3691-38dc-bda6ac03cb7a",
"id": "019084f3-ea10-3691-38dc-bda6ac03cb70",
"inserted_at": "2026-09-10T12:00:00.000000Z",
"payer": {
"tax_number": "80617053000195"
},
"pledged_amount": {
"amount": 100000,
"currency": "BRL"
},
"pledged_balance": {
"amount": 100000,
"currency": "BRL"
},
"pledged_by": "payer_tax_number",
"rejected_at": null,
"status": "created",
"updated_at": "2026-09-10T12:00:00.000000Z"
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}Pledged
Create Advance Request
Create a pledged advance request, uploading its contract file
POST
/
v2
/
pledged
/
advance_requests
Create a pledged advance request
curl --request POST \
--url https://api.sandbox.trio.com.br/v2/pledged/advance_requests \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'Trio-Version: <trio-version>' \
--data '
{
"amount": 100000,
"assignor": {
"bank_account_digit": "2",
"bank_account_number": "0023123",
"branch_code": "0001",
"tax_number": "63558804023"
},
"bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010",
"description": "Antecipação de recebíveis",
"file_binary": "Q09OVFJBVE8=",
"payer": {
"tax_number": "80617053000195"
},
"pledged_by": "payer_tax_number"
}
'import requests
url = "https://api.sandbox.trio.com.br/v2/pledged/advance_requests"
payload = {
"amount": 100000,
"assignor": {
"bank_account_digit": "2",
"bank_account_number": "0023123",
"branch_code": "0001",
"tax_number": "63558804023"
},
"bank_account_id": "1a760495-cb95-4023-96e8-0cff5776b010",
"description": "Antecipação de recebíveis",
"file_binary": "Q09OVFJBVE8=",
"payer": { "tax_number": "80617053000195" },
"pledged_by": "payer_tax_number"
}
headers = {
"Trio-Version": "<trio-version>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Trio-Version': '<trio-version>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 100000,
assignor: {
bank_account_digit: '2',
bank_account_number: '0023123',
branch_code: '0001',
tax_number: '63558804023'
},
bank_account_id: '1a760495-cb95-4023-96e8-0cff5776b010',
description: 'Antecipação de recebíveis',
file_binary: 'Q09OVFJBVE8=',
payer: {tax_number: '80617053000195'},
pledged_by: 'payer_tax_number'
})
};
fetch('https://api.sandbox.trio.com.br/v2/pledged/advance_requests', 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.trio.com.br/v2/pledged/advance_requests",
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([
'amount' => 100000,
'assignor' => [
'bank_account_digit' => '2',
'bank_account_number' => '0023123',
'branch_code' => '0001',
'tax_number' => '63558804023'
],
'bank_account_id' => '1a760495-cb95-4023-96e8-0cff5776b010',
'description' => 'Antecipação de recebíveis',
'file_binary' => 'Q09OVFJBVE8=',
'payer' => [
'tax_number' => '80617053000195'
],
'pledged_by' => 'payer_tax_number'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"Trio-Version: <trio-version>"
],
]);
$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.trio.com.br/v2/pledged/advance_requests"
payload := strings.NewReader("{\n \"amount\": 100000,\n \"assignor\": {\n \"bank_account_digit\": \"2\",\n \"bank_account_number\": \"0023123\",\n \"branch_code\": \"0001\",\n \"tax_number\": \"63558804023\"\n },\n \"bank_account_id\": \"1a760495-cb95-4023-96e8-0cff5776b010\",\n \"description\": \"Antecipação de recebíveis\",\n \"file_binary\": \"Q09OVFJBVE8=\",\n \"payer\": {\n \"tax_number\": \"80617053000195\"\n },\n \"pledged_by\": \"payer_tax_number\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Trio-Version", "<trio-version>")
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://api.sandbox.trio.com.br/v2/pledged/advance_requests")
.header("Trio-Version", "<trio-version>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 100000,\n \"assignor\": {\n \"bank_account_digit\": \"2\",\n \"bank_account_number\": \"0023123\",\n \"branch_code\": \"0001\",\n \"tax_number\": \"63558804023\"\n },\n \"bank_account_id\": \"1a760495-cb95-4023-96e8-0cff5776b010\",\n \"description\": \"Antecipação de recebíveis\",\n \"file_binary\": \"Q09OVFJBVE8=\",\n \"payer\": {\n \"tax_number\": \"80617053000195\"\n },\n \"pledged_by\": \"payer_tax_number\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.trio.com.br/v2/pledged/advance_requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Trio-Version"] = '<trio-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 100000,\n \"assignor\": {\n \"bank_account_digit\": \"2\",\n \"bank_account_number\": \"0023123\",\n \"branch_code\": \"0001\",\n \"tax_number\": \"63558804023\"\n },\n \"bank_account_id\": \"1a760495-cb95-4023-96e8-0cff5776b010\",\n \"description\": \"Antecipação de recebíveis\",\n \"file_binary\": \"Q09OVFJBVE8=\",\n \"payer\": {\n \"tax_number\": \"80617053000195\"\n },\n \"pledged_by\": \"payer_tax_number\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"amount": {
"amount": 100000,
"currency": "BRL"
},
"approved_at": null,
"assignor": {
"bank_account_digit": "2",
"bank_account_id": "019084f3-ea10-3691-38dc-bda6ac03cb7c",
"bank_account_number": "0023123",
"tax_number": "63558804023"
},
"bank_account_id": "019084f3-ea10-3691-38dc-bda6ac03cb7b",
"canceled_at": null,
"charges": [],
"contract_file_reference": "pledged/contracts/1_contract.pdf",
"description": "Antecipação de recebíveis",
"entity_id": "019084f3-ea10-3691-38dc-bda6ac03cb7a",
"id": "019084f3-ea10-3691-38dc-bda6ac03cb70",
"inserted_at": "2026-09-10T12:00:00.000000Z",
"payer": {
"tax_number": "80617053000195"
},
"pledged_amount": {
"amount": 100000,
"currency": "BRL"
},
"pledged_balance": {
"amount": 100000,
"currency": "BRL"
},
"pledged_by": "payer_tax_number",
"rejected_at": null,
"status": "created",
"updated_at": "2026-09-10T12:00:00.000000Z"
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Headers
Version of the v2 contract the client is written against. Each breaking change publishes a new version.
Available options:
2026-10-19.v2 ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.
Body
application/json
Pledged advance request payload
Body params to create a pledged advance request
Amount in cents
Required range:
x >= 1Assignor of the pledged receivables and its Trio bank account
Show child attributes
Show child attributes
Bank account that receives the advance
Payer of the pledged receivables. Required for both pledged_by values, since the payer is always registered as the counterparty
Show child attributes
Show child attributes
What the receivables are pledged by: every charge of the payer, or the charges listed
Available options:
payer_tax_number, charge_id Charge IDs, used when pledged_by is charge_id
Description
Contract file content encoded in base64
Response
Advance request
A pledged advance request
Pledged advance request
Show child attributes
Show child attributes
Example:
{
"amount": { "amount": 100000, "currency": "BRL" },
"approved_at": null,
"assignor": {
"bank_account_digit": "2",
"bank_account_id": "019084f3-ea10-3691-38dc-bda6ac03cb7c",
"bank_account_number": "0023123",
"tax_number": "63558804023"
},
"bank_account_id": "019084f3-ea10-3691-38dc-bda6ac03cb7b",
"canceled_at": null,
"charges": [],
"contract_file_reference": "pledged/contracts/1_contract.pdf",
"description": "Antecipação de recebíveis",
"entity_id": "019084f3-ea10-3691-38dc-bda6ac03cb7a",
"id": "019084f3-ea10-3691-38dc-bda6ac03cb70",
"inserted_at": "2026-09-10T12:00:00.000000Z",
"payer": { "tax_number": "80617053000195" },
"pledged_amount": { "amount": 100000, "currency": "BRL" },
"pledged_balance": { "amount": 100000, "currency": "BRL" },
"pledged_by": "payer_tax_number",
"rejected_at": null,
"status": "created",
"updated_at": "2026-09-10T12:00:00.000000Z"
}