Empresa

Delete multiple transactions independently.

Exclusão em lote é parcial: cada item é processado independentemente. A resposta é sempre 200 quando o envelope é válido; o resultado é reportado por item em results. Cada item é soft-deletado (deleted_at). Item pago exige reason; sem ele o item falha com reason_required e permanece íntegro. Compra de cartão de crédito com parcela paga exige confirm = true; sem ele o item falha com 409 (como na rota unitária) e permanece íntegro. Pagamentos ativos em lançamentos deletados são estornados na conta do próprio pagamento, com data de hoje e audit log. Item de outra empresa falha com 404 naquele item sem expor dados. Item não tentado por prazo do lote esgotado ou cancelamento falha com not_processed (503). Envelope inválido devolve 422 ErrorResponseDTO sem processar nada: invalid_envelope (ids vazio ou acima de 100), invalid_id (UUID inválido) ou duplicate_ids (ids repetidos). Limite: 1..100 ids.

POST

companies

transactions

batch-delete

Delete multiple transactions independently.

curl --request POST \
  --url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <x-company-id>' \
  --data '
{
  "ids": [
    "<string>"
  ],
  "confirm": true,
  "reason": "<string>"
}
'

import requests

url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete"

payload = {
    "ids": ["<string>"],
    "confirm": True,
    "reason": "<string>"
}
headers = {
    "x-company-id": "<x-company-id>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-company-id': '<x-company-id>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ids: ['<string>'], confirm: true, reason: '<string>'})
};

fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete', 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://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete",
  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([
    'ids' => [
        '<string>'
    ],
    'confirm' => true,
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "x-company-id: <x-company-id>"
  ],
]);

$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://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete"

	payload := strings.NewReader("{\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"confirm\": true,\n  \"reason\": \"<string>\"\n}")

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

	req.Header.Add("x-company-id", "<x-company-id>")
	req.Header.Add("Authorization", "<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://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete")
  .header("x-company-id", "<x-company-id>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"confirm\": true,\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete")

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

request = Net::HTTP::Post.new(url)
request["x-company-id"] = '<x-company-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"confirm\": true,\n  \"reason\": \"<string>\"\n}"

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

{
  "replayed": true,
  "results": [
    {
      "code": "<string>",
      "http_status": 123,
      "id": "<string>",
      "index": 123,
      "message": "<string>",
      "status": "<string>"
    }
  ],
  "series_id": "<string>",
  "summary": {
    "failed": 123,
    "succeeded": 123,
    "total": 123
  }
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Token da sessão no cabeçalho Authorization, no formato Bearer (mesmo esquema ApiKeyAuth do contrato).

Headers

x-company-id

string

required

Company ID (UUID)

Body

application/json

Batch delete request

ids

string[]

required

Lista de IDs a excluir (UUIDs). Limite: 1..100, sem duplicatas. Ids de outra empresa falham com 404 naquele item. swagger:example ["550e8400-e29b-41d4-a716-446655440000", "550e8400-e29b-41d4-a716-446655440001"]

Required array length: 1 - 100 elements

confirm

boolean

Confirmação de cancelamento de compra de cartão (opcional). Obrigatório quando a exclusão afeta uma compra no cartão com parcela paga.

reason

string

Motivo da exclusão (opcional). Obrigatório quando a exclusão afeta uma transação paga.

Response

Processamento completado. Cada item em results traz seu status. summary mostra total, sucessos e falhas.

replayed

boolean

Indica se a resposta é um replay de uma request anterior (idempotência). True: mesma chave de idempotência foi processada antes, nenhum efeito novo. False: request foi processada normalmente. Omitido em PATCH e DELETE.

results

object[]

Resultados por item, na ordem da request original.

Show child attributes

series_id

string

Identificador da série criada (somente em POST /batch com status 201). Omitido em caso de erro no nível da request.

summary

object

Resumo agregado dos resultados.

Show child attributes

Delete multiple transactions independently.

curl --request POST \
  --url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <x-company-id>' \
  --data '
{
  "ids": [
    "<string>"
  ],
  "confirm": true,
  "reason": "<string>"
}
'

import requests

url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete"

payload = {
    "ids": ["<string>"],
    "confirm": True,
    "reason": "<string>"
}
headers = {
    "x-company-id": "<x-company-id>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-company-id': '<x-company-id>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ids: ['<string>'], confirm: true, reason: '<string>'})
};

fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete', 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://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete",
  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([
    'ids' => [
        '<string>'
    ],
    'confirm' => true,
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "x-company-id: <x-company-id>"
  ],
]);

$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://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete"

	payload := strings.NewReader("{\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"confirm\": true,\n  \"reason\": \"<string>\"\n}")

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

	req.Header.Add("x-company-id", "<x-company-id>")
	req.Header.Add("Authorization", "<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://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete")
  .header("x-company-id", "<x-company-id>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"confirm\": true,\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions/batch-delete")

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

request = Net::HTTP::Post.new(url)
request["x-company-id"] = '<x-company-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"confirm\": true,\n  \"reason\": \"<string>\"\n}"

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

{
  "replayed": true,
  "results": [
    {
      "code": "<string>",
      "http_status": 123,
      "id": "<string>",
      "index": 123,
      "message": "<string>",
      "status": "<string>"
    }
  ],
  "series_id": "<string>",
  "summary": {
    "failed": 123,
    "succeeded": 123,
    "total": 123
  }
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Começar

Operações

Delete multiple transactions independently.

Authorizations

Headers

Body

Response