Visão Geral
Tokens
Charges
Sessions
Subscriptions
- POSTCriação de uma nova assinaturaBETA
- GETListagem de assinaturasBETA
- GETRecuperar detalhes de assinaturaBETA
- GETListar cycles de uma assinaturaBETA
- GETRecuperar detalhes de um cycle específicoBETA
- PUTAtualizar assinaturaBETA
- PATCHCancelar assinaturaBETA
- PATCHPausar assinaturaBETA
- PATCHReativar assinaturaBETA
- PATCHAtualizar configurações do clienteBETA
- GETObter configurações do clienteBETA
Customers
Merchants
Vendors
Sellers
Webhooks
Reports
curl --request POST \
--url https://api.malga.io/v1/sessions/{id}/charge \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>' \
--data '
{
"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",
"merchantId": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"description": "Descrição longa da cobrança",
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"originalAmount": 150,
"currency": "BRL",
"statementDescriptor": "LOJA JOAO",
"status": "pending",
"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": ""
}
}
]
}Pagar uma sessão
curl --request POST \
--url https://api.malga.io/v1/sessions/{id}/charge \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>' \
--data '
{
"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",
"merchantId": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"description": "Descrição longa da cobrança",
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"originalAmount": 150,
"currency": "BRL",
"statementDescriptor": "LOJA JOAO",
"status": "pending",
"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": ""
}
}
]
}Path Parameters
Identificação da sessão a ser paga
Body
Define o método de cobrança
- Cartão
- Pix
- Boleto
- Option 4
- Option 5
Show child attributes
Show child attributes
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
- Cartão tokenizado
- Cartão one shot
- Token
- Cartão com Customer
- Cartão com Customer one shot
Show child attributes
Show child attributes
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 de comprador para consulta futura
Parâmetros adicionais para análise de fraude. Alguns destes campos podem ser necessários para processar com provedores específicos.
Show child attributes
Show child attributes
Valor em Minutos de SLA máximo de Análise do Pedido, se houver
Dados do comprador
Show child attributes
Show child attributes
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
Estado civil do usuario
Nível de escolaridade do usuario
Data de registro do cliente
Endereço de entrega
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
Informações sobre os passageiros
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
Ú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
Show child attributes
Show child attributes
Informações sobre reservas de hotéis
Show child attributes
Show child attributes
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
Response
Created
Identificador da transação
Identificador do cliente na Malga
Identificador do merchant id utilizado na transação
Descrição da cobrança para consulta futura
Identificador único da cobrança do lado do cliente para conciliação futura
Data de criação do cartão
Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00
Valor original 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
Status da sessão
created, paid, canceled, voided - Cartão de crédito
- Pix
- Boleto
- Option 4
- NuPay
Show child attributes
Show child attributes
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 Show child attributes
Show child attributes
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, dispute 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
Show child attributes
Show child attributes
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
Was this page helpful?