Atualizar rastreio de entrega

PUT

transactions

{id}

delivery

Update Delivery Tracking

curl --request PUT \
  --url https://api.pagou.ai/v2/transactions/{id}/delivery \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tracking_code": "BR123456789BR",
  "delivery_status": "in_transit",
  "tracking_url": "https://tracking.carrier.com/BR123456789BR",
  "tracking_company": "Correios"
}
'

import requests

url = "https://api.pagou.ai/v2/transactions/{id}/delivery"

payload = {
    "tracking_code": "BR123456789BR",
    "delivery_status": "in_transit",
    "tracking_url": "https://tracking.carrier.com/BR123456789BR",
    "tracking_company": "Correios"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tracking_code: 'BR123456789BR',
    delivery_status: 'in_transit',
    tracking_url: 'https://tracking.carrier.com/BR123456789BR',
    tracking_company: 'Correios'
  })
};

fetch('https://api.pagou.ai/v2/transactions/{id}/delivery', 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.pagou.ai/v2/transactions/{id}/delivery",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'tracking_code' => 'BR123456789BR',
    'delivery_status' => 'in_transit',
    'tracking_url' => 'https://tracking.carrier.com/BR123456789BR',
    'tracking_company' => 'Correios'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.pagou.ai/v2/transactions/{id}/delivery"

	payload := strings.NewReader("{\n  \"tracking_code\": \"BR123456789BR\",\n  \"delivery_status\": \"in_transit\",\n  \"tracking_url\": \"https://tracking.carrier.com/BR123456789BR\",\n  \"tracking_company\": \"Correios\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.pagou.ai/v2/transactions/{id}/delivery")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tracking_code\": \"BR123456789BR\",\n  \"delivery_status\": \"in_transit\",\n  \"tracking_url\": \"https://tracking.carrier.com/BR123456789BR\",\n  \"tracking_company\": \"Correios\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pagou.ai/v2/transactions/{id}/delivery")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tracking_code\": \"BR123456789BR\",\n  \"delivery_status\": \"in_transit\",\n  \"tracking_url\": \"https://tracking.carrier.com/BR123456789BR\",\n  \"tracking_company\": \"Correios\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "requestId": "0190a2b4-18a7-7de0-9a43-69b7cf261201",
  "data": {
    "status": "waiting",
    "code": "string",
    "url": "string",
    "company": "string",
    "last_update": "2026-07-14T12:00:00.000Z"
  }
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Defina ou atualize as informações de rastreio de entrega em uma transação paga. Use na URL o UUID retornado como id da transação. Autentique com a API key da sua empresa (Bearer, API key ou Basic auth). Depois de definido, o rastreio aparece em Consultar transação nos campos de entrega da transação.

Campos da requisição

O corpo é JSON com campos em snake_case:

Campo	Tipo	Obrigatório	Restrições
`tracking_code`	string	Sim	Sem espaços nas pontas, 1–255 caracteres, sem caracteres de controle ASCII.
`delivery_status`	enum	Não	Um de `waiting`, `in_transit`, `delivered`. Padrão `in_transit` no primeiro envio.
`tracking_url`	string \| null	Não	Sem espaços nas pontas, máx. 255 caracteres, deve começar com `http://` ou `https://`.
`tracking_company`	string \| null	Não	Sem espaços nas pontas, 1–64 caracteres.

Omitir vs. null

Omita um campo opcional para manter o valor atual inalterado.
Envie null em tracking_url ou tracking_company para limpar um valor definido anteriormente.
Quando delivery_status é omitido, o status atual é preservado na atualização, ou assume in_transit na primeira vez que o rastreio é definido.
Uma entrega já marcada como delivered não pode voltar para waiting ou in_transit (retorna 409).

Idempotência e concorrência

PUT é idempotente — repetir a mesma requisição produz o mesmo estado de entrega. Para concorrência otimista, envie o ETag da transação no header If-Match; um ETag desatualizado retorna 412 Precondition Failed.

Erros

Status	Significado
`400`	Requisição malformada.
`401`	Credenciais ausentes ou inválidas.
`404`	Transação não encontrada para esta empresa.
`409`	Transição de status inválida (ex.: reverter uma entrega `delivered`).
`412`	ETag do `If-Match` não confere.
`422`	Validação falhou (restrições de campo não atendidas).
`429`	Limite de requisições excedido.

Exemplo

curl -X PUT "https://api.pagou.ai/v2/transactions/{id}/delivery" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "tracking_code": "BR123456789BR",
    "delivery_status": "in_transit",
    "tracking_url": "https://tracking.carrier.com/BR123456789BR",
    "tracking_company": "Correios"
  }'

{
  "success": true,
  "requestId": "0190a2b4-18a7-7de0-9a43-69b7cf261201",
  "data": {
    "status": "in_transit",
    "code": "BR123456789BR",
    "url": "https://tracking.carrier.com/BR123456789BR",
    "company": "Correios",
    "last_update": "2026-07-14T12:00:00.000Z"
  }
}

O rastreio atualizado passa a aparecer em GET /v2/transactions/{id}.

Autorizações

Authorization

string

header

obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

string<uuid>

obrigatório

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Corpo

application/json

tracking_code

string

obrigatório

Carrier tracking code for the shipment. Required.

Required string length: 1 - 255

Exemplo:

"BR123456789BR"

delivery_status

enum<string>

Delivery status of the shipment. One of waiting, in_transit, or delivered. When omitted, the existing status is preserved on update, or defaults to in_transit on the first update.

Opções disponíveis:

waiting,

in_transit,

delivered

Exemplo:

"in_transit"

tracking_url

string | null

Public URL where the buyer can track the shipment. Must start with http:// or https://. Send null to clear a previously set value; omit to leave it unchanged.

Maximum string length: 255

Exemplo:

"https://tracking.carrier.com/BR123456789BR"

tracking_company

string | null

Name of the carrier handling the shipment. Send null to clear a previously set value; omit to leave it unchanged.

Required string length: 1 - 64

Exemplo:

"Correios"

Resposta

Success

success

boolean

obrigatório

requestId

string

obrigatório

data

object

obrigatório

Show child attributes

Update Delivery Tracking

curl --request PUT \
  --url https://api.pagou.ai/v2/transactions/{id}/delivery \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tracking_code": "BR123456789BR",
  "delivery_status": "in_transit",
  "tracking_url": "https://tracking.carrier.com/BR123456789BR",
  "tracking_company": "Correios"
}
'

import requests

url = "https://api.pagou.ai/v2/transactions/{id}/delivery"

payload = {
    "tracking_code": "BR123456789BR",
    "delivery_status": "in_transit",
    "tracking_url": "https://tracking.carrier.com/BR123456789BR",
    "tracking_company": "Correios"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tracking_code: 'BR123456789BR',
    delivery_status: 'in_transit',
    tracking_url: 'https://tracking.carrier.com/BR123456789BR',
    tracking_company: 'Correios'
  })
};

fetch('https://api.pagou.ai/v2/transactions/{id}/delivery', 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.pagou.ai/v2/transactions/{id}/delivery",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'tracking_code' => 'BR123456789BR',
    'delivery_status' => 'in_transit',
    'tracking_url' => 'https://tracking.carrier.com/BR123456789BR',
    'tracking_company' => 'Correios'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.pagou.ai/v2/transactions/{id}/delivery"

	payload := strings.NewReader("{\n  \"tracking_code\": \"BR123456789BR\",\n  \"delivery_status\": \"in_transit\",\n  \"tracking_url\": \"https://tracking.carrier.com/BR123456789BR\",\n  \"tracking_company\": \"Correios\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.pagou.ai/v2/transactions/{id}/delivery")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tracking_code\": \"BR123456789BR\",\n  \"delivery_status\": \"in_transit\",\n  \"tracking_url\": \"https://tracking.carrier.com/BR123456789BR\",\n  \"tracking_company\": \"Correios\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pagou.ai/v2/transactions/{id}/delivery")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tracking_code\": \"BR123456789BR\",\n  \"delivery_status\": \"in_transit\",\n  \"tracking_url\": \"https://tracking.carrier.com/BR123456789BR\",\n  \"tracking_company\": \"Correios\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "requestId": "0190a2b4-18a7-7de0-9a43-69b7cf261201",
  "data": {
    "status": "waiting",
    "code": "string",
    "url": "string",
    "company": "string",
    "last_update": "2026-07-14T12:00:00.000Z"
  }
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Clientes

Transações

Checkout Links

Transferências

Assinaturas

Legado v1

Campos da requisição

Omitir vs. null

Idempotência e concorrência

Erros

Exemplo

Autorizações

Parâmetros de caminho

Corpo

Resposta

​Campos da requisição

​Omitir vs. null

​Idempotência e concorrência

​Erros

​Exemplo

Autorizações

Parâmetros de caminho

Corpo

Resposta

Campos da requisição

Omitir vs. null

Idempotência e concorrência

Erros

Exemplo