Financeiro · Referência

Pagamentos

Cobranças dos contratos (aluguel, taxas, entradas) com situação, vencimento e baixa. A escrita segue exatamente as regras do painel (baixa, recebimento manual, cancelamento).

Permissão: pagamentosAções: ler · criar · atualizar · excluir · exportar

GET/v1/pagamentosListar GET/v1/pagamentos/{id}Detalhar GET/v1/pagamentos/{id}/locacaoRelação: Locações GET/v1/pagamentos/{id}/comprovantesRelação: Comprovantes de pagamento GET/v1/pagamentos/exportarExportar em lote POST/v1/pagamentosGerar cobrança pendente para um contrato ativo POST/v1/pagamentos/{id}/baixaDar baixa POST/v1/pagamentos/{id}/recebimentoRecebimento manual POST/v1/pagamentos/{id}/estornarDesfazer baixa POST/v1/pagamentos/{id}/cancelarCancelar cobrança pendente

O objeto pagamentos

Campo	Tipo	Descrição
`id`	inteiro	Identificador	ordenar
`rental_id`	inteiro	ID da locação	filtro
`amount`	decimal (string)	Valor da cobrança (após baixa: valor efetivamente recebido)	ordenar
`original_amount`	decimal (string)	Valor original antes de ajuste
`status`	texto	pendente \| pago \| cancelado	filtro
`method`	texto (enum)	Forma de pagamento `pix` `cartao` `dinheiro` `transferencia`	filtro
`due_date`	data	Vencimento	filtroordenar
`paid_at`	data-hora	Data-hora do pagamento	ordenar
`note`	texto	Descrição da cobrança
`created_at`	data-hora	Criado em	ordenar
`charge2_at`	data-hora	2ª mensagem de cobrança enviada em
`charge3_at`	data-hora	3ª mensagem enviada em
`bank_transaction_id`	texto	bank transaction id
`scheduled_charge`	booleano	scheduled charge
`scheduled_charged_at`	data-hora	scheduled charged at
`revenue_center`	texto (enum)	Carteira de receita (null = segue a carteira da locação) `mapogos` `premium`	filtro

Exemplo do objeto200 OK

{
    "id": 1024,
    "rental_id": 512,
    "amount": "150.00",
    "original_amount": "150.00",
    "status": "pendente",
    "method": "pix",
    "due_date": "2026-10-15",
    "paid_at": "2026-10-08T14:30:00-03:00",
    "note": "Aluguel semanal",
    "created_at": "2026-10-08T14:30:00-03:00",
    "charge2_at": "2026-10-08T14:30:00-03:00",
    "charge3_at": "2026-10-08T14:30:00-03:00",
    "bank_transaction_id": "texto",
    "scheduled_charge": false,
    "scheduled_charged_at": "2026-10-08T14:30:00-03:00",
    "revenue_center": "mapogos"
}

GET Listar

Retorna os registros paginados, do mais recente para o mais antigo (padrão). Requer Ler.

Parâmetros de consulta

Parâmetro	Tipo	Descrição
`pagina`	inteiro	Página (padrão 1)
`por_pagina`	inteiro	1 a 200 (padrão 50)
`ordenar`	texto	Aceita: `id`, `due_date`, `paid_at`, `created_at`, `amount` — prefixo `-` para decrescente
`campos`	texto	Lista de campos do objeto, separados por vírgula
`q`	texto	Busca em: `note`
`status`	texto	pendente \| pago \| cancelado — valor exato ou lista separada por vírgula
`method`	texto (enum)	Forma de pagamento — valor exato ou lista separada por vírgula `pix` `cartao` `dinheiro` `transferencia`
`rental_id`	inteiro	ID da locação — valor exato ou lista separada por vírgula
`revenue_center`	texto (enum)	Carteira de receita (null = segue a carteira da locação) — valor exato ou lista separada por vírgula `mapogos` `premium`
`due_date`	data	Vencimento — valor exato ou lista separada por vírgula
`criado_desde` / `criado_ate`	data	Período de criação
`atualizado_desde`	data-hora	Criados ou alterados desde (pelo registro de alterações do Mapogos)
`incluir`	texto	Só no detalhe. Relações: `locacao`, `comprovantes`

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/pagamentos?por_pagina=20" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/pagamentos?por_pagina=20');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/pagamentos?por_pagina=20', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/pagamentos?por_pagina=20",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": [
        {
            "id": 1024,
            "rental_id": 512,
            "amount": "150.00",
            "original_amount": "150.00",
            "status": "pendente",
            "method": "pix",
            "due_date": "2026-10-15",
            "paid_at": "2026-10-08T14:30:00-03:00"
        }
    ],
    "meta": {
        "total": 1,
        "pagina": 1,
        "por_pagina": 20,
        "paginas": 1
    },
    "request_id": "req_0f1e2d3c4b5a69788796"
}

GET Detalhar

Retorna um registro pelo id. Requer Ler.

Use incluir para embutir relações (cada uma exige Ler no módulo relacionado).

Erro	Quando
`404 nao_encontrado`	Não existe ou está fora das carteiras da chave
`403 permissao_negada`	Sem Ler no módulo (ou numa relação pedida)

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/pagamentos/1024?incluir=locacao" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/pagamentos/1024?incluir=locacao');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/pagamentos/1024?incluir=locacao', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/pagamentos/1024?incluir=locacao",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "rental_id": 512,
        "amount": "150.00",
        "original_amount": "150.00",
        "status": "pendente",
        "method": "pix",
        "due_date": "2026-10-15",
        "paid_at": "2026-10-08T14:30:00-03:00"
    },
    "request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}

Relações

Nome	Módulo	Retorno	Rota
`locacao`	Locações	um registro	`/v1/pagamentos/{id}/locacao`
`comprovantes`	Comprovantes de pagamento	lista paginada	`/v1/pagamentos/{id}/comprovantes`

GET Exportar em lote

Até 1000 registros por chamada, paginando por cursor. Requer Ler e Exportar. Aceita os mesmos filtros da listagem e formato=csv. Detalhes no guia Exportação em lote.

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/pagamentos/exportar?limite=1000" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/pagamentos/exportar?limite=1000');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/pagamentos/exportar?limite=1000', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/pagamentos/exportar?limite=1000",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

POST Gerar cobrança pendente para um contrato ativo

Gerar cobrança pendente para um contrato ativo (não duplica: mesma data+valor devolve a existente). Requer criar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`rental_id`	inteiro	obrigatório	Contrato ATIVO
`amount`	decimal	obrigatório
`due_date`	data	obrigatório
`method`	enum	opcional	`pix` `cartao` `dinheiro` `transferencia`
`note`	texto	opcional	(até 255 caracteres)

Erros possíveis: 422 validacao (lista todos os campos), 409 conflito (estado não permite), 403, 404, 415.

Requisição

Testar ▸

curl -X POST "https://apimapogos.sixinformatica.com/v1/pagamentos" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"rental_id":1024,"amount":"450.00","due_date":"2026-10-15","method":"pix","note":"Aluguel semanal"}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/pagamentos');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
    'Content-Type: application/json',
    'Idempotency-Key: ' . bin2hex(random_bytes(16)),
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'rental_id' => 1024,
    'amount' => '450.00',
    'due_date' => '2026-10-15',
    'method' => 'pix',
    'note' => 'Aluguel semanal',
  ]),
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/pagamentos', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "rental_id": 1024,
      "amount": "450.00",
      "due_date": "2026-10-15",
      "method": "pix",
      "note": "Aluguel semanal"
  }),
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "POST",
    "https://apimapogos.sixinformatica.com/v1/pagamentos",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "rental_id": 1024,
        "amount": "450.00",
        "due_date": "2026-10-15",
        "method": "pix",
        "note": "Aluguel semanal"
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta201 Created

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "rental_id": 512,
        "amount": "150.00",
        "original_amount": "150.00",
        "status": "pendente",
        "method": "pix",
        "due_date": "2026-10-15",
        "paid_at": "2026-10-08T14:30:00-03:00"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

POST Dar baixa

Dar baixa (pago) — mesma regra do botão "Baixa" do painel: cancela PIX pendente, reinicia o ciclo e confirma ao cliente. Requer atualizar.

Erros possíveis: 422 validacao (lista todos os campos), 409 conflito (estado não permite), 403, 404, 415.

Requisição

Testar ▸

curl -X POST "https://apimapogos.sixinformatica.com/v1/pagamentos/1024/baixa" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/pagamentos/1024/baixa');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
    'Content-Type: application/json',
    'Idempotency-Key: ' . bin2hex(random_bytes(16)),
  ],
  CURLOPT_POSTFIELDS     => json_encode(new stdClass()),
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/pagamentos/1024/baixa', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "POST",
    "https://apimapogos.sixinformatica.com/v1/pagamentos/1024/baixa",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "rental_id": 512,
        "amount": "150.00",
        "original_amount": "150.00",
        "status": "pendente",
        "method": "pix",
        "due_date": "2026-10-15",
        "paid_at": "2026-10-08T14:30:00-03:00"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

POST Recebimento manual

Recebimento manual (valor recebido pode ser diferente do original). Requer atualizar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`valor_recebido`	decimal	opcional	Vazio = valor original
`descricao`	texto	opcional	(até 200 caracteres)

Erros possíveis: 422 validacao (lista todos os campos), 409 conflito (estado não permite), 403, 404, 415.

Requisição

Testar ▸

curl -X POST "https://apimapogos.sixinformatica.com/v1/pagamentos/1024/recebimento" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"valor_recebido":"400.00","descricao":"Pago em dinheiro na loja"}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/pagamentos/1024/recebimento');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
    'Content-Type: application/json',
    'Idempotency-Key: ' . bin2hex(random_bytes(16)),
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'valor_recebido' => '400.00',
    'descricao' => 'Pago em dinheiro na loja',
  ]),
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/pagamentos/1024/recebimento', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "valor_recebido": "400.00",
      "descricao": "Pago em dinheiro na loja"
  }),
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "POST",
    "https://apimapogos.sixinformatica.com/v1/pagamentos/1024/recebimento",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "valor_recebido": "400.00",
        "descricao": "Pago em dinheiro na loja"
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "rental_id": 512,
        "amount": "150.00",
        "original_amount": "150.00",
        "status": "pendente",
        "method": "pix",
        "due_date": "2026-10-15",
        "paid_at": "2026-10-08T14:30:00-03:00"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

POST Desfazer baixa

Desfazer baixa (volta para pendente). Requer atualizar.

Erros possíveis: 422 validacao (lista todos os campos), 409 conflito (estado não permite), 403, 404, 415.

Requisição

Testar ▸

curl -X POST "https://apimapogos.sixinformatica.com/v1/pagamentos/1024/estornar" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/pagamentos/1024/estornar');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
    'Content-Type: application/json',
    'Idempotency-Key: ' . bin2hex(random_bytes(16)),
  ],
  CURLOPT_POSTFIELDS     => json_encode(new stdClass()),
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/pagamentos/1024/estornar', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "POST",
    "https://apimapogos.sixinformatica.com/v1/pagamentos/1024/estornar",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "rental_id": 512,
        "amount": "150.00",
        "original_amount": "150.00",
        "status": "pendente",
        "method": "pix",
        "due_date": "2026-10-15",
        "paid_at": "2026-10-08T14:30:00-03:00"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

POST Cancelar cobrança pendente

Cancelar cobrança pendente (remove a cobrança e cancela o PIX correspondente, como no painel). Requer excluir.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`motivo`	texto	obrigatório	Mínimo 3 caracteres (até 200 caracteres)

Erros possíveis: 422 validacao (lista todos os campos), 409 conflito (estado não permite), 403, 404, 415.

Requisição

Testar ▸

curl -X POST "https://apimapogos.sixinformatica.com/v1/pagamentos/1024/cancelar" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"motivo":"Cobrança duplicada"}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/pagamentos/1024/cancelar');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
    'Content-Type: application/json',
    'Idempotency-Key: ' . bin2hex(random_bytes(16)),
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'motivo' => 'Cobrança duplicada',
  ]),
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/pagamentos/1024/cancelar', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "motivo": "Cobrança duplicada"
  }),
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "POST",
    "https://apimapogos.sixinformatica.com/v1/pagamentos/1024/cancelar",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "motivo": "Cobrança duplicada"
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "cancelado": true
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

Recursos incluídos neste módulo

Estes recursos usam a mesma permissão de Pagamentos:

Rota	Recurso	Descrição	Campos
`/v1/pagamentos_comprovantes`	Comprovantes de pagamento	Comprovantes anexados na baixa manual (metadados).	`id`, `payment_id`, `row_type`, `drive_node_id`, `name`, `mime`, `created_by`, `created_at`

Eventos de webhook

pagamento.criado pagamento.confirmado pagamento.vencido pagamento.cancelado — veja Webhooks.