Cancelar lote de payouts
curl --request POST \
--url http://localhost:3030/v1/payouts/batches/{batchId}/cancel \
--header 'Content-Type: application/json' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>' \
--header 'x-turbofy-signature: <x-turbofy-signature>' \
--header 'x-turbofy-timestamp: <x-turbofy-timestamp>' \
--data '
{
"reason": "<string>"
}
'import requests
url = "http://localhost:3030/v1/payouts/batches/{batchId}/cancel"
payload = { "reason": "<string>" }
headers = {
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>",
"x-turbofy-timestamp": "<x-turbofy-timestamp>",
"x-turbofy-signature": "<x-turbofy-signature>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>',
'x-turbofy-timestamp': '<x-turbofy-timestamp>',
'x-turbofy-signature': '<x-turbofy-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({reason: '<string>'})
};
fetch('http://localhost:3030/v1/payouts/batches/{batchId}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3030",
CURLOPT_URL => "http://localhost:3030/v1/payouts/batches/{batchId}/cancel",
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([
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-id: <api-key>",
"x-client-secret: <api-key>",
"x-turbofy-signature: <x-turbofy-signature>",
"x-turbofy-timestamp: <x-turbofy-timestamp>"
],
]);
$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 := "http://localhost:3030/v1/payouts/batches/{batchId}/cancel"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("x-turbofy-timestamp", "<x-turbofy-timestamp>")
req.Header.Add("x-turbofy-signature", "<x-turbofy-signature>")
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("http://localhost:3030/v1/payouts/batches/{batchId}/cancel")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("x-turbofy-timestamp", "<x-turbofy-timestamp>")
.header("x-turbofy-signature", "<x-turbofy-signature>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3030/v1/payouts/batches/{batchId}/cancel")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["x-turbofy-timestamp"] = '<x-turbofy-timestamp>'
request["x-turbofy-signature"] = '<x-turbofy-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"batchId": "<string>",
"status": "<string>",
"releasedAmountCents": 123
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"traceId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"traceId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"traceId": "<string>"
}
}Payouts
Cancelar lote de payouts
Cancela um lote de payouts ainda cancelavel.
POST
/
v1
/
payouts
/
batches
/
{batchId}
/
cancel
Cancelar lote de payouts
curl --request POST \
--url http://localhost:3030/v1/payouts/batches/{batchId}/cancel \
--header 'Content-Type: application/json' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>' \
--header 'x-turbofy-signature: <x-turbofy-signature>' \
--header 'x-turbofy-timestamp: <x-turbofy-timestamp>' \
--data '
{
"reason": "<string>"
}
'import requests
url = "http://localhost:3030/v1/payouts/batches/{batchId}/cancel"
payload = { "reason": "<string>" }
headers = {
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>",
"x-turbofy-timestamp": "<x-turbofy-timestamp>",
"x-turbofy-signature": "<x-turbofy-signature>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>',
'x-turbofy-timestamp': '<x-turbofy-timestamp>',
'x-turbofy-signature': '<x-turbofy-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({reason: '<string>'})
};
fetch('http://localhost:3030/v1/payouts/batches/{batchId}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3030",
CURLOPT_URL => "http://localhost:3030/v1/payouts/batches/{batchId}/cancel",
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([
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-id: <api-key>",
"x-client-secret: <api-key>",
"x-turbofy-signature: <x-turbofy-signature>",
"x-turbofy-timestamp: <x-turbofy-timestamp>"
],
]);
$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 := "http://localhost:3030/v1/payouts/batches/{batchId}/cancel"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("x-turbofy-timestamp", "<x-turbofy-timestamp>")
req.Header.Add("x-turbofy-signature", "<x-turbofy-signature>")
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("http://localhost:3030/v1/payouts/batches/{batchId}/cancel")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("x-turbofy-timestamp", "<x-turbofy-timestamp>")
.header("x-turbofy-signature", "<x-turbofy-signature>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3030/v1/payouts/batches/{batchId}/cancel")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["x-turbofy-timestamp"] = '<x-turbofy-timestamp>'
request["x-turbofy-signature"] = '<x-turbofy-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"batchId": "<string>",
"status": "<string>",
"releasedAmountCents": 123
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"traceId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"traceId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"traceId": "<string>"
}
}Authorizations
Client ID fornecido pela TurbofyPay.
Client Secret fornecido pela TurbofyPay.
Headers
Identificador do integrador.
Segredo de autenticacao do integrador.
Timestamp utilizado na assinatura HMAC.
Assinatura HMAC SHA-256 da requisicao.
Path Parameters
Body
application/json
Maximum string length:
255Last modified on June 8, 2026
⌘I