Empresa
Desfaz um pagamento de fatura de cartão de crédito.
RN6: sem prazo limite, justificativa obrigatória e persistida. A fatura volta ao estado anterior, o caixa da conta pagadora é restituído e o DRE não muda em nenhum mês. Desfazer o mesmo pagamento duas vezes é rejeitado. Se o remanescente rolou para a fatura seguinte e essa já foi paga, o estorno é recusado (Q5) — estorne antes o pagamento da fatura seguinte.
DELETE
/
companies
/
credit-card-invoices
/
{id}
/
payments
/
{paymentId}
Desfaz um pagamento de fatura de cartão de crédito.
curl --request DELETE \
--url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/payments/{paymentId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-company-id: <x-company-id>' \
--data '
{
"reason": "<string>"
}
'import requests
url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/payments/{paymentId}"
payload = { "reason": "<string>" }
headers = {
"x-company-id": "<x-company-id>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {
'x-company-id': '<x-company-id>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/payments/{paymentId}', 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}/payments/{paymentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'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/credit-card-invoices/{id}/payments/{paymentId}"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("DELETE", 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.delete("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/payments/{paymentId}")
.header("x-company-id", "<x-company-id>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/payments/{paymentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-company-id"] = '<x-company-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\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>"
},
"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>"
},
"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>"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Token da sessão no cabeçalho Authorization, no formato Bearer (mesmo esquema ApiKeyAuth do contrato).
Headers
company uuid
Body
application/json
Reversal reason
⌘I
Desfaz um pagamento de fatura de cartão de crédito.
curl --request DELETE \
--url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/payments/{paymentId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-company-id: <x-company-id>' \
--data '
{
"reason": "<string>"
}
'import requests
url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/payments/{paymentId}"
payload = { "reason": "<string>" }
headers = {
"x-company-id": "<x-company-id>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {
'x-company-id': '<x-company-id>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/payments/{paymentId}', 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}/payments/{paymentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'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/credit-card-invoices/{id}/payments/{paymentId}"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("DELETE", 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.delete("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/payments/{paymentId}")
.header("x-company-id", "<x-company-id>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/credit-card-invoices/{id}/payments/{paymentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-company-id"] = '<x-company-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\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>"
},
"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>"
},
"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>"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}