curl --request POST \
--url https://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash} \
--header 'Content-Type: application/json' \
--header 'X-Api-Client-Token: <api-key>' \
--data '
{
"observation": "<string>",
"reason": "<string>",
"fraud_confirmed": true,
"refund_type": "<string>",
"cancel_subscription": true,
"user_id": "XXWBD7UOKM1756304064"
}
'import requests
url = "https://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash}"
payload = {
"observation": "<string>",
"reason": "<string>",
"fraud_confirmed": True,
"refund_type": "<string>",
"cancel_subscription": True,
"user_id": "XXWBD7UOKM1756304064"
}
headers = {
"X-Api-Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
observation: '<string>',
reason: '<string>',
fraud_confirmed: true,
refund_type: '<string>',
cancel_subscription: true,
user_id: 'XXWBD7UOKM1756304064'
})
};
fetch('https://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash}', 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://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash}",
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([
'observation' => '<string>',
'reason' => '<string>',
'fraud_confirmed' => true,
'refund_type' => '<string>',
'cancel_subscription' => true,
'user_id' => 'XXWBD7UOKM1756304064'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Client-Token: <api-key>"
],
]);
$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://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash}"
payload := strings.NewReader("{\n \"observation\": \"<string>\",\n \"reason\": \"<string>\",\n \"fraud_confirmed\": true,\n \"refund_type\": \"<string>\",\n \"cancel_subscription\": true,\n \"user_id\": \"XXWBD7UOKM1756304064\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Client-Token", "<api-key>")
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://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash}")
.header("X-Api-Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"observation\": \"<string>\",\n \"reason\": \"<string>\",\n \"fraud_confirmed\": true,\n \"refund_type\": \"<string>\",\n \"cancel_subscription\": true,\n \"user_id\": \"XXWBD7UOKM1756304064\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"observation\": \"<string>\",\n \"reason\": \"<string>\",\n \"fraud_confirmed\": true,\n \"refund_type\": \"<string>\",\n \"cancel_subscription\": true,\n \"user_id\": \"XXWBD7UOKM1756304064\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Reembolso processado com sucesso",
"data": {
"hash": "<string>",
"transaction_hash": "<string>",
"status": "<string>",
"amount": 123,
"observation": "<string>",
"created_at": "31/12/2024 12:00:00",
"updated_at": "31/12/2024 12:00:00"
}
}{
"status": "processing",
"message": "Refund is being processed.",
"data": {
"transaction_hash": "TPC1E5FE0308FDE66WXX"
}
}Solicitar reembolso (assíncrono)
Solicita um reembolso para uma transação específica. A operação é
processada de forma assíncrona — o endpoint retorna 202 Accepted
imediatamente com o header Location apontando para o endpoint de
consulta de status.
Caso já exista um reembolso ativo (status requested ou success)
para a transação, o endpoint retorna 200 OK com os dados do
reembolso existente, sem criar uma nova solicitação.
Campos opcionais:
observation- Observação sobre o reembolsoreason- Motivo do reembolso (caso não informado, o Nexus utiliza o padrão)fraud_confirmed- Indica se o reembolso é motivado por fraude confirmadarefund_type- Tipo de reembolso quando aplicável
Fluxo recomendado:
POST /financial/refund/{hash}→ recebe202comLocationGET /financial/refund/{hash}/status→ consulta atécompletedoufailed
curl --request POST \
--url https://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash} \
--header 'Content-Type: application/json' \
--header 'X-Api-Client-Token: <api-key>' \
--data '
{
"observation": "<string>",
"reason": "<string>",
"fraud_confirmed": true,
"refund_type": "<string>",
"cancel_subscription": true,
"user_id": "XXWBD7UOKM1756304064"
}
'import requests
url = "https://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash}"
payload = {
"observation": "<string>",
"reason": "<string>",
"fraud_confirmed": True,
"refund_type": "<string>",
"cancel_subscription": True,
"user_id": "XXWBD7UOKM1756304064"
}
headers = {
"X-Api-Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
observation: '<string>',
reason: '<string>',
fraud_confirmed: true,
refund_type: '<string>',
cancel_subscription: true,
user_id: 'XXWBD7UOKM1756304064'
})
};
fetch('https://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash}', 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://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash}",
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([
'observation' => '<string>',
'reason' => '<string>',
'fraud_confirmed' => true,
'refund_type' => '<string>',
'cancel_subscription' => true,
'user_id' => 'XXWBD7UOKM1756304064'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Client-Token: <api-key>"
],
]);
$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://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash}"
payload := strings.NewReader("{\n \"observation\": \"<string>\",\n \"reason\": \"<string>\",\n \"fraud_confirmed\": true,\n \"refund_type\": \"<string>\",\n \"cancel_subscription\": true,\n \"user_id\": \"XXWBD7UOKM1756304064\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Client-Token", "<api-key>")
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://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash}")
.header("X-Api-Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"observation\": \"<string>\",\n \"reason\": \"<string>\",\n \"fraud_confirmed\": true,\n \"refund_type\": \"<string>\",\n \"cancel_subscription\": true,\n \"user_id\": \"XXWBD7UOKM1756304064\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://nexus.ticto.com.br/api/v1/financial/refund/{transaction_hash}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"observation\": \"<string>\",\n \"reason\": \"<string>\",\n \"fraud_confirmed\": true,\n \"refund_type\": \"<string>\",\n \"cancel_subscription\": true,\n \"user_id\": \"XXWBD7UOKM1756304064\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Reembolso processado com sucesso",
"data": {
"hash": "<string>",
"transaction_hash": "<string>",
"status": "<string>",
"amount": 123,
"observation": "<string>",
"created_at": "31/12/2024 12:00:00",
"updated_at": "31/12/2024 12:00:00"
}
}{
"status": "processing",
"message": "Refund is being processed.",
"data": {
"transaction_hash": "TPC1E5FE0308FDE66WXX"
}
}Authorizations
Token de autenticação do cliente obtido via endpoint /auth
Path Parameters
Hash da transação
Body
Observação que ficará registrada no reembolso
Motivo do reembolso enviado ao serviço de pagamentos
1000Indica se a solicitação é referente a fraude confirmada
Tipo do reembolso quando aplicável
Se deve cancelar a assinatura vinculada à transação junto com o reembolso. Quando não informado e a transação possui assinatura, o valor padrão é true.
Código (hash) do usuário associado ao reembolso. Deve ser um código válido de um usuário ativo (não excluído).
"XXWBD7UOKM1756304064"