# Documentação Malga API API

> Documentação Malga API API on Apizie: 46 endpoints (Criar nova chave pública para uso no client-side, Criar um novo token, Listar cartões, Criar novo cartão a partir de token, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/security:malga/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `security:malga`
- Category: Security
- Status: byok
- Source: https://malga.io
- Page: https://apizie.tech/api/security/malga
- OpenAPI: https://apizie.tech/api/security/malga/openapi.json

# Authentication Os serviços de API da Malga são protegidos através de chaves de acesso. Você pode gerenciar suas chaves de acesso através do seu dashboard. É importante armazenar suas chaves de maneira privada e…

## Endpoints

### Criar nova chave pública para uso no client-side
`POST https://apizie.tech/v1/security:malga/clienttoken-create-public-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Criar um novo token
`POST https://apizie.tech/v1/security:malga/create-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Listar cartões
`GET https://apizie.tech/v1/security:malga/cards-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | número da página |
| limit | number | no | quantidade de itens por página |

### Criar novo cartão a partir de token
`POST https://apizie.tech/v1/security:malga/cards-create-new-card-from-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Recuperar detalhes de cartão
`GET https://apizie.tech/v1/security:malga/cards-get-card-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID do cartão |

### Listar cobranças
`GET https://apizie.tech/v1/security:malga/charges-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | numero da pagina ativa |
| limit | number | no | quantidade de registros por página 1-100 |
| sort | string | no | tipo de ordenação decrescente ou crescente |
| merchantId | string | no | id do merchant processado na cobrança |
| id | string | no | id da cobrança |
| originalAmount | number | no | valor em centavos da cobrança |
| status | string | no | status da cobrança |
| paymentType | string | no | tipo de pagamento |
| orderId | string | no | id da cobrança gerado pelo cliente |
| created | string | no | registros criados em uma data específica |
| created.gt | string | no | registros com data maior que |
| created.lt | string | no | registros com data menor que |

### Realizar nova cobrança
`POST https://apizie.tech/v1/security:malga/charges-create-new-charge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Recuperar detalhes de cobrança
`GET https://apizie.tech/v1/security:malga/charges-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id da cobrança que deseja recuperar |

### Alterar o status de uma cobrança no ambiente de sandbox
`POST https://apizie.tech/v1/security:malga/charges-update-status-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id da cobrança que deseja alterar no sandbox |
| body | object | no | JSON request body |

### Alterar o status do antifraude no ambiente de sandbox
`POST https://apizie.tech/v1/security:malga/charges-alter-antifraud-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id da cobrança que deseja alterar no sandbox |
| body | object | no | JSON request body |

### Capturar cobrança pre-autorizada
`POST https://apizie.tech/v1/security:malga/charges-capture-charge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id da cobrança que deseja capturar |
| body | object | no | JSON request body |

### Estornar cobrança aprovada
`POST https://apizie.tech/v1/security:malga/charges-void-approved-charge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id da cobrança que deseja estornar |
| body | object | no | JSON request body |

### Criar nova sessão
`POST https://apizie.tech/v1/security:malga/sessions-create-new-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Recuperar detalhes de uma sessão
`GET https://apizie.tech/v1/security:malga/sessions-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identificação da sessão a ser recuperada |

### Atualizar o status de uma sessão
`POST https://apizie.tech/v1/security:malga/sessions-update-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identificação da sessão a ser alterada |

### Pagar uma sessão
`POST https://apizie.tech/v1/security:malga/sessions-charge-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identificação da sessão a ser paga |
| body | object | no | JSON request body |

### Cancelar uma sessão
`POST https://apizie.tech/v1/security:malga/sessions-cancelar-sessao` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identificação da sessão a ser cancelada |

### Recuperar o histórico da sessão
`GET https://apizie.tech/v1/security:malga/sessions-get-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identificação da sessão a ser recuperada |

### Recupera sessão com os dados das configurações da empresa
`GET https://apizie.tech/v1/security:malga/sessions-get-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identificação da sessão a ser recuperada |

### Listagem de merchants cadastrados
`GET https://apizie.tech/v1/security:malga/merchants-list-registered-merchants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | número da página |
| limit | number | no | quantidade de itens por página |

### Criação de novo merchant para cobrança
`POST https://apizie.tech/v1/security:malga/merchants-create-new-merchant` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Recuperar detalhes de merchant pelo id
`GET https://apizie.tech/v1/security:malga/merchants-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id do merchant |

### Atualizar configurações de merchant
`POST https://apizie.tech/v1/security:malga/merchants-atualizar-configuracoes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id do merchant |
| body | object | yes | JSON request body |

### Deletar merchant pelo id
`POST https://apizie.tech/v1/security:malga/merchants-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id do merchant |

### Listagem de customers cadastrados
`GET https://apizie.tech/v1/security:malga/customers-listagem-cadastrados` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | número da página |
| limit | number | no | quantidade de itens por página |
| sort | string | no | ordenação dos itens |
| id | string | no | identificador de um customer |
| document.type | string | no | tipo de documento |
| document.number | string | no | numero do documento |

### Criação de novo customer para cobrança
`POST https://apizie.tech/v1/security:malga/customers-create-new-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Recuperar detalhes de customer
`GET https://apizie.tech/v1/security:malga/customers-recuperar-detalhes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id do customers que deseja recuperar |

### Atualizar customer pelo id
`POST https://apizie.tech/v1/security:malga/customers-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id do customers que deseja alterar |
| body | object | yes | JSON request body |

### Deletar customer pelo id
`POST https://apizie.tech/v1/security:malga/customers-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id do customers que deseja deletar |

### Listagem dos cartões do customer
`GET https://apizie.tech/v1/security:malga/customers-list-cards` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | id do customers que deseja alterar |

### Adicionar cartão de crédito ao customer
`POST https://apizie.tech/v1/security:malga/customers-add-credit-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | id do customers que deseja alterar |
| body | object | yes | JSON request body |

### Listagem de webhooks cadastrados
`GET https://apizie.tech/v1/security:malga/webhooks-list-webhooks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | número da página |
| limit | number | no | quantidade de itens por página |

### Criação de novo webhook para notificação
`POST https://apizie.tech/v1/security:malga/webhooks-create-new-notification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Recuperar detalhes de webhook
`GET https://apizie.tech/v1/security:malga/webhooks-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id do webhook que deseja recuperar |

### Atualizar webhook pelo id
`POST https://apizie.tech/v1/security:malga/webhooks-atualizar-pelo-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id do webhook que deseja alterar |
| body | object | yes | JSON request body |

### Deletar webhook pelo id
`POST https://apizie.tech/v1/security:malga/webhooks-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id do webhook que deseja deletar |

### Criação de um novo recebedor
`POST https://apizie.tech/v1/security:malga/sellers-create-new` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Consultar um recebedor pelo ID
`GET https://apizie.tech/v1/security:malga/sellers-consult-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identificador do seller |

### Consultar um recebedor por listagem paginada
`GET https://apizie.tech/v1/security:malga/sellers-list-paged` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no | Identificador do seller |
| email | string | no | E-mail do seller |
| status | string | no | Status do seller |
| limit | number | no | Limite de itens retornados na consulta |
| page | number | no | Páginas da consulta |

### Atualização de recebedor pelo ID
`POST https://apizie.tech/v1/security:malga/sellers-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identificador do seller |
| body | object | no | JSON request body |

### Deletar recebedor por ID
`POST https://apizie.tech/v1/security:malga/sellers-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID do seller |
| body | object | no | JSON request body |

### Recuperar todos os fluxos paginado
`GET https://apizie.tech/v1/security:malga/flows-get-paged` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | número da página |
| limit | number | no | quantidade de itens por página |
| merchantId | string | no | usado para filtrar os fluxos por merchantId |
| paymentMethod | string | no | usado para filtrar os fluxos por método de pagamento |

### Consultar um fluxo pelo id
`GET https://apizie.tech/v1/security:malga/flows-consultar-pelo-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | flow id |

### Exportar dados da base
`POST https://apizie.tech/v1/security:malga/reports-export-base-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accept-language | string | no | Idioma da exportação |
| X-User-Timezone | string | no | Timezone local do cliente no formato tz database |
| body | object | no | JSON request body |

### Recuperar detalhes de uma exportação
`GET https://apizie.tech/v1/security:malga/reports-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Id da exportação |

### Fazer download de um arquivo
`GET https://apizie.tech/v1/security:malga/reports-download-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Id da exportação |
| pageNumber | string | yes | Número da página |

## Example
```
curl "https://apizie.tech/v1/security:malga/clienttoken-create-public-key" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Documentação Malga API API?
Create a free Apizie key, then send POST https://apizie.tech/v1/security:malga/clienttoken-create-public-key with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Documentação Malga API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Documentação Malga API itself also needs your own key from api.malga.io.

### Can AI agents use the Documentação Malga API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key security:malga.

### What is the status of the Documentação Malga API API?
Needs your own provider key (bring your own key)