Empresa

Create a transfer between two bank accounts of the same company.

Creates a new account transfer, debiting the origin account and crediting the destination account atomically. Send idempotency_key on every request to make retries safe: replaying the same key (even after the transfer was reversed) returns the existing transfer with 200 instead of moving money again. Returns 201 for a newly created transfer and 200 for an idempotent replay — in both cases the body includes the two resulting account balances.

POST

companies

transfers

curl --request POST \
  --url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transfers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <x-company-id>' \
  --data '
{
  "destination_bank_account_id": "<string>",
  "origin_bank_account_id": "<string>",
  "transfer_date": "<string>",
  "amount": 123,
  "idempotency_key": "<string>",
  "more_infos": "<string>",
  "reference": "<string>"
}
'

import requests

url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transfers"

payload = {
    "destination_bank_account_id": "<string>",
    "origin_bank_account_id": "<string>",
    "transfer_date": "<string>",
    "amount": 123,
    "idempotency_key": "<string>",
    "more_infos": "<string>",
    "reference": "<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({
    destination_bank_account_id: '<string>',
    origin_bank_account_id: '<string>',
    transfer_date: '<string>',
    amount: 123,
    idempotency_key: '<string>',
    more_infos: '<string>',
    reference: '<string>'
  })
};

fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transfers', 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/transfers",
  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([
    'destination_bank_account_id' => '<string>',
    'origin_bank_account_id' => '<string>',
    'transfer_date' => '<string>',
    'amount' => 123,
    'idempotency_key' => '<string>',
    'more_infos' => '<string>',
    'reference' => '<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/transfers"

	payload := strings.NewReader("{\n  \"destination_bank_account_id\": \"<string>\",\n  \"origin_bank_account_id\": \"<string>\",\n  \"transfer_date\": \"<string>\",\n  \"amount\": 123,\n  \"idempotency_key\": \"<string>\",\n  \"more_infos\": \"<string>\",\n  \"reference\": \"<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/transfers")
  .header("x-company-id", "<x-company-id>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"destination_bank_account_id\": \"<string>\",\n  \"origin_bank_account_id\": \"<string>\",\n  \"transfer_date\": \"<string>\",\n  \"amount\": 123,\n  \"idempotency_key\": \"<string>\",\n  \"more_infos\": \"<string>\",\n  \"reference\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"destination_bank_account_id\": \"<string>\",\n  \"origin_bank_account_id\": \"<string>\",\n  \"transfer_date\": \"<string>\",\n  \"amount\": 123,\n  \"idempotency_key\": \"<string>\",\n  \"more_infos\": \"<string>\",\n  \"reference\": \"<string>\"\n}"

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

{
  "amount": "<string>",
  "amount_value": 123,
  "created_at": "<string>",
  "created_by": {},
  "destination_account": {},
  "destination_balance": 123,
  "id": "<string>",
  "more_infos": "<string>",
  "origin_account": {},
  "origin_balance": 123,
  "reference": "<string>",
  "reversed_at": "<string>",
  "transfer_date": "<string>",
  "type": "<string>",
  "updated_at": "<string>"
}

{
  "amount": "<string>",
  "amount_value": 123,
  "created_at": "<string>",
  "created_by": {},
  "destination_account": {},
  "destination_balance": 123,
  "id": "<string>",
  "more_infos": "<string>",
  "origin_account": {},
  "origin_balance": 123,
  "reference": "<string>",
  "reversed_at": "<string>",
  "transfer_date": "<string>",
  "type": "<string>",
  "updated_at": "<string>"
}

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

{
  "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 uuid

Body

application/json

Transfer data

destination_bank_account_id

string

required

origin_bank_account_id

string

required

transfer_date

string

required

amount

number

Amount NÃO carrega validate:"required": para go-playground/validator, "required" num float64 rejeita o ZERO VALUE — e amount=0 é exatamente o caso de negócio que precisa produzir "valor da transferência deve ser maior que zero" (400, mensagem literal da tabela do plan.md), não o genérico "erro ao validar a requisição". Deixar o campo passar por esta validação de forma e cair na validação de NEGÓCIO do use case (T7, toRegisterParams) é o que garante a mensagem certa em amount<=0.

idempotency_key

string

IdempotencyKey é opcional no schema (plan.md), mas o front DEVE sempre enviá-la — ver spec.md § "Regras de negócio". Aceita nil (campo ausente).

more_infos

string

reference

string

Response

idempotent replay (same idempotency_key); reversed_at may be filled if the original transfer was already reversed

amount

string

amount_value

number

created_at

string

created_by

object

destination_account

object

destination_balance

number

string

more_infos

string

origin_account

object

origin_balance

number

OriginBalance/DestinationBalance só vêm preenchidos na resposta de criação (201/200 do POST) e de estorno (DELETE) — plan.md: "a resposta inclui os saldos resultantes das duas contas, para o front atualizar a tela sem refetch". GetByID/GetAll/PATCH não carregam efeito de saldo nenhum, então ficam de fora (omitempty) para não sugerir um refetch de saldo que a operação não fez.

reference

string

reversed_at

string

ReversedAt só aparece (ponteiro não-nil) quando a transferência foi estornada (D5b) — inclusive no replay idempotente pós-estorno (T4b): o handler responde 200 e o cliente vê, pelo campo preenchido, que aquela chave já havia sido usada e a transferência desfeita.

transfer_date

string

type

string

updated_at

string

Create a transfer between two bank accounts of the same company.

curl --request POST \
  --url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transfers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <x-company-id>' \
  --data '
{
  "destination_bank_account_id": "<string>",
  "origin_bank_account_id": "<string>",
  "transfer_date": "<string>",
  "amount": 123,
  "idempotency_key": "<string>",
  "more_infos": "<string>",
  "reference": "<string>"
}
'

import requests

url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transfers"

payload = {
    "destination_bank_account_id": "<string>",
    "origin_bank_account_id": "<string>",
    "transfer_date": "<string>",
    "amount": 123,
    "idempotency_key": "<string>",
    "more_infos": "<string>",
    "reference": "<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({
    destination_bank_account_id: '<string>',
    origin_bank_account_id: '<string>',
    transfer_date: '<string>',
    amount: 123,
    idempotency_key: '<string>',
    more_infos: '<string>',
    reference: '<string>'
  })
};

fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transfers', 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/transfers",
  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([
    'destination_bank_account_id' => '<string>',
    'origin_bank_account_id' => '<string>',
    'transfer_date' => '<string>',
    'amount' => 123,
    'idempotency_key' => '<string>',
    'more_infos' => '<string>',
    'reference' => '<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/transfers"

	payload := strings.NewReader("{\n  \"destination_bank_account_id\": \"<string>\",\n  \"origin_bank_account_id\": \"<string>\",\n  \"transfer_date\": \"<string>\",\n  \"amount\": 123,\n  \"idempotency_key\": \"<string>\",\n  \"more_infos\": \"<string>\",\n  \"reference\": \"<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/transfers")
  .header("x-company-id", "<x-company-id>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"destination_bank_account_id\": \"<string>\",\n  \"origin_bank_account_id\": \"<string>\",\n  \"transfer_date\": \"<string>\",\n  \"amount\": 123,\n  \"idempotency_key\": \"<string>\",\n  \"more_infos\": \"<string>\",\n  \"reference\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"destination_bank_account_id\": \"<string>\",\n  \"origin_bank_account_id\": \"<string>\",\n  \"transfer_date\": \"<string>\",\n  \"amount\": 123,\n  \"idempotency_key\": \"<string>\",\n  \"more_infos\": \"<string>\",\n  \"reference\": \"<string>\"\n}"

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

{
  "amount": "<string>",
  "amount_value": 123,
  "created_at": "<string>",
  "created_by": {},
  "destination_account": {},
  "destination_balance": 123,
  "id": "<string>",
  "more_infos": "<string>",
  "origin_account": {},
  "origin_balance": 123,
  "reference": "<string>",
  "reversed_at": "<string>",
  "transfer_date": "<string>",
  "type": "<string>",
  "updated_at": "<string>"
}

{
  "amount": "<string>",
  "amount_value": 123,
  "created_at": "<string>",
  "created_by": {},
  "destination_account": {},
  "destination_balance": 123,
  "id": "<string>",
  "more_infos": "<string>",
  "origin_account": {},
  "origin_balance": 123,
  "reference": "<string>",
  "reversed_at": "<string>",
  "transfer_date": "<string>",
  "type": "<string>",
  "updated_at": "<string>"
}

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

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

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

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

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

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

Começar

Operações

Create a transfer between two bank accounts of the same company.

Authorizations

Headers

Body

Response