Skip to main content
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>"
}
'
{
  "batchId": "<string>",
  "status": "<string>",
  "releasedAmountCents": 123
}

Authorizations

x-client-id
string
header
required

Client ID fornecido pela TurbofyPay.

x-client-secret
string
header
required

Client Secret fornecido pela TurbofyPay.

Headers

x-client-id
string
required

Identificador do integrador.

x-client-secret
string
required

Segredo de autenticacao do integrador.

x-turbofy-timestamp
string
required

Timestamp utilizado na assinatura HMAC.

x-turbofy-signature
string
required

Assinatura HMAC SHA-256 da requisicao.

Path Parameters

batchId
string
required

Body

application/json
reason
string
Maximum string length: 255

Response

Lote cancelado com sucesso.

batchId
string
required
status
string
required
releasedAmountCents
integer
required
Last modified on April 13, 2026