Empresa

Paga uma fatura de cartão de crédito, total ou parcialmente.

O pagamento é por LISTA de lançamentos: envie em installment_ids os installment_id que GET /credit-card-invoices/ devolve em entries[], e o valor é derivado deles no servidor (não há campo amount). Lista ausente ou vazia paga a fatura inteira. Os lançamentos pagos ganham data de pagamento — a movimentação vinculada de cada parcela passa a “pago”. Os lançamentos NÃO selecionados são realocados para a fatura seguinte, com o vencimento da movimentação acertado para o dela; nunca viram despesa nova e nunca alteram o DRE. include_previous_balance=false deixa o saldo anterior rolar de novo para a fatura seguinte (RN5). Envie idempotency_key para tornar retries seguros: replay da mesma chave devolve o pagamento original com 200, sem debitar a conta de novo.

POST

companies

credit-card-invoices

{id}

pay

Paga uma fatura de cartão de crédito, total ou parcialmente.

curl --request POST \
  --url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/pay \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <x-company-id>' \
  --data '
{
  "bank_account_id": "<string>",
  "payment_date": "<string>",
  "idempotency_key": "<string>",
  "include_previous_balance": true,
  "installment_ids": [
    "<string>"
  ]
}
'

import requests

url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/pay"

payload = {
    "bank_account_id": "<string>",
    "payment_date": "<string>",
    "idempotency_key": "<string>",
    "include_previous_balance": True,
    "installment_ids": ["<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({
    bank_account_id: '<string>',
    payment_date: '<string>',
    idempotency_key: '<string>',
    include_previous_balance: true,
    installment_ids: ['<string>']
  })
};

fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/pay', 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/credit-card-invoices/{id}/pay",
  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([
    'bank_account_id' => '<string>',
    'payment_date' => '<string>',
    'idempotency_key' => '<string>',
    'include_previous_balance' => true,
    'installment_ids' => [
        '<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/credit-card-invoices/{id}/pay"

	payload := strings.NewReader("{\n  \"bank_account_id\": \"<string>\",\n  \"payment_date\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"include_previous_balance\": true,\n  \"installment_ids\": [\n    \"<string>\"\n  ]\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/credit-card-invoices/{id}/pay")
  .header("x-company-id", "<x-company-id>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bank_account_id\": \"<string>\",\n  \"payment_date\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"include_previous_balance\": true,\n  \"installment_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/pay")

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  \"bank_account_id\": \"<string>\",\n  \"payment_date\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"include_previous_balance\": true,\n  \"installment_ids\": [\n    \"<string>\"\n  ]\n}"

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

{
  "bank_account_balance": 123,
  "invoice": {
    "credit_card_account_id": "<string>",
    "due_date": "<string>",
    "id": "<string>",
    "paid_at": "<string>",
    "period_end": "<string>",
    "period_start": "<string>",
    "previous_balance": 123,
    "reference_month": "<string>"
  },
  "moved_amount": 123,
  "moved_installment_ids": [
    "<string>"
  ],
  "next_invoice": {
    "credit_card_account_id": "<string>",
    "due_date": "<string>",
    "id": "<string>",
    "paid_at": "<string>",
    "period_end": "<string>",
    "period_start": "<string>",
    "previous_balance": 123,
    "reference_month": "<string>"
  },
  "partial": true,
  "payment": {
    "amount": "<string>",
    "amount_value": 123,
    "bank_account_id": "<string>",
    "created_at": "<string>",
    "credit_card_invoice_id": "<string>",
    "id": "<string>",
    "idempotency_key": "<string>",
    "payment_date": "<string>",
    "reversal_reason": "<string>",
    "reversed_at": "<string>",
    "rolled_amount": 123,
    "rolled_to_invoice_id": "<string>"
  },
  "replayed": true,
  "rolled_amount": 123,
  "settled_amount": 123,
  "settled_installment_ids": [
    "<string>"
  ]
}

{
  "bank_account_balance": 123,
  "invoice": {
    "credit_card_account_id": "<string>",
    "due_date": "<string>",
    "id": "<string>",
    "paid_at": "<string>",
    "period_end": "<string>",
    "period_start": "<string>",
    "previous_balance": 123,
    "reference_month": "<string>"
  },
  "moved_amount": 123,
  "moved_installment_ids": [
    "<string>"
  ],
  "next_invoice": {
    "credit_card_account_id": "<string>",
    "due_date": "<string>",
    "id": "<string>",
    "paid_at": "<string>",
    "period_end": "<string>",
    "period_start": "<string>",
    "previous_balance": 123,
    "reference_month": "<string>"
  },
  "partial": true,
  "payment": {
    "amount": "<string>",
    "amount_value": 123,
    "bank_account_id": "<string>",
    "created_at": "<string>",
    "credit_card_invoice_id": "<string>",
    "id": "<string>",
    "idempotency_key": "<string>",
    "payment_date": "<string>",
    "reversal_reason": "<string>",
    "reversed_at": "<string>",
    "rolled_amount": 123,
    "rolled_to_invoice_id": "<string>"
  },
  "replayed": true,
  "rolled_amount": 123,
  "settled_amount": 123,
  "settled_installment_ids": [
    "<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

Path Parameters

string

required

Invoice ID

Body

application/json

Payment data

bank_account_id

string

required

payment_date

string

required

idempotency_key

string

IdempotencyKey é opcional — sem ela, duplo clique registra dois pagamentos parciais legítimos e indistinguíveis (plan.md).

include_previous_balance

boolean

IncludePreviousBalance decide se o saldo anterior (o remanescente que rolou de uma fatura passada) entra neste pagamento. Ausente ⇒ true.

Ponteiro para distinguir "não enviado" de "false" — a diferença entre pagar a fatura inteira e deixar o saldo anterior rolar de novo.

installment_ids

string[]

InstallmentIDs é a lista de lançamentos da fatura que este pagamento liquida — os installment_id que GET /credit-card-invoices/{id} devolve em entries[] (plan-parcelamento.md §3.2, item 13 da lista de testes).

AUSENTE ou VAZIA ⇒ a fatura inteira. É o caso comum e o comportamento de antes desta mudança.

── Por que a lista substituiu amount ─────────────────────────────────

O valor agora é DERIVADO da seleção, no servidor: soma das parcelas escolhidas mais, se incluído, o saldo anterior. Com isso somem de vez o "valor não bate com a fatura" e a pergunta que o modelo antigo não sabia responder — QUAIS lançamentos esse dinheiro pagou. É o que permite baixar as movimentações vinculadas (item 11).

Seleção por LANÇAMENTO e não por movimentação: parcela de dívida legada não tem transaction_id e ainda assim precisa ser pagável.

Response

replay idempotente — nenhum dinheiro se moveu nesta chamada

bank_account_balance

number

invoice

object

Show child attributes

moved_amount

number

moved_installment_ids

string[]

MovedInstallmentIDs são os lançamentos NÃO selecionados, realocados para NextInvoice com o vencimento da movimentação acertado para o dela. Vazio quando a fatura foi paga inteira.

next_invoice

object

NextInvoice é a fatura que recebeu a rolagem — nil quando o pagamento quitou a fatura sem sobra.

Show child attributes

partial

boolean

payment

object

Show child attributes

replayed

boolean

rolled_amount

number

settled_amount

number

settled_installment_ids

string[]

SettledInstallmentIDs são os lançamentos que ESTE pagamento liquidou — os mesmos ids que o cliente enviou em installment_ids, ou todos os da fatura quando a lista veio vazia. A movimentação vinculada a cada um passou a "pago".

Paga uma fatura de cartão de crédito, total ou parcialmente.

curl --request POST \
  --url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/pay \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <x-company-id>' \
  --data '
{
  "bank_account_id": "<string>",
  "payment_date": "<string>",
  "idempotency_key": "<string>",
  "include_previous_balance": true,
  "installment_ids": [
    "<string>"
  ]
}
'

import requests

url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/pay"

payload = {
    "bank_account_id": "<string>",
    "payment_date": "<string>",
    "idempotency_key": "<string>",
    "include_previous_balance": True,
    "installment_ids": ["<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({
    bank_account_id: '<string>',
    payment_date: '<string>',
    idempotency_key: '<string>',
    include_previous_balance: true,
    installment_ids: ['<string>']
  })
};

fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/pay', 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/credit-card-invoices/{id}/pay",
  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([
    'bank_account_id' => '<string>',
    'payment_date' => '<string>',
    'idempotency_key' => '<string>',
    'include_previous_balance' => true,
    'installment_ids' => [
        '<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/credit-card-invoices/{id}/pay"

	payload := strings.NewReader("{\n  \"bank_account_id\": \"<string>\",\n  \"payment_date\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"include_previous_balance\": true,\n  \"installment_ids\": [\n    \"<string>\"\n  ]\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/credit-card-invoices/{id}/pay")
  .header("x-company-id", "<x-company-id>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bank_account_id\": \"<string>\",\n  \"payment_date\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"include_previous_balance\": true,\n  \"installment_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/pay")

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  \"bank_account_id\": \"<string>\",\n  \"payment_date\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"include_previous_balance\": true,\n  \"installment_ids\": [\n    \"<string>\"\n  ]\n}"

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

{
  "bank_account_balance": 123,
  "invoice": {
    "credit_card_account_id": "<string>",
    "due_date": "<string>",
    "id": "<string>",
    "paid_at": "<string>",
    "period_end": "<string>",
    "period_start": "<string>",
    "previous_balance": 123,
    "reference_month": "<string>"
  },
  "moved_amount": 123,
  "moved_installment_ids": [
    "<string>"
  ],
  "next_invoice": {
    "credit_card_account_id": "<string>",
    "due_date": "<string>",
    "id": "<string>",
    "paid_at": "<string>",
    "period_end": "<string>",
    "period_start": "<string>",
    "previous_balance": 123,
    "reference_month": "<string>"
  },
  "partial": true,
  "payment": {
    "amount": "<string>",
    "amount_value": 123,
    "bank_account_id": "<string>",
    "created_at": "<string>",
    "credit_card_invoice_id": "<string>",
    "id": "<string>",
    "idempotency_key": "<string>",
    "payment_date": "<string>",
    "reversal_reason": "<string>",
    "reversed_at": "<string>",
    "rolled_amount": 123,
    "rolled_to_invoice_id": "<string>"
  },
  "replayed": true,
  "rolled_amount": 123,
  "settled_amount": 123,
  "settled_installment_ids": [
    "<string>"
  ]
}

{
  "bank_account_balance": 123,
  "invoice": {
    "credit_card_account_id": "<string>",
    "due_date": "<string>",
    "id": "<string>",
    "paid_at": "<string>",
    "period_end": "<string>",
    "period_start": "<string>",
    "previous_balance": 123,
    "reference_month": "<string>"
  },
  "moved_amount": 123,
  "moved_installment_ids": [
    "<string>"
  ],
  "next_invoice": {
    "credit_card_account_id": "<string>",
    "due_date": "<string>",
    "id": "<string>",
    "paid_at": "<string>",
    "period_end": "<string>",
    "period_start": "<string>",
    "previous_balance": 123,
    "reference_month": "<string>"
  },
  "partial": true,
  "payment": {
    "amount": "<string>",
    "amount_value": 123,
    "bank_account_id": "<string>",
    "created_at": "<string>",
    "credit_card_invoice_id": "<string>",
    "id": "<string>",
    "idempotency_key": "<string>",
    "payment_date": "<string>",
    "reversal_reason": "<string>",
    "reversed_at": "<string>",
    "rolled_amount": 123,
    "rolled_to_invoice_id": "<string>"
  },
  "replayed": true,
  "rolled_amount": 123,
  "settled_amount": 123,
  "settled_installment_ids": [
    "<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

Paga uma fatura de cartão de crédito, total ou parcialmente.

Authorizations

Headers

Path Parameters

Body

Response