Visão Geral
Tokens
Charges
Sessions
Customers
Merchants
Vendors
Sellers
Webhooks
Reports
Realizar nova cobrança
Identificação do merchant id a ser utilizado
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 fatura do comprador
Determina se a transação deve ser capturada automaticamente
Identificador único da cobrança do lado do cliente para conciliação futura
Identificador único da cobrança do lado do cliente utilizado para referenciar a cobrança do lado do adquirente/provedor. Caso não enviado a gestão dessa informação será feita pela Malga, que gera um uuid para cada requisição nova aos provedores.
Descrição da cobrança para consulta futura
Identificador de comprador para consulta futura
Define o método de cobrança
Método da cobrança via Cartão Crédito/Débito/Voucher
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).
Dados para cobrança por cartão de crédito salve
Tipo da origem da cobrança, usar card
para cobrança em cartão tokenizado
Identificador do cartão quando source tipo card
Código de verificação cobrança sem tokenização, deve ser enviado sempre que o comprador estiver presente no momento da compra (opcional)
Parâmetros adicionais para análise de fraude, necessários para processamento com provedores específicos
Valor em Minutos de SLA máximo de Análise do Pedido, se houver
Dados do comprador
nome do usuario
email 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
Informações sobre o navegador do usuário
fingerprint gerado do navegador
indica se os cookies foram aceitados
e-mail logado no navegador
nome do host do usuário
endereço de ip do usuário
user-agent do browser
Detalhe do carrinho de produtos
Detalhes do aparelho do consumidor
id do dispositivo
ID da sessão
tipo do sistema operacional
versão do sistema operacional
modelo do aparelho
capacidade da memória RAM do aparelho
capacidade de armazenamento do aparelho
quantidade de memória livre
resolução do aparelho
atributos do aparelho fornecidos pelo fornecedor
aparelho possui flash
aparelho pode realizar chamadas
aparelho pode enviar sms
aparelho possui camera de video
quantidade de cpus
aparelho possui simulador
lingua do aparelho
idioma do aparelho
plataforma do sistema
nome do aparelho
família do aparelho
aparelho possui display de retina
aparelho possui camera
modelo do aparelho
aparelho possui camera frontal
Detalhes da reserva de passagem aérea
Informações sobre os passageiros
Detalhes das conexões de voo
Data da reserva de passagem aérea
Origem do pedido
Tipo de sistema operacional do cliente
Tipo de mercado
Informações sobre o canal de compra
Última data de inserção de e-mail
Última data de alteração de senha
Última data de alteração de telefone
Última data de alteração de telefone móvel
Última data de inserção de endereço
Indica se a compra foi registrada
Endereço de e-mail do comprador
Nome de usuário do comprador
Informações da rede social do comprador
Opt-in para Compre Confie
Tipo de rede social
Token de autenticação
Lista de presentes
Tipo de lista
Identificador da lista de presentes
Informações sobre reservas de hotéis
Parâmetros adicionais para transacionar com Split
Parâmetros adicionais para transacionar com vendors
identificador do vendedor já cadastrado na API de vendors
Seu código de Subadquirente na respectiva bandeira. Verifique a lista de provedores suportados
Campos adicionais para uso em condicionais dos fluxos inteligentes
Campos adicionais da transação enviados na criação da mesma
Parâmetros adicionais para transacionar com 3D Secure 2
Id da sessão de autenticação Malga, utilizado somente para 3DS2 Malga
Indica a ocorrência de mudança de responsabilidade
URL para redirecionamento de autenticação
URL de origem da requisição
Informações sobre o navegador do usuário
O valor do cabeçalho Accept para o navegador
O tipo de conteúdo que o navegador aceita
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
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)
ID da sessão
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 \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>' \
--data '{
"appInfo": {
"platform": {
"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {
"name": "iOS",
"version": "10.12"
},
"system": {
"name": "VTEX",
"version": "13.12"
}
},
"merchantId": "7f8870a2-71c9-4ef0-a531-82000e00b7e1",
"amount": 150,
"currency": "BRL",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"paymentMethod": {
"paymentType": "credit",
"installments": 1
},
"paymentSource": {
"sourceType": "card",
"card": {
"cardNumber": "5261424250184574",
"cardCvv": "321",
"cardExpirationDate": "06/2028",
"cardHolderName": "JOAO DA SILVA"
}
}
}'
{
"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"
}
}
}
Body
Identificação do merchant id a ser utilizado
Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00
Define o método de cobrança
Método da cobrança via Cartão Crédito/Débito/Voucher
credit
, debit
, voucher
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, usar card
para cobrança em cartão tokenizado
card
Identificador do cartão quando source tipo card
Código de verificação cobrança sem tokenização, deve ser enviado sempre que o comprador estiver presente no momento da compra (opcional)
Identificador da moeda para processamento da cobrança, formato ISO 4217.
Descrição a ser exibida fatura do comprador
Determina se a transação deve ser capturada automaticamente
Identificador único da cobrança do lado do cliente para conciliação futura
Identificador único da cobrança do lado do cliente utilizado para referenciar a cobrança do lado do adquirente/provedor. Caso não enviado a gestão dessa informação será feita pela Malga, que gera um uuid para cada requisição nova aos provedores.
Descrição da cobrança para consulta futura
Identificador de comprador para consulta futura
Parâmetros adicionais para análise de fraude, necessários para processamento com provedores específicos
Valor em Minutos de SLA máximo de Análise do Pedido, se houver
Dados do comprador
nome do usuario
email 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
Informações sobre o navegador do usuário
fingerprint gerado do navegador
indica se os cookies foram aceitados
e-mail logado no navegador
nome do host do usuário
endereço de ip do usuário
user-agent do browser
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 de 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
Detalhes do aparelho do consumidor
id do dispositivo
ID da sessão
modelo do aparelho
capacidade da memória RAM do aparelho
capacidade de armazenamento do aparelho
quantidade de memória livre
resolução do aparelho
atributos do aparelho fornecidos pelo fornecedor
aparelho possui flash
aparelho pode realizar chamadas
aparelho pode enviar sms
aparelho possui camera de video
quantidade de cpus
aparelho possui simulador
lingua do aparelho
idioma do aparelho
plataforma do sistema
nome do aparelho
família do aparelho
aparelho possui display de retina
aparelho possui camera
modelo do aparelho
aparelho possui camera frontal
Detalhes da reserva de passagem aérea
Informações sobre os passageiros
Nome do passageiro
Cartão de Milhas da empresa
Cartão de Milhas
Tipo de identidade
Número de identidade
Gênero do passageiro
male
, female
Data de nascimento do passageiro
Detalhes das conexões de voo
Companhia aérea
Número de identificação do voo
Data do voo
Classe do assento
Aeroporto de origem
Aeroporto de destino
Data de embarque
Data de chegada
Classe tarifária
Data da reserva de passagem aérea
Origem do pedido
app
, web
, telesales
, social_network
, other
Tipo de sistema operacional do cliente
Tipo de mercado
b2b
, b2c
Informações sobre o canal de compra
Última data de inserção de e-mail
Última data de alteração de senha
Última data de alteração de telefone
Última data de alteração de telefone móvel
Última data de inserção de endereço
Indica se a compra foi registrada
Endereço de e-mail do comprador
Nome de usuário do comprador
Informações da rede social do comprador
Informações sobre reservas de hotéis
Nome do hotel
Cidade do hotel
Estado do hotel
País do hotel
Data da reserva
Data de expiração da reserva
Data de check-in
Data de check-out
Parâmetros adicionais para transacionar com Split
porcentagem do valor da transação que será enviada ao recebedor
valor que será enviada ao recebedor
indica se o recebedor vinculado à regra será cobrado pelas taxas da transação
indica se o recebedor atrelado assumirá os riscos de chargeback da transação
Informações sobre as taxas que serão cobradas do recebedor - Apenas para sellers com provedor Braspag
Indica o percentual a ser descontado do valor de uma transação, definido por produto (crédito/débito/boleto), bandeira e faixa de parcelamento
Indica valor em centavos a ser cobrado por transação capturada. É descontado no momento da “montagem” da agenda financeira
Parâmetros adicionais para transacionar com vendors
Seu código de Subadquirente na respectiva bandeira. Verifique a lista de provedores suportados
Campos adicionais para uso em condicionais dos fluxos inteligentes
Campos adicionais da transação enviados na criação da mesma
Parâmetros adicionais para transacionar com 3D Secure 2
URL para redirecionamento de autenticação
URL de origem da requisição
Informações sobre o navegador do usuário
O valor do cabeçalho Accept para o navegador
O tipo de conteúdo que o navegador aceita
O Accept do cabeçalho de requisição HTTP
A profundidade de cores da tela
Se Java 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
Se javaScript está habilitado
Id da sessão de autenticação Malga, utilizado somente para 3DS2 Malga
Indica a ocorrência de mudança de responsabilidade
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
Informações sobre a rastreabilidade da cobrança
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
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
Nome do provedor de pagamento responsável pela transação
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
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
status do processamento da requisição no provider
running
, failed
, success
, timeout
, internal_error
, processing
identifica o tipo da requisição feita para o provider
pending
, authorization
, pre_authorization
, void
, capture
, probe
, charge_back
, zero_dollar
, anti_fraud
identifica se a transação foi processada usando um token externo
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
Data de criação do request feito ao provedor
Data de atualização do request feito ao provedor
Id da sessão de autenticação Malga, utilizado somente para 3DS2 Malga
Indica a ocorrência de mudança de responsabilidade
URL para redirecionamento de autenticação
URL de origem da requisição
Informações sobre o navegador do usuário
O valor do cabeçalho Accept para o navegador
O tipo de conteúdo que o navegador aceita
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
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
Was this page helpful?
curl --request POST \
--url https://api.malga.io/v1/charges \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>' \
--data '{
"appInfo": {
"platform": {
"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {
"name": "iOS",
"version": "10.12"
},
"system": {
"name": "VTEX",
"version": "13.12"
}
},
"merchantId": "7f8870a2-71c9-4ef0-a531-82000e00b7e1",
"amount": 150,
"currency": "BRL",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"paymentMethod": {
"paymentType": "credit",
"installments": 1
},
"paymentSource": {
"sourceType": "card",
"card": {
"cardNumber": "5261424250184574",
"cardCvv": "321",
"cardExpirationDate": "06/2028",
"cardHolderName": "JOAO DA SILVA"
}
}
}'
{
"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"
}
}
}