MAINUMACESSAR CONTA ↗

MAINUM DEVELOPERS / API V1

Integre Pix.
Sem adivinhar.

Contrato público v1 para cobranças Pix, consultas financeiras, saques Pix e leitura de casos MED. Valores monetários são inteiros em centavos e a moeda é BRL.

BASE URLhttps://api.mainumpay.com
01 / PRIMEIROS PASSOS

Uma chave. Um merchant. Escopos mínimos.

Gere sua chave no painel em Integrações, mantenha o token somente no backend e envie-o como Bearer. Chaves nunca devem ser expostas no navegador, checkout ou aplicativo mobile.

curl https://api.mainumpay.com/v1/balance \
  -H "Authorization: Bearer gw_live_SEU_TOKEN" \
  -H "Accept: application/json"
01

Autenticação

Use Authorization: Bearer em todas as chamadas. Uma chave representa um único estabelecimento.

02

Escopos

Cada operação declara o escopo necessário. Sem ele, a chamada falha sem execução parcial.

03

Idempotência

POST financeiros exigem Idempotency-Key entre 8 e 128 caracteres. Uma intenção mantém a mesma chave.

02 / CONVENÇÕES

Regras de toda a API.

BRL

Centavos

R$ 10,50 é 1050. Nunca envie floats, vírgula ou símbolo monetário.

UTC

ISO 8601

Datas incluem timezone. Converta somente na apresentação.

CUR

Cursor opaco

Reenvie next_cursor exatamente como recebido e mantenha os mesmos filtros.

RID

Request ID

Guarde request_id ao abrir suporte, sem registrar tokens ou dados pessoais.

03

Cobranças

POST/v1/chargescharges:write

Criar cobrança Pix

Cria uma cobrança Pix ou recupera com segurança o resultado da mesma tentativa. Reutilize a chave de idempotência enquanto o pedido for o mesmo.

PARÂMETROS

Idempotency-KeystringOBRIGATÓRIO

HEADER · Identificador único da tentativa, entre 8 e 128 caracteres ASCII visíveis.

CORPO JSON

external_idstringOBRIGATÓRIO

Mínimo de 1 caracteres · Máximo de 128 caracteres

amount_centsPositiveCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 1

payerobjectOBRIGATÓRIO

Sem descrição adicional.

descriptionstringOBRIGATÓRIO

Mínimo de 1 caracteres · Máximo de 255 caracteres

EXEMPLO DE CORPO

{
  "external_id": "pedido-1042",
  "amount_cents": 20,
  "payer": {
    "name": "Cliente da Silva",
    "document": "52998224725"
  },
  "description": "Pedido 1042"
}

CURL

curl -X POST 'https://api.mainumpay.com/v1/charges' \
  -H "Authorization: Bearer gw_live_SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Idempotency-Key: pedido-1042-tentativa-1" \
  -H "Content-Type: application/json" \
  --data '{"external_id":"pedido-1042","amount_cents":20,"payer":{"name":"Cliente da Silva","document":"52998224725"},"description":"Pedido 1042"}'

RESPOSTAS

200Cobrança existente recuperada sem artefato Pix disponível+
{
  "id": "0198d2f0-7c31-7000-8000-000000000001",
  "status": "PAID",
  "pix": null,
  "warning": "valor",
  "request_id": "valor"
}
201Cobrança criada+
{
  "id": "0198d2f0-7c31-7000-8000-000000000001",
  "external_id": "pedido-1042",
  "method": "valor",
  "status": "CREATING",
  "amount_cents": 20,
  "fee_cents": 20,
  "net_amount_cents": 20,
  "pix": {
    "copy_paste": "valor",
    "qr_code_url": "valor",
    "qr_code_base64": "data:image/png;base64,..."
  },
  "request_id": "valor"
}
202Resultado da criação ainda em conciliação+
{
  "id": "0198d2f0-7c31-7000-8000-000000000001",
  "status": "PAID",
  "resolution": "valor",
  "request_id": "valor"
}
400Requisição ou cursor inválido+
{
  "error": "valor",
  "request_id": "valor"
}
401Chave ausente, inválida ou sem o escopo exigido+
{
  "error": "valor",
  "request_id": "valor"
}
403Operação não permitida para o estabelecimento+
{
  "error": "valor",
  "request_id": "valor"
}
409Conflito de identificador externo, idempotência ou operação em andamento+
{
  "error": "valor",
  "request_id": "valor"
}
422Regra financeira impediu a operação+
{
  "error": "valor",
  "request_id": "valor"
}
429Limite de requisições excedido+
{
  "error": "valor",
  "request_id": "valor"
}
503Serviço temporariamente indisponível+
{
  "error": "valor",
  "request_id": "valor"
}
GET/v1/charges/{chargeId}charges:read

Consultar cobrança

Consulta somente cobranças pertencentes ao estabelecimento autenticado. O artefato Pix pode ser nulo depois da expiração.

PARÂMETROS

chargeIdstringOBRIGATÓRIO

PATH · Formato: uuid

CURL

curl -X GET 'https://api.mainumpay.com/v1/charges/0198d2f0-7c31-7000-8000-000000000001' \
  -H "Authorization: Bearer gw_live_SEU_TOKEN" \
  -H "Accept: application/json"

RESPOSTAS

200Cobrança encontrada+
{
  "id": "0198d2f0-7c31-7000-8000-000000000001",
  "external_id": "pedido-1042",
  "method": "valor",
  "status": "CREATING",
  "amount_cents": 20,
  "fee_cents": 20,
  "net_amount_cents": 20,
  "pix": {
    "copy_paste": "valor",
    "qr_code_url": "valor",
    "qr_code_base64": "data:image/png;base64,..."
  },
  "expires_at": "2026-08-25T18:42:10.000Z",
  "paid_at": "2026-08-25T18:42:10.000Z",
  "created_at": "2026-08-25T18:40:00.000Z",
  "updated_at": "2026-08-25T18:42:10.000Z",
  "request_id": "valor"
}
400Requisição ou cursor inválido+
{
  "error": "valor",
  "request_id": "valor"
}
401Chave ausente, inválida ou sem o escopo exigido+
{
  "error": "valor",
  "request_id": "valor"
}
404Recurso não encontrado para o estabelecimento autenticado+
{
  "error": "valor",
  "request_id": "valor"
}
429Limite de requisições excedido+
{
  "error": "valor",
  "request_id": "valor"
}
503Serviço temporariamente indisponível+
{
  "error": "valor",
  "request_id": "valor"
}
04

Financeiro

GET/v1/transactionstransactions:read

Listar transações

Retorna a movimentação operacional em ordem decrescente, com cursor opaco para navegar sem repetir registros.

PARÂMETROS

limitintegerOPCIONAL

QUERY · Mínimo: 1 · Máximo: 100

cursorstringOPCIONAL

QUERY · Cursor opaco devolvido pela página anterior.

statusChargeStatusOPCIONAL

QUERY ·

CURL

curl -X GET 'https://api.mainumpay.com/v1/transactions?limit=20&cursor=CURSOR_RETORNADO&status=PAID' \
  -H "Authorization: Bearer gw_live_SEU_TOKEN" \
  -H "Accept: application/json"

RESPOSTAS

200Página de transações+
{
  "data": [
    {
      "id": "0198d2f0-7c31-7000-8000-000000000001",
      "external_id": "pedido-1042",
      "type": "valor",
      "method": "valor",
      "currency": "valor",
      "status": "CREATING",
      "amount_cents": 20,
      "fee_cents": 20,
      "net_amount_cents": 20,
      "paid_at": "2026-08-25T18:42:10.000Z",
      "created_at": "2026-08-25T18:40:00.000Z",
      "updated_at": "2026-08-25T18:42:10.000Z"
    }
  ],
  "next_cursor": "valor",
  "request_id": "valor"
}
400Requisição ou cursor inválido+
{
  "error": "valor",
  "request_id": "valor"
}
401Chave ausente, inválida ou sem o escopo exigido+
{
  "error": "valor",
  "request_id": "valor"
}
429Limite de requisições excedido+
{
  "error": "valor",
  "request_id": "valor"
}
GET/v1/balancebalance:read

Consultar saldo

Separa saldo sacável, carência, reservas e bloqueios. Nunca use apenas o total visual para decidir se um saque pode ser criado.

CURL

curl -X GET 'https://api.mainumpay.com/v1/balance' \
  -H "Authorization: Bearer gw_live_SEU_TOKEN" \
  -H "Accept: application/json"

RESPOSTAS

200Saldo derivado do livro-caixa+
{
  "currency": "valor",
  "pending_cents": 20,
  "blocked_cents": 20,
  "reserved_cents": 20,
  "med_reserved_cents": 20,
  "withdrawal_reserved_cents": 20,
  "scheduled_med_reserve_cents": 20,
  "unclassified_cents": 20,
  "available_cents": 20,
  "available_hold_cents": 20,
  "withdrawable_cents": 20,
  "availability_status": "valor",
  "request_id": "valor"
}
401Chave ausente, inválida ou sem o escopo exigido+
{
  "error": "valor",
  "request_id": "valor"
}
429Limite de requisições excedido+
{
  "error": "valor",
  "request_id": "valor"
}
GET/v1/statementstatement:read

Consultar extrato

Lista eventos do livro-caixa já projetados para a integração. Valores de saída são negativos.

PARÂMETROS

limitintegerOPCIONAL

QUERY · Mínimo: 1 · Máximo: 100

cursorstringOPCIONAL

QUERY · Cursor opaco devolvido pela página anterior.

CURL

curl -X GET 'https://api.mainumpay.com/v1/statement?limit=20&cursor=CURSOR_RETORNADO' \
  -H "Authorization: Bearer gw_live_SEU_TOKEN" \
  -H "Accept: application/json"

RESPOSTAS

200Página do extrato+
{
  "currency": "valor",
  "data": [
    {
      "id": "0198d2f0-7c31-7000-8000-000000000001",
      "journal_id": "0198d2f0-7c31-7000-8000-000000000001",
      "reference_id": "0198d2f0-7c31-7000-8000-000000000001",
      "reference_type": "valor",
      "type": "valor",
      "category": "PENDING",
      "amount_cents": 20,
      "occurred_at": "2026-08-25T18:42:10.000Z"
    }
  ],
  "next_cursor": "valor",
  "request_id": "valor"
}
400Requisição ou cursor inválido+
{
  "error": "valor",
  "request_id": "valor"
}
401Chave ausente, inválida ou sem o escopo exigido+
{
  "error": "valor",
  "request_id": "valor"
}
429Limite de requisições excedido+
{
  "error": "valor",
  "request_id": "valor"
}
05

Saques

POST/v1/withdrawalswithdrawals:write

Reservar saque Pix

Reserva saldo antes do envio à rede Pix. A confirmação é assíncrona e deve ser acompanhada por webhook ou consulta.

PARÂMETROS

Idempotency-KeystringOBRIGATÓRIO

HEADER · Identificador único da tentativa, entre 8 e 128 caracteres ASCII visíveis.

CORPO JSON

external_idstringOBRIGATÓRIO

Mínimo de 1 caracteres · Máximo de 128 caracteres

amount_centsPositiveCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 1

pix_keyobjectOBRIGATÓRIO

Sem descrição adicional.

descriptionstringOBRIGATÓRIO

Mínimo de 1 caracteres · Máximo de 255 caracteres

EXEMPLO DE CORPO

{
  "external_id": "pedido-1042",
  "amount_cents": 20,
  "pix_key": {
    "type": "CPF",
    "value": "valor"
  },
  "description": "Pedido 1042"
}

CURL

curl -X POST 'https://api.mainumpay.com/v1/withdrawals' \
  -H "Authorization: Bearer gw_live_SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Idempotency-Key: pedido-1042-tentativa-1" \
  -H "Content-Type: application/json" \
  --data '{"external_id":"pedido-1042","amount_cents":20,"pix_key":{"type":"CPF","value":"valor"},"description":"Pedido 1042"}'

RESPOSTAS

201Saque reservado+
{
  "id": "0198d2f0-7c31-7000-8000-000000000001",
  "external_id": "pedido-1042",
  "method": "valor",
  "status": "RESERVED",
  "amount_cents": 20,
  "fee_cents": 20,
  "total_debit_cents": 20,
  "pix_key": {
    "type": "CPF",
    "masked": "valor"
  },
  "created_at": "2026-08-25T18:40:00.000Z",
  "request_id": "valor"
}
400Requisição ou cursor inválido+
{
  "error": "valor",
  "request_id": "valor"
}
401Chave ausente, inválida ou sem o escopo exigido+
{
  "error": "valor",
  "request_id": "valor"
}
403Operação não permitida para o estabelecimento+
{
  "error": "valor",
  "request_id": "valor"
}
409Conflito de identificador externo, idempotência ou operação em andamento+
{
  "error": "valor",
  "request_id": "valor"
}
422Regra financeira impediu a operação+
{
  "error": "valor",
  "request_id": "valor"
}
429Limite de requisições excedido+
{
  "error": "valor",
  "request_id": "valor"
}
503Serviço temporariamente indisponível+
{
  "error": "valor",
  "request_id": "valor"
}
GET/v1/withdrawals/{withdrawalId}withdrawals:read

Consultar saque Pix

Consulta o estado autoritativo do saque solicitado, inclusive falhas e conclusão.

PARÂMETROS

withdrawalIdstringOBRIGATÓRIO

PATH · Formato: uuid

CURL

curl -X GET 'https://api.mainumpay.com/v1/withdrawals/0198d2f0-7c31-7000-8000-000000000002' \
  -H "Authorization: Bearer gw_live_SEU_TOKEN" \
  -H "Accept: application/json"

RESPOSTAS

200Saque encontrado+
{
  "id": "0198d2f0-7c31-7000-8000-000000000001",
  "external_id": "pedido-1042",
  "method": "valor",
  "status": "RESERVED",
  "amount_cents": 20,
  "fee_cents": 20,
  "total_debit_cents": 20,
  "pix_key": {
    "type": "CPF",
    "masked": "valor"
  },
  "created_at": "2026-08-25T18:40:00.000Z",
  "request_id": "valor"
}
400Requisição ou cursor inválido+
{
  "error": "valor",
  "request_id": "valor"
}
401Chave ausente, inválida ou sem o escopo exigido+
{
  "error": "valor",
  "request_id": "valor"
}
404Recurso não encontrado para o estabelecimento autenticado+
{
  "error": "valor",
  "request_id": "valor"
}
429Limite de requisições excedido+
{
  "error": "valor",
  "request_id": "valor"
}
06

MED

GET/v1/med-casesmed:read

Listar casos MED

Lista contestações MED do estabelecimento. Esta API é somente leitura; a defesa passa pelo painel.

PARÂMETROS

limitintegerOPCIONAL

QUERY · Mínimo: 1 · Máximo: 100

cursorstringOPCIONAL

QUERY · Cursor opaco devolvido pela página anterior.

statusMedStatusOPCIONAL

QUERY ·

CURL

curl -X GET 'https://api.mainumpay.com/v1/med-cases?limit=20&cursor=CURSOR_RETORNADO&status=PAID' \
  -H "Authorization: Bearer gw_live_SEU_TOKEN" \
  -H "Accept: application/json"

RESPOSTAS

200Página de casos MED+
{
  "data": [
    {
      "id": "0198d2f0-7c31-7000-8000-000000000001",
      "charge_id": "0198d2f0-7c31-7000-8000-000000000001",
      "charge_external_id": "valor",
      "method": "valor",
      "currency": "valor",
      "status": "WAITING_PSP",
      "resolution_state": "OPEN",
      "amount_cents": 20,
      "blocked_amount_cents": 20,
      "exposure_amount_cents": 20,
      "outstanding_exposure_amount_cents": 20,
      "opened_at": "2026-08-25T18:42:10.000Z",
      "observed_at": "2026-08-25T18:42:10.000Z",
      "resolved_at": "2026-08-25T18:42:10.000Z",
      "updated_at": "2026-08-25T18:42:10.000Z"
    }
  ],
  "next_cursor": "valor",
  "request_id": "valor"
}
400Requisição ou cursor inválido+
{
  "error": "valor",
  "request_id": "valor"
}
401Chave ausente, inválida ou sem o escopo exigido+
{
  "error": "valor",
  "request_id": "valor"
}
429Limite de requisições excedido+
{
  "error": "valor",
  "request_id": "valor"
}
GET/v1/med-cases/{medCaseId}med:read

Consultar caso MED

Retorna exposição, bloqueios, resolução e datas de um caso MED do próprio estabelecimento.

PARÂMETROS

medCaseIdstringOBRIGATÓRIO

PATH · Formato: uuid

CURL

curl -X GET 'https://api.mainumpay.com/v1/med-cases/0198d2f0-7c31-7000-8000-000000000003' \
  -H "Authorization: Bearer gw_live_SEU_TOKEN" \
  -H "Accept: application/json"

RESPOSTAS

200Caso MED encontrado+
{
  "data": {
    "id": "0198d2f0-7c31-7000-8000-000000000001",
    "charge_id": "0198d2f0-7c31-7000-8000-000000000001",
    "charge_external_id": "valor",
    "method": "valor",
    "currency": "valor",
    "status": "WAITING_PSP",
    "resolution_state": "OPEN",
    "amount_cents": 20,
    "blocked_amount_cents": 20,
    "exposure_amount_cents": 20,
    "outstanding_exposure_amount_cents": 20,
    "opened_at": "2026-08-25T18:42:10.000Z",
    "observed_at": "2026-08-25T18:42:10.000Z",
    "resolved_at": "2026-08-25T18:42:10.000Z",
    "updated_at": "2026-08-25T18:42:10.000Z"
  },
  "request_id": "valor"
}
400Requisição ou cursor inválido+
{
  "error": "valor",
  "request_id": "valor"
}
401Chave ausente, inválida ou sem o escopo exigido+
{
  "error": "valor",
  "request_id": "valor"
}
404Recurso não encontrado para o estabelecimento autenticado+
{
  "error": "valor",
  "request_id": "valor"
}
429Limite de requisições excedido+
{
  "error": "valor",
  "request_id": "valor"
}
EVENTOS / WEBHOOKS

Confirme a origem antes de processar.

A Mainum envia POST com JSON bruto. Responda 2xx em até três segundos, deduplique por event_id e processe o evento de forma assíncrona.

HEADERS

X-Mainum-Event-IdUUIDOBRIGATÓRIO

Identificador único para deduplicação.

X-Mainum-TimestampUnix secondsOBRIGATÓRIO

Instante usado na assinatura.

X-Mainum-Signaturev1=hexOBRIGATÓRIO

HMAC-SHA256 do timestamp e corpo bruto.

ENVELOPE

{
  "event_id": "0198d2f0-7c31-7000-8000-000000000010",
  "event_type": "charge.paid",
  "created_at": "2026-08-25T18:42:10.000Z",
  "api_version": "v1",
  "data": {
    "charge_id": "0198d2f0-7c31-7000-8000-000000000001",
    "external_id": "pedido-1042",
    "status": "PAID",
    "amount_cents": "1050",
    "fee_cents": "64",
    "net_amount_cents": "986",
    "occurred_at": "2026-08-25T18:42:10.000Z"
  }
}

VALIDAÇÃO EM NODE.JS

import { createHmac, timingSafeEqual } from "node:crypto";

const timestamp = req.headers["x-mainum-timestamp"];
const received = req.headers["x-mainum-signature"];
const rawBody = req.rawBody; // bytes exatos recebidos
const expected = "v1=" + createHmac("sha256", WEBHOOK_SECRET)
  .update(timestamp + "." + rawBody)
  .digest("hex");
const valid = received?.length === expected.length &&
  timingSafeEqual(Buffer.from(received), Buffer.from(expected));
charge.paidcharge.failedcharge.expiredcharge.canceledcharge.reversedwithdrawal.completedwithdrawal.failedmed.createdmed.updated
REFERÊNCIA / TIPOS

Todos os schemas públicos.

Gerados do mesmo OpenAPI validado no backend. Campos não documentados não devem ser presumidos.

RequestIdstring+
"valor"
Centsinteger+
20
PositiveCentsinteger+
20
SignedCentsinteger+
20
NullableDateTimestringnull+
"2026-08-25T18:42:10.000Z"
NullableCursorstringnull+
"valor"
ChargeStatusCREATING | PENDING | PAID | FAILED | CANCELED | EXPIRED | UNDER_REVIEW | REVERSED+
"CREATING"
WithdrawalStatusRESERVED | SUBMITTING | QUEUED | PROCESSING | COMPLETED | FAILED | CANCELED | UNKNOWN | MANUAL_REVIEW+
"RESERVED"
MedStatusWAITING_PSP | ACCEPTED | REJECTED | CANCELLED+
"WAITING_PSP"
Errorobject+
errorstringOBRIGATÓRIO

Sem descrição adicional.

request_idRequestIdOBRIGATÓRIO

Mínimo de 1 caracteres

PixArtifactobject+
copy_pastestringOBRIGATÓRIO

Sem descrição adicional.

qr_code_urlstringnullOBRIGATÓRIO

Formato: uri

qr_code_base64stringnullOBRIGATÓRIO

Sem descrição adicional.

CreateChargeRequestobject+
external_idstringOBRIGATÓRIO

Mínimo de 1 caracteres · Máximo de 128 caracteres

amount_centsPositiveCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 1

payerobjectOBRIGATÓRIO

Sem descrição adicional.

descriptionstringOBRIGATÓRIO

Mínimo de 1 caracteres · Máximo de 255 caracteres

ChargeFieldsobject+
idstringOBRIGATÓRIO

Formato: uuid

external_idstringOBRIGATÓRIO

Sem descrição adicional.

methodobjectOBRIGATÓRIO

Sem descrição adicional.

statusChargeStatusOBRIGATÓRIO

Valores: CREATING, PENDING, PAID, FAILED, CANCELED, EXPIRED, UNDER_REVIEW, REVERSED

amount_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

fee_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

net_amount_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

CreatedChargeChargeFields + object+
idstringOBRIGATÓRIO

Formato: uuid

external_idstringOBRIGATÓRIO

Sem descrição adicional.

methodobjectOBRIGATÓRIO

Sem descrição adicional.

statusChargeStatusOBRIGATÓRIO

Valores: CREATING, PENDING, PAID, FAILED, CANCELED, EXPIRED, UNDER_REVIEW, REVERSED

amount_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

fee_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

net_amount_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

pixPixArtifactOBRIGATÓRIO

Sem descrição adicional.

request_idRequestIdOBRIGATÓRIO

Mínimo de 1 caracteres

ChargeChargeFields + object+
idstringOBRIGATÓRIO

Formato: uuid

external_idstringOBRIGATÓRIO

Sem descrição adicional.

methodobjectOBRIGATÓRIO

Sem descrição adicional.

statusChargeStatusOBRIGATÓRIO

Valores: CREATING, PENDING, PAID, FAILED, CANCELED, EXPIRED, UNDER_REVIEW, REVERSED

amount_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

fee_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

net_amount_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

pixPixArtifact | nullOBRIGATÓRIO

Sem descrição adicional.

expires_atNullableDateTimeOBRIGATÓRIO

Formato: date-time

paid_atNullableDateTimeOBRIGATÓRIO

Formato: date-time

created_atstringOBRIGATÓRIO

Formato: date-time

updated_atstringOBRIGATÓRIO

Formato: date-time

request_idRequestIdOBRIGATÓRIO

Mínimo de 1 caracteres

ChargeCreationPendingobject+
idstringOBRIGATÓRIO

Formato: uuid

statusobjectOBRIGATÓRIO

Sem descrição adicional.

resolutionobjectOBRIGATÓRIO

Sem descrição adicional.

request_idRequestIdOBRIGATÓRIO

Mínimo de 1 caracteres

ChargeArtifactUnavailableobject+
idstringOBRIGATÓRIO

Formato: uuid

statusobjectOBRIGATÓRIO

Sem descrição adicional.

pixnullOBRIGATÓRIO

Sem descrição adicional.

warningobjectOBRIGATÓRIO

Sem descrição adicional.

request_idRequestIdOBRIGATÓRIO

Mínimo de 1 caracteres

Transactionobject+
idstringOBRIGATÓRIO

Formato: uuid

external_idstringOBRIGATÓRIO

Sem descrição adicional.

typeobjectOBRIGATÓRIO

Sem descrição adicional.

methodobjectOBRIGATÓRIO

Sem descrição adicional.

currencyobjectOBRIGATÓRIO

Sem descrição adicional.

statusChargeStatusOBRIGATÓRIO

Valores: CREATING, PENDING, PAID, FAILED, CANCELED, EXPIRED, UNDER_REVIEW, REVERSED

amount_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

fee_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

net_amount_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

paid_atNullableDateTimeOBRIGATÓRIO

Formato: date-time

created_atstringOBRIGATÓRIO

Formato: date-time

updated_atstringOBRIGATÓRIO

Formato: date-time

TransactionPageobject+
dataTransaction[]OBRIGATÓRIO

Sem descrição adicional.

next_cursorNullableCursorOBRIGATÓRIO

Sem descrição adicional.

request_idRequestIdOBRIGATÓRIO

Mínimo de 1 caracteres

Balanceobject+
currencyobjectOBRIGATÓRIO

Sem descrição adicional.

pending_centsSignedCentsOBRIGATÓRIO

Formato: int64

blocked_centsSignedCentsOBRIGATÓRIO

Formato: int64

reserved_centsSignedCentsOBRIGATÓRIO

Formato: int64

med_reserved_centsSignedCentsOBRIGATÓRIO

Formato: int64

withdrawal_reserved_centsSignedCentsOBRIGATÓRIO

Formato: int64

scheduled_med_reserve_centsSignedCentsOBRIGATÓRIO

Formato: int64

unclassified_centsSignedCentsOBRIGATÓRIO

Formato: int64

available_centsSignedCentsOBRIGATÓRIO

Formato: int64

available_hold_centsSignedCentsOBRIGATÓRIO

Formato: int64

withdrawable_centsSignedCentsOBRIGATÓRIO

Formato: int64

availability_statusobjectOBRIGATÓRIO

Sem descrição adicional.

request_idRequestIdOBRIGATÓRIO

Mínimo de 1 caracteres

StatementEntryobject+
idstringOBRIGATÓRIO

Formato: uuid

journal_idstringOBRIGATÓRIO

Formato: uuid

reference_idstringOBRIGATÓRIO

Formato: uuid

reference_typestringOBRIGATÓRIO

Sem descrição adicional.

typestringOBRIGATÓRIO

Sem descrição adicional.

categoryPENDING | AVAILABLE | WITHDRAWABLE | BLOCKED | RESERVED | UNCLASSIFIEDOBRIGATÓRIO

Valores: PENDING, AVAILABLE, WITHDRAWABLE, BLOCKED, RESERVED, UNCLASSIFIED

amount_centsSignedCentsOBRIGATÓRIO

Formato: int64

occurred_atstringOBRIGATÓRIO

Formato: date-time

StatementPageobject+
currencyobjectOBRIGATÓRIO

Sem descrição adicional.

dataStatementEntry[]OBRIGATÓRIO

Sem descrição adicional.

next_cursorNullableCursorOBRIGATÓRIO

Sem descrição adicional.

request_idRequestIdOBRIGATÓRIO

Mínimo de 1 caracteres

PixKeyTypeCPF | CNPJ | EMAIL | TELEFONE | CHAVE_ALEATORIA+
"CPF"
CreateWithdrawalRequestobject+
external_idstringOBRIGATÓRIO

Mínimo de 1 caracteres · Máximo de 128 caracteres

amount_centsPositiveCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 1

pix_keyobjectOBRIGATÓRIO

Sem descrição adicional.

descriptionstringOBRIGATÓRIO

Mínimo de 1 caracteres · Máximo de 255 caracteres

Withdrawalobject+
idstringOBRIGATÓRIO

Formato: uuid

external_idstringOBRIGATÓRIO

Sem descrição adicional.

methodobjectOBRIGATÓRIO

Sem descrição adicional.

statusWithdrawalStatusOBRIGATÓRIO

Valores: RESERVED, SUBMITTING, QUEUED, PROCESSING, COMPLETED, FAILED, CANCELED, UNKNOWN, MANUAL_REVIEW

amount_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

fee_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

total_debit_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

pix_keyobjectOBRIGATÓRIO

Sem descrição adicional.

created_atstringOBRIGATÓRIO

Formato: date-time

request_idRequestIdOBRIGATÓRIO

Mínimo de 1 caracteres

MedCaseobject+
idstringOBRIGATÓRIO

Formato: uuid

charge_idstringOBRIGATÓRIO

Formato: uuid

charge_external_idstringOBRIGATÓRIO

Sem descrição adicional.

methodobjectOBRIGATÓRIO

Sem descrição adicional.

currencyobjectOBRIGATÓRIO

Sem descrição adicional.

statusMedStatusOBRIGATÓRIO

Valores: WAITING_PSP, ACCEPTED, REJECTED, CANCELLED

resolution_stateOPEN | PROCESSING | RESOLVEDOBRIGATÓRIO

Valores: OPEN, PROCESSING, RESOLVED

amount_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

blocked_amount_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

exposure_amount_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

outstanding_exposure_amount_centsCentsOBRIGATÓRIO

Formato: int64 · Mínimo: 0

opened_atstringOBRIGATÓRIO

Formato: date-time

observed_atstringOBRIGATÓRIO

Formato: date-time

resolved_atNullableDateTimeOBRIGATÓRIO

Formato: date-time

updated_atstringOBRIGATÓRIO

Formato: date-time

MedCasePageobject+
dataMedCase[]OBRIGATÓRIO

Sem descrição adicional.

next_cursorNullableCursorOBRIGATÓRIO

Sem descrição adicional.

request_idRequestIdOBRIGATÓRIO

Mínimo de 1 caracteres