Visão Geral
Tokens
Charges
Sessions
Customers
Merchants
Vendors
Sellers
Webhooks
Reports
Realizar nova cobrança
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
Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00
Identificação do merchant id a ser utilizado
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
Identificador do cartão quando source tipo card
Tipo da origem da cobrança, usar card para cobrança em cartão tokenizado
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)
Informações sobre a rastreabilidade da cobrança
Determina se a transação deve ser capturada automaticamente
Identificador da moeda para processamento da cobrança, formato ISO 4217.
Identificador de comprador para consulta futura
Descrição da cobrança para consulta futura
Parâmetros adicionais para análise de fraude, necessários para processamento com provedores específicos
Detalhes da reserva de passagem aérea
Detalhes das conexões de voo
Data de chegada
Data de embarque
Companhia aérea
Data do voo
Aeroporto de destino
Classe tarifária
Número de identificação do voo
Aeroporto de origem
Classe do assento
Informações sobre os passageiros
Data de nascimento do passageiro
Cartão de Milhas da empresa
Gênero do passageiro
male, female Número de identidade
Tipo de identidade
Cartão de Milhas
Nome do passageiro
Data da reserva de passagem aérea
Detalhe do carrinho de produtos
Categoria a qual o item/evento pertence
Definição de data, em caso de evento
Descrição do item/evento
Definição de gênero, em caso de evento
Definição de local, em caso de evento
Definição de endereço, em caso de evento
Cidade
Complemento caso exista
Padrão ISO 3166-1 alpha-2
Bairro
Numero da rua
Estado
Nome da rua/avenida/travessa
Codigo postal CEP
nome do item/evento
quantidade de itens do pedido
definição do indice de risco do item
High, Low identificador único do item na loja
Informações relacionadas aos ingressos, em caso de evento
Lote do Ingresso
Taxa de Conveniência
Quantidade de vezes que o evento será realizado na casa
Quantidade de ingressos com valor integral
Quantidade de ingresso com desconto (meia entrada)
Quantidade total de ingressos à venda
Definição de tipo, em caso de evento
valor unitário do item/evento em centavos
Dados do comprador
Endereço de cobrança
Cidade
Complemento caso exista
Padrão ISO 3166-1 alpha-2
Bairro
Numero da rua
Estado
Nome da rua/avenida/travessa
Codigo postal CEP
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
Endereço de entrega
Cidade
Complemento caso exista
Padrão ISO 3166-1 alpha-2
Bairro
Numero da rua
Estado
Nome da rua/avenida/travessa
Codigo postal CEP
email do usuario
Número do documento formato conforme tipo selecionado
Tipo de documento, consultar tabela de tipos suportados
nome do usuario
telefone de contato do usuario
Data de registro do cliente
Detalhes do aparelho do consumidor
capacidade de armazenamento do aparelho
quantidade de memória livre
id do dispositivo
modelo do aparelho
capacidade da memória RAM do aparelho
resolução do aparelho
ID da sessão
atributos do aparelho fornecidos pelo fornecedor
aparelho possui camera
quantidade de cpus
família do aparelho
aparelho possui flash
aparelho possui camera frontal
idioma do aparelho
lingua do aparelho
modelo do aparelho
nome do aparelho
aparelho pode realizar chamadas
plataforma do sistema
aparelho possui display de retina
aparelho pode enviar sms
aparelho possui simulador
aparelho possui camera de video
Informações sobre reservas de hotéis
Data de check-in
Data de check-out
Cidade do hotel
País do hotel
Nome do hotel
Data da reserva
Data de expiração da reserva
Estado do hotel
Tipo de mercado
b2b, b2c Tipo de sistema operacional do cliente
Origem do pedido
app, web, telesales, social_network, other Informações sobre o canal de compra
Endereço de e-mail do comprador
Última data de alteração de telefone móvel
Última data de alteração de senha
Última data de alteração de telefone
Última data de inserção de endereço
Última data de inserção de e-mail
Nome de usuário do comprador
Indica se a compra foi registrada
Valor em Minutos de SLA máximo de Análise do Pedido, se houver
Informações da rede social do comprador
Identificador único da cobrança do lado do cliente para conciliação futura
Campos adicionais para uso em condicionais dos fluxos inteligentes
Campos adicionais da transação enviados na criação da mesma
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.
Parâmetros adicionais para transacionar com Split
valor que será enviada ao recebedor
Informações sobre as taxas que serão cobradas do recebedor - Apenas para sellers com provedor Braspag
Indica valor em centavos a ser cobrado por transação capturada. É descontado no momento da “montagem” da agenda financeira
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 se o recebedor atrelado assumirá os riscos de chargeback da transação
porcentagem do valor da transação que será enviada ao recebedor
indica se o recebedor vinculado à regra será cobrado pelas taxas da transação
Descrição a ser exibida fatura do comprador
Parâmetros adicionais para transacionar com 3D Secure 2
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
Endereço de ip do usuário
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
Se javaScript está habilitado
URL para redirecionamento de autenticação
URL de origem da requisição
Endereço de cobrança
Cidade
Padrão ISO 3166-1 alpha-2
Estado
Rua
Número da rua
Codigo postal CEP
Indica a ocorrência de mudança de responsabilidade
Id da sessão de autenticação Malga, utilizado somente para 3DS2 Malga
Endereço para envio
Cidade
Padrão ISO 3166-1 alpha-2
Estado
Rua
Número da rua
Codigo postal CEP
Parâmetros adicionais para transacionar com vendors
Seu código de Subadquirente na respectiva bandeira. Verifique a lista de provedores suportados
Response
valor da transação em centavos, exemplo 100 para cobrar R$ 1,00
Informações sobre a rastreabilidade da cobrança
determina se a transação deve ser capturada automaticamente
identificador do cliente na Malga
Data de criação do cartão
Identificador da moeda para processamento da cobrança, formato ISO 4217.
identificador do customer id
Descrição da cobrança para consulta futura
Parâmetros adicionais para analise de fraude
Detalhe do carrinho de produtos
Categoria a qual o item/evento pertence
Definição de data, em caso de evento
Descrição do item/evento
Definição do gênero, em caso de evento
Definição de local, em caso de evento
Definição de endereço, em caso de evento
Cidade
Complemento caso exista
Padrão ISO 3166-1 alpha-2
Bairro
Numero da rua
Estado
Nome da rua/avenida/travessa
Codigo postal CEP
nome do item/evento
quantidade de itens do pedido
definição do indice de risco do item
High, Low identificador único do item na loja
Informações relacionadas aos ingressos, em caso de evento
Lote do Ingresso
Taxa de Conveniência
Quantidade de vezes que o evento será realizado na casa
Quantidade de ingressos com valor integral
Quantidade de ingresso com desconto (meia entrada)
Quantidade total de ingressos à venda
Definição de tipo, em caso de evento
valor unitário do item/evento em centavos
Dados do comprador
Endereço de cobrança
Cidade
Complemento caso exista
Padrão ISO 3166-1 alpha-2
Bairro
Numero da rua
Estado
Nome da rua/avenida/travessa
Codigo postal CEP
Endereço de entrega
Cidade
Complemento caso exista
Padrão ISO 3166-1 alpha-2
Bairro
Numero da rua
Estado
Nome da rua/avenida/travessa
Codigo postal CEP
E-mail do usuario
Número do documento formato conforme tipo selecionado
Tipo de documento, consultar tabela de tipos suportados
Nome do usuario
Telefone de contato do usuario
Data de registro do cliente
Valor em Minutos de SLA máximo de Análise do Pedido, se houver
identificador da transação
determina se a transação está em disputa
identificador do merchant id utilizado na transação
Identificador único da cobrança do lado do cliente para conciliação futura
valor da transação em centavos, exemplo 100 para cobrar R$ 1,00
Campos adicionais para uso em condicionais dos fluxos inteligentes
Campos adicionais da transação enviados na criação da mesma
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 Nome do provedor de pagamento responsável pela transação
descrição a ser exibida na fatura do comprador
status da transação na Malga
pending, pre_authorized, authorized, failed, canceled, voided, charged_back, refund_pending, capture_pending Dados de autenticação do provedor
Tipo de ação exigida pelo provedor
REDIRECT Nome do provedor
ADYEN O object retornado do provedor com dados para autenticação ou autorização
Identifica a etapa do desafio
AUTHENTICATION, AUTHORIZATION Endereço de cobrança
Cidade
Padrão ISO 3166-1 alpha-2
Estado
Rua
Número da rua
Codigo postal CEP
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
Endereço de ip do usuário
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
URL para redirecionamento de autenticação
URL de origem da requisição
Indica a ocorrência de mudança de responsabilidade
Id da sessão de autenticação Malga, utilizado somente para 3DS2 Malga
Endereço para envio
Cidade
Padrão ISO 3166-1 alpha-2
Estado
Rua
Número da rua
Codigo postal CEP
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
identificador único da transação retornado pelo provider
Data de criação do request feito ao provedor
identificador único do request feito ao provedor
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.
dados adicionais do retorno da autorização do provider no processamento da transação
detalhes do erro em caso de falha no processamento da transação
codigo de erro mapeado pela Malga com base no tipo de erro apresentado pelo provedor
mensagem de erro mapeado pela Malga que descreve o motivo de rejeição retornad
mensagem de erro retornado pelo provider, consultar o provedor
código retornado pelo provider que identitifica o motivo da rejeição, consultar o provedor
identifica se o tipo de erro permite ou não retentativa
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
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 tempo de duração do processamento da requisição no provider
identifica se a transação foi processada usando um token externo
identificador único da transação retornado pelo provider, txId, pode ser usado para recuperar a transação nas APIs ou dashboard do provedor
Data de atualização do request feito ao provedor
Data de atualização do cartão
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"
}
}
}