- Dashboard
- Nosso Blog
- Status Page
- POSTCriar um novo token
- GETListar cobranças
- POSTRealizar nova cobrança
- GETRecuperar detalhes de cobrança
- POSTAlterar o status de uma cobrança no ambiente de sandbox
- PATCHAlterar o status do antifraude no ambiente de sandbox
- POSTCapturar cobrança pre-autorizada
- POSTEstornar cobrança aprovada
- POSTCriar nova sessão
- GETRecuperar detalhes de uma sessão
- PATCHAtualizar o status de uma sessão
- POSTPagar uma sessão
- POSTCancelar uma sessão
- GETRecuperar o histórico da sessão
- GETRecupera sessão com os dados das configurações da empresa
- GETListagem de merchants cadastrados
- POSTCriação de novo merchant para cobrança
- GETRecuperar detalhes de merchant pelo id
- DELDeletar merchant pelo id
- PATCHAtualizar configurações de merchant
- GETListagem de customers cadastrados
- POSTCriação de novo customer para cobrança
- GETRecuperar detalhes de customer
- DELDeletar customer pelo id
- PATCHAtualizar customer pelo id
- GETListagem dos cartões do customer
- POSTAdicionar cartão de crédito ao customer
- GETListagem de webhooks cadastrados
- POSTCriação de novo webhook para notificação
- GETRecuperar detalhes de webhook
- DELDeletar webhook pelo id
- PATCHAtualizar webhook pelo id
- POSTCriação de um novo recebedor
- GETConsultar um recebedor pelo ID
- GETConsultar um recebedor por listagem paginada
- DELDeletar recebedor por ID
- PATCHAtualização de recebedor pelo ID
- GETListagem de vendedores paginada
- POSTCriação de um novo vendedor
- PATCHAtualizar um vendedor
- GETRecuperar detalhes de um vendedor
- DELDeletar vededor pelo id
Tokens
Charges
Sessions
Merchants
Customers
Webhooks
Sellers
Vendors
Estornar cobrança aprovada
id da cobrança que deseja estornar
valor do estorno em centavos não podendo ser maior que o valor da transação, exemplo 100 para cobrar R$ 1,00
número de dias para compor o valor a ser estornado. Utilizado apenas pela NuPay.
parâmetro que indica o valor a ser estornado e seu respectivo recebedor
curl --request POST \
--url https://api.malga.io/v1/charges/{id}/void \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>' \
--data '{
"amount": 150
}'
{
"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"currency": "BRL",
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"isDispute": false,
"status": "pre_authorized",
"paymentMethod": {
"paymentType": "credit",
"installments": 1
},
"paymentSource": {
"sourceType": "card",
"cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
},
"transactionRequests": [
{
"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
"providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
"providerType": "STRIPE",
"transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
"amount": 1500,
"authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
"requestStatus": "success",
"requestType": "authorization",
"responseTs": "2633ms",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:42.212Z",
"providerAuthorization": {
"networkAuthorizationCode": "00",
"networkResponseCode": ""
}
}
],
"appInfo": {
"platform": {
"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {
"name": "iOS",
"version": "10.12"
},
"system": {
"name": "VTEX",
"version": "13.12"
}
}
}
Authorizations
Path Parameters
id da cobrança que deseja estornar
Body
valor do estorno em centavos não podendo ser maior que o valor da transação, exemplo 100 para cobrar R$ 1,00
número de dias para compor o valor a ser estornado. Utilizado apenas pela NuPay.
parâmetro que indica o valor a ser estornado e seu respectivo recebedor
identificador do recebedor que participou da transação
valor de estorno do recebedor informado
Response
identificador da transação
identificador do cliente na Malga
identificador do merchant id utilizado na transação
identificador do customer id
Descrição da cobrança para consulta futura
valor da transação em centavos, exemplo 100 para cobrar R$ 1,00
Identificador da moeda para processamento da cobrança, formato ISO 4217.
descrição a ser exibida na fatura do comprador
determina se a transação deve ser capturada automaticamente
determina se a transação está em disputa
status da transação na Malga
pending
, pre_authorized
, authorized
, failed
, canceled
, voided
, charged_back
, refund_pending
, capture_pending
Identificador único da cobrança do lado do cliente para conciliação futura
método da cobrança via Cartão Crédito/Débito
credit
, debit
quantidade de parcelas para cobrança do tipo credito
indica se a transação é recorrente. Pode assumir o valor initial
(primeira transação recorrente), subsequent
(transação recorrente que não é a primeira) ou unscheduled
(cobrança avulsa dentro de contexto de assinatura recorrente para ajustar débitos).
initial
, subsequent
, unscheduled
dados para cobrança por cartão de crédito salve
tipo da origem da cobrança
card
Identificador do cartão quando source tipo card
Data de criação do cartão
Data de atualização do cartão
Parâmetros adicionais para analise de fraude
Valor em Minutos de SLA máximo de Análise do Pedido, se houver
Dados do comprador
Nome do usuario
E-mail do usuario
Telefone de contato do usuario
Tipo de documento, consultar tabela de tipos suportados
Número do documento formato conforme tipo selecionado
Data de registro do cliente
Endereço de entrega
Padrão ISO 3166-1 alpha-2
Estado
Cidade
Bairro
Codigo postal CEP
Nome da rua/avenida/travessa
Numero da rua
Complemento caso exista
Endereço de cobrança
Padrão ISO 3166-1 alpha-2
Estado
Cidade
Bairro
Codigo postal CEP
Nome da rua/avenida/travessa
Numero da rua
Complemento caso exista
Detalhe do carrinho de produtos
nome do item/evento
quantidade de itens do pedido
identificador único do item na loja
valor unitário do item/evento em centavos
definição do indice de risco do item
High
, Low
Descrição do item/evento
Categoria a qual o item/evento pertence
Definição de local, em caso de evento
Definição de data, em caso de evento
Definição de tipo, em caso de evento
Definição do gênero, em caso de evento
Informações relacionadas aos ingressos, em caso de evento
Quantidade total de ingressos à venda
Quantidade de vezes que o evento será realizado na casa
Taxa de Conveniência
Quantidade de ingressos com valor integral
Quantidade de ingresso com desconto (meia entrada)
Lote do Ingresso
Definição de endereço, em caso de evento
Padrão ISO 3166-1 alpha-2
Estado
Cidade
Bairro
Codigo postal CEP
Nome da rua/avenida/travessa
Numero da rua
Complemento caso exista
Campos adicionais para uso em condicionais dos fluxos inteligentes
Campos adicionais da transação enviados na criação da mesma
identificador único do request feito ao provedor
identificador do provider que processou a requisiçao, consulte a lista de providers configurados na sua conta
código que identifica o provedor, consultar tabela de provedores suportados pela Malga
chave única de referência gerada pela Malga para cada requisição, utilizada para garantir idempotência e evitar duplicidade no provedor, pode ser também consultada na API ou dashboard do provedor como orderId ou referenceKey no provedor.
identificador único da transação retornado pelo provider
identificador único da transação retornado pelo provider, txId, pode ser usado para recuperar a transação nas APIs ou dashboard do provedor
identifica o tipo da requisição feita para o provider
pending
, authorization
, pre_authorization
, void
, capture
, probe
, charge_back
, zero_dollar
, anti_fraud
status do processamento da requisição no provider
running
, failed
, success
, timeout
, internal_error
, processing
valor da transação enviada para processamento do provider, em casos de estorno ou captura parcial o valor pode ser diferente do amount original da transação
tempo de duração do processamento da requisição no provider
detalhes do erro em caso de falha no processamento da transação
mensagem de erro mapeado pela Malga que descreve o motivo de rejeição retornad
codigo de erro mapeado pela Malga com base no tipo de erro apresentado pelo provedor
identifica se o tipo de erro permite ou não retentativa
código retornado pelo provider que identitifica o motivo da rejeição, consultar o provedor
mensagem de erro retornado pelo provider, consultar o provedor
dados adicionais do retorno da autorização do provider no processamento da transação
código de autorização da transação conforme retornado pelo provider
código de resposta da requisição conforme retornado pelo provider
Data de criação do request feito ao provedor
Data de atualização do request feito ao provedor
URL para redirecionamento de autenticação
URL de origem da requisição
Informações sobre o navegador do usuário
O Accept do cabeçalho de requisição HTTP
A profundidade de cores da tela
Se Java está habilitado
Se javaScript está habilitado
A linguagem utilizada pelo sistema do usuário
Altura da tela
Largura da tela
Diferença em minutos do deslocamento de fuso horário entre o UTC e a localidade atual
O User-Agent do cabeçalho de requisição HTTP
Endereço de ip do usuário
Endereço de cobrança
Cidade
Padrão ISO 3166-1 alpha-2
Número da rua
Codigo postal CEP
Estado
Rua
Endereço para envio
Cidade
Padrão ISO 3166-1 alpha-2
Número da rua
Codigo postal CEP
Estado
Rua
Endereço para envio
Telefone celular
Dados de autenticação do provedor
Tipo de ação exigida pelo provedor
REDIRECT
Nome do provedor
ADYEN
Identifica a etapa do desafio
AUTHENTICATION
, AUTHORIZATION
O object retornado do provedor com dados para autenticação ou autorização
Informações sobre a rastreabilidade da cobrança
Informações sobre produto das transações (checkout-sdk, vtex, magento, etc..)
Nome do parceiro que implementou a integração
Nome do produto
Versão do produto
Informações sobre o dispositivo (ios, android, windows, linux)
Nome do sistema operacional
Versão do sistema operacional
Informações sobre o sistema proprietário de captura do merchant
Nome da empresa e/ou plataforma
Versão do software da plataforma
curl --request POST \
--url https://api.malga.io/v1/charges/{id}/void \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>' \
--data '{
"amount": 150
}'
{
"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"currency": "BRL",
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"isDispute": false,
"status": "pre_authorized",
"paymentMethod": {
"paymentType": "credit",
"installments": 1
},
"paymentSource": {
"sourceType": "card",
"cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
},
"transactionRequests": [
{
"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
"providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
"providerType": "STRIPE",
"transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
"amount": 1500,
"authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
"requestStatus": "success",
"requestType": "authorization",
"responseTs": "2633ms",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:42.212Z",
"providerAuthorization": {
"networkAuthorizationCode": "00",
"networkResponseCode": ""
}
}
],
"appInfo": {
"platform": {
"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {
"name": "iOS",
"version": "10.12"
},
"system": {
"name": "VTEX",
"version": "13.12"
}
}
}