Criar Estorno
curl --request POST \
--url https://pay.autorizou.dev/api/v1/refunds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payment_id": "<string>",
"amount": 123,
"reason": "<string>",
"bank_account": {
"bank_account.holder_name": "<string>",
"bank_account.holder_type": "<string>",
"bank_account.holder_document": "<string>",
"bank_account.bank": "<string>",
"bank_account.branch_number": "<string>",
"bank_account.branch_check_digit": "<string>",
"bank_account.account_number": "<string>",
"bank_account.account_check_digit": "<string>"
}
}
'import requests
url = "https://pay.autorizou.dev/api/v1/refunds"
payload = {
"payment_id": "<string>",
"amount": 123,
"reason": "<string>",
"bank_account": {
"bank_account.holder_name": "<string>",
"bank_account.holder_type": "<string>",
"bank_account.holder_document": "<string>",
"bank_account.bank": "<string>",
"bank_account.branch_number": "<string>",
"bank_account.branch_check_digit": "<string>",
"bank_account.account_number": "<string>",
"bank_account.account_check_digit": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payment_id: '<string>',
amount: 123,
reason: '<string>',
bank_account: {
'bank_account.holder_name': '<string>',
'bank_account.holder_type': '<string>',
'bank_account.holder_document': '<string>',
'bank_account.bank': '<string>',
'bank_account.branch_number': '<string>',
'bank_account.branch_check_digit': '<string>',
'bank_account.account_number': '<string>',
'bank_account.account_check_digit': '<string>'
}
})
};
fetch('https://pay.autorizou.dev/api/v1/refunds', 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://pay.autorizou.dev/api/v1/refunds",
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([
'payment_id' => '<string>',
'amount' => 123,
'reason' => '<string>',
'bank_account' => [
'bank_account.holder_name' => '<string>',
'bank_account.holder_type' => '<string>',
'bank_account.holder_document' => '<string>',
'bank_account.bank' => '<string>',
'bank_account.branch_number' => '<string>',
'bank_account.branch_check_digit' => '<string>',
'bank_account.account_number' => '<string>',
'bank_account.account_check_digit' => '<string>'
]
]),
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://pay.autorizou.dev/api/v1/refunds"
payload := strings.NewReader("{\n \"payment_id\": \"<string>\",\n \"amount\": 123,\n \"reason\": \"<string>\",\n \"bank_account\": {\n \"bank_account.holder_name\": \"<string>\",\n \"bank_account.holder_type\": \"<string>\",\n \"bank_account.holder_document\": \"<string>\",\n \"bank_account.bank\": \"<string>\",\n \"bank_account.branch_number\": \"<string>\",\n \"bank_account.branch_check_digit\": \"<string>\",\n \"bank_account.account_number\": \"<string>\",\n \"bank_account.account_check_digit\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://pay.autorizou.dev/api/v1/refunds")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payment_id\": \"<string>\",\n \"amount\": 123,\n \"reason\": \"<string>\",\n \"bank_account\": {\n \"bank_account.holder_name\": \"<string>\",\n \"bank_account.holder_type\": \"<string>\",\n \"bank_account.holder_document\": \"<string>\",\n \"bank_account.bank\": \"<string>\",\n \"bank_account.branch_number\": \"<string>\",\n \"bank_account.branch_check_digit\": \"<string>\",\n \"bank_account.account_number\": \"<string>\",\n \"bank_account.account_check_digit\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pay.autorizou.dev/api/v1/refunds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payment_id\": \"<string>\",\n \"amount\": 123,\n \"reason\": \"<string>\",\n \"bank_account\": {\n \"bank_account.holder_name\": \"<string>\",\n \"bank_account.holder_type\": \"<string>\",\n \"bank_account.holder_document\": \"<string>\",\n \"bank_account.bank\": \"<string>\",\n \"bank_account.branch_number\": \"<string>\",\n \"bank_account.branch_check_digit\": \"<string>\",\n \"bank_account.account_number\": \"<string>\",\n \"bank_account.account_check_digit\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"payment_id": "<string>",
"amount": 123,
"status": "<string>",
"type": "<string>"
}Reembolsos
Criar Estorno
Estornar total ou parcialmente um pagamento autorizado
POST
/
api
/
v1
/
refunds
Criar Estorno
curl --request POST \
--url https://pay.autorizou.dev/api/v1/refunds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payment_id": "<string>",
"amount": 123,
"reason": "<string>",
"bank_account": {
"bank_account.holder_name": "<string>",
"bank_account.holder_type": "<string>",
"bank_account.holder_document": "<string>",
"bank_account.bank": "<string>",
"bank_account.branch_number": "<string>",
"bank_account.branch_check_digit": "<string>",
"bank_account.account_number": "<string>",
"bank_account.account_check_digit": "<string>"
}
}
'import requests
url = "https://pay.autorizou.dev/api/v1/refunds"
payload = {
"payment_id": "<string>",
"amount": 123,
"reason": "<string>",
"bank_account": {
"bank_account.holder_name": "<string>",
"bank_account.holder_type": "<string>",
"bank_account.holder_document": "<string>",
"bank_account.bank": "<string>",
"bank_account.branch_number": "<string>",
"bank_account.branch_check_digit": "<string>",
"bank_account.account_number": "<string>",
"bank_account.account_check_digit": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payment_id: '<string>',
amount: 123,
reason: '<string>',
bank_account: {
'bank_account.holder_name': '<string>',
'bank_account.holder_type': '<string>',
'bank_account.holder_document': '<string>',
'bank_account.bank': '<string>',
'bank_account.branch_number': '<string>',
'bank_account.branch_check_digit': '<string>',
'bank_account.account_number': '<string>',
'bank_account.account_check_digit': '<string>'
}
})
};
fetch('https://pay.autorizou.dev/api/v1/refunds', 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://pay.autorizou.dev/api/v1/refunds",
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([
'payment_id' => '<string>',
'amount' => 123,
'reason' => '<string>',
'bank_account' => [
'bank_account.holder_name' => '<string>',
'bank_account.holder_type' => '<string>',
'bank_account.holder_document' => '<string>',
'bank_account.bank' => '<string>',
'bank_account.branch_number' => '<string>',
'bank_account.branch_check_digit' => '<string>',
'bank_account.account_number' => '<string>',
'bank_account.account_check_digit' => '<string>'
]
]),
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://pay.autorizou.dev/api/v1/refunds"
payload := strings.NewReader("{\n \"payment_id\": \"<string>\",\n \"amount\": 123,\n \"reason\": \"<string>\",\n \"bank_account\": {\n \"bank_account.holder_name\": \"<string>\",\n \"bank_account.holder_type\": \"<string>\",\n \"bank_account.holder_document\": \"<string>\",\n \"bank_account.bank\": \"<string>\",\n \"bank_account.branch_number\": \"<string>\",\n \"bank_account.branch_check_digit\": \"<string>\",\n \"bank_account.account_number\": \"<string>\",\n \"bank_account.account_check_digit\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://pay.autorizou.dev/api/v1/refunds")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payment_id\": \"<string>\",\n \"amount\": 123,\n \"reason\": \"<string>\",\n \"bank_account\": {\n \"bank_account.holder_name\": \"<string>\",\n \"bank_account.holder_type\": \"<string>\",\n \"bank_account.holder_document\": \"<string>\",\n \"bank_account.bank\": \"<string>\",\n \"bank_account.branch_number\": \"<string>\",\n \"bank_account.branch_check_digit\": \"<string>\",\n \"bank_account.account_number\": \"<string>\",\n \"bank_account.account_check_digit\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pay.autorizou.dev/api/v1/refunds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payment_id\": \"<string>\",\n \"amount\": 123,\n \"reason\": \"<string>\",\n \"bank_account\": {\n \"bank_account.holder_name\": \"<string>\",\n \"bank_account.holder_type\": \"<string>\",\n \"bank_account.holder_document\": \"<string>\",\n \"bank_account.bank\": \"<string>\",\n \"bank_account.branch_number\": \"<string>\",\n \"bank_account.branch_check_digit\": \"<string>\",\n \"bank_account.account_number\": \"<string>\",\n \"bank_account.account_check_digit\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"payment_id": "<string>",
"amount": 123,
"status": "<string>",
"type": "<string>"
}Este endpoint estorna pagamentos, com suporte a estorno total e parcial. Quando a venda tem
split, a reversão das fatias acontece automaticamente no motor financeiro, respeitando o que cada
participante ainda deve devolver.
Parâmetros
string
required
UUID do pagamento a estornar.
integer
Valor a estornar, em centavos. Omitido = estorno total do remanescente (o servidor usa o
valor exato, sem risco de arredondamento). Informado = estorno parcial.O valor não pode exceder o remanescente reembolsável (valor original menos estornos já
solicitados/concluídos). Acima disso a API rejeita com
422 — nunca ajusta por conta própria.string
Motivo do estorno (texto livre, para seu controle).
object
Obrigatório quando o pagamento é boleto (
bank_slip): a conta que recebe a devolução.Show Estrutura da conta bancária
Show Estrutura da conta bancária
string
required
Nome do titular (máx. 255)
string
required
Tipo do documento do titular:
cpf ou cnpjstring
required
Documento do titular (apenas dígitos)
string
required
Código do banco (ex.:
341)string
required
Agência (máx. 13)
string
required
Dígito da agência (máx. 2)
string
required
Número da conta (máx. 13)
string
required
Dígito da conta (máx. 2)
Pré-requisitos
- O pagamento precisa estar
authorizedourefunded_partially. Qualquer outro status é rejeitado com422. - O pagamento precisa pertencer à sua conta (a chave usada). Pagamento de outro lojista responde
404.
Exemplos de Requisição
curl -X POST https://pay.autorizou.dev/api/v1/refunds \
-H "Authorization: Bearer SUA_CHAVE" \
-H "Content-Type: application/json" \
-d '{
"payment_id": "b81f4c26-5d9e-4f7a-8c3b-2e6a9d4f1b58"
}'
curl -X POST https://pay.autorizou.dev/api/v1/refunds \
-H "Authorization: Bearer SUA_CHAVE" \
-H "Content-Type: application/json" \
-d '{
"payment_id": "b81f4c26-5d9e-4f7a-8c3b-2e6a9d4f1b58",
"amount": 5000,
"reason": "Item com defeito"
}'
curl -X POST https://pay.autorizou.dev/api/v1/refunds \
-H "Authorization: Bearer SUA_CHAVE" \
-H "Content-Type: application/json" \
-d '{
"payment_id": "e4a7c158-9b2d-4e6f-a831-6c9e2b5d8f47",
"bank_account": {
"holder_name": "João Silva",
"holder_type": "cpf",
"holder_document": "12345678901",
"bank": "341",
"branch_number": "1234",
"branch_check_digit": "5",
"account_number": "67890",
"account_check_digit": "1"
}
}'
Resposta (201 Created)
{
"id": "5f2e8b91-4c7d-4a3e-96b5-8d1f4e7a2c60",
"payment_id": "b81f4c26-5d9e-4f7a-8c3b-2e6a9d4f1b58",
"amount": 5000,
"status": "requested",
"type": "partial",
"created_at": "2024-01-15 14:20:00"
}
string
UUID do estorno criado.
string
UUID do pagamento estornado.
integer
Valor estornado em centavos.
string
Status do estorno. Nasce
requested e evolui de forma assíncrona.Valores: requested, scheduled, success, failed, canceledstring
Derivado pelo servidor a partir do valor:
full quando o valor cobre todo o remanescente,
partial caso contrário.Acompanhamento
O estorno é processado de forma assíncrona junto ao emissor. Acompanhe pelo webhook (payment.refunded quando concluído; o pagamento vai a refunded ou refunded_partially) ou por
polling em GET /payments/{id}.
Estornos parciais em sequência: o remanescente reembolsável considera o valor original da
venda menos tudo que já foi solicitado. Você pode estornar parcialmente várias vezes até zerar; o
estorno “total” após parciais devolve exatamente o que resta.
Códigos de Erro
422 - Status inválido
422 - Status inválido
{
"message": "O pagamento deve estar Autorizado ou Parcialmente Reembolsado para ser reembolsado",
"errors": { "payment_id": ["O pagamento deve estar Autorizado ou Parcialmente Reembolsado para ser reembolsado"] }
}
422 - Valor acima do remanescente
422 - Valor acima do remanescente
{
"message": "O valor não pode exceder o valor reembolsável restante.",
"errors": { "amount": ["O valor não pode exceder o valor reembolsável restante."] }
}
422 - Conta bancária ausente (boleto)
422 - Conta bancária ausente (boleto)
{
"message": "Conta bancária é obrigatória para boleto",
"errors": { "bank_account": ["Conta bancária é obrigatória para boleto"] }
}
404 - Pagamento não encontrado
404 - Pagamento não encontrado
O
payment_id não existe ou pertence a outro lojista (o escopo por conta responde 404, nunca
vaza a existência do recurso).⌘I