curl --request POST \
--url https://api.malga.io/v1/charges/{id} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>' \
--data '
{
"status": "pending"
}
'{
"id": "<string>",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"amount": 123,
"originalAmount": 123,
"currency": "BRL",
"statementDescriptor": "<string>",
"capture": true,
"isDispute": true,
"status": "pending",
"orderId": "<string>",
"responsibleProviderType": "<string>",
"paymentMethod": {
"paymentType": "credit",
"installments": 123,
"recurrence": "initial",
"threeDS": {
"enabled": true,
"liabilityShiftRequired": true
}
},
"paymentSource": {
"sourceType": "card",
"cardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"fraudAnalysisMetadata": {
"sla": 123,
"customer": {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"identityType": "<string>",
"identity": "<string>",
"registrationDate": "<string>",
"deliveryAddress": {
"country": "<string>",
"state": "<string>",
"city": "<string>",
"district": "<string>",
"zipCode": "<string>",
"street": "<string>",
"number": "<string>",
"complement": "<string>"
},
"billingAddress": {
"country": "<string>",
"state": "<string>",
"city": "<string>",
"district": "<string>",
"zipCode": "<string>",
"street": "<string>",
"number": "<string>",
"complement": "<string>"
}
},
"cart": {
"items": [
{
"name": "<string>",
"quantity": 123,
"sku": "<string>",
"unitPrice": 123,
"risk": "High",
"description": "<string>",
"categoryId": "<string>",
"locality": "<string>",
"date": "<string>",
"type": 123,
"genre": "<string>",
"tickets": {
"quantityTicketSale": 123,
"quantityEventHouse": 123,
"convenienceFeeValue": 123,
"quantityFull": 123,
"quantityHalf": 123,
"batch": 123
},
"location": {
"country": "<string>",
"state": "<string>",
"city": "<string>",
"district": "<string>",
"zipCode": "<string>",
"street": "<string>",
"number": "<string>",
"complement": "<string>"
}
}
]
}
},
"paymentFlow": {
"metadata": {}
},
"transactionRequests": [
{
"id": "<string>",
"providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerType": "<string>",
"idempotencyKey": "<string>",
"authorizationNsu": "<string>",
"transactionId": "<string>",
"requestStatus": "running",
"requestType": "pending",
"tokenizedPayment": true,
"amount": 123,
"responseTs": "<string>",
"providerError": {
"message": "<string>",
"declinedCode": "<string>",
"retryable": true,
"networkDeniedReason": "<string>",
"networkDeniedMessage": "<string>"
},
"providerAuthorization": {
"networkAuthorizationCode": "<string>",
"networkResponseCode": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"threeDSecure2": {
"setupId": "<string>",
"dataOnly": true,
"requiresLiabilityShift": true,
"redirectURL": "<string>",
"requestorURL": "<string>",
"browser": {
"acceptBrowserValue": "<string>",
"acceptContent": "<string>",
"acceptHeader": "<string>",
"colorDepth": 123,
"javaEnabled": true,
"javaScriptEnabled": true,
"language": "<string>",
"screenHeight": 123,
"screenWidth": 123,
"timeZoneOffset": "<string>",
"userAgent": "<string>",
"ip": "<string>"
},
"billingAddress": {
"city": "<string>",
"country": "<string>",
"streetNumber": "<string>",
"zipCode": "<string>",
"state": "<string>",
"street": "<string>"
},
"shippingAddress": {
"city": "<string>",
"country": "<string>",
"streetNumber": "<string>",
"zipCode": "<string>",
"state": "<string>",
"street": "<string>"
},
"cardHolder": {
"email": "<string>",
"mobilePhone": "<string>"
},
"authData": {
"action": "REDIRECT",
"providerType": "ADYEN",
"responseType": "AUTHENTICATION",
"response": {}
}
},
"appInfo": {
"platform": {
"name": "<string>",
"version": "<string>",
"integrator": "<string>"
},
"device": {
"name": "<string>",
"version": "<string>",
"sessionId": "<string>"
},
"system": {
"name": "<string>",
"version": "<string>"
}
},
"splitRules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"sellerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"percentage": 123,
"amount": 123,
"processingFee": true,
"chargeEntireFee": true,
"chargeRemainderFee": true,
"fareFee": true,
"fareMdr": 123
}
]
}curl --request POST \
--url https://api.malga.io/v1/charges/{id} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>' \
--data '
{
"status": "pending"
}
'{
"id": "<string>",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"amount": 123,
"originalAmount": 123,
"currency": "BRL",
"statementDescriptor": "<string>",
"capture": true,
"isDispute": true,
"status": "pending",
"orderId": "<string>",
"responsibleProviderType": "<string>",
"paymentMethod": {
"paymentType": "credit",
"installments": 123,
"recurrence": "initial",
"threeDS": {
"enabled": true,
"liabilityShiftRequired": true
}
},
"paymentSource": {
"sourceType": "card",
"cardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"fraudAnalysisMetadata": {
"sla": 123,
"customer": {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"identityType": "<string>",
"identity": "<string>",
"registrationDate": "<string>",
"deliveryAddress": {
"country": "<string>",
"state": "<string>",
"city": "<string>",
"district": "<string>",
"zipCode": "<string>",
"street": "<string>",
"number": "<string>",
"complement": "<string>"
},
"billingAddress": {
"country": "<string>",
"state": "<string>",
"city": "<string>",
"district": "<string>",
"zipCode": "<string>",
"street": "<string>",
"number": "<string>",
"complement": "<string>"
}
},
"cart": {
"items": [
{
"name": "<string>",
"quantity": 123,
"sku": "<string>",
"unitPrice": 123,
"risk": "High",
"description": "<string>",
"categoryId": "<string>",
"locality": "<string>",
"date": "<string>",
"type": 123,
"genre": "<string>",
"tickets": {
"quantityTicketSale": 123,
"quantityEventHouse": 123,
"convenienceFeeValue": 123,
"quantityFull": 123,
"quantityHalf": 123,
"batch": 123
},
"location": {
"country": "<string>",
"state": "<string>",
"city": "<string>",
"district": "<string>",
"zipCode": "<string>",
"street": "<string>",
"number": "<string>",
"complement": "<string>"
}
}
]
}
},
"paymentFlow": {
"metadata": {}
},
"transactionRequests": [
{
"id": "<string>",
"providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerType": "<string>",
"idempotencyKey": "<string>",
"authorizationNsu": "<string>",
"transactionId": "<string>",
"requestStatus": "running",
"requestType": "pending",
"tokenizedPayment": true,
"amount": 123,
"responseTs": "<string>",
"providerError": {
"message": "<string>",
"declinedCode": "<string>",
"retryable": true,
"networkDeniedReason": "<string>",
"networkDeniedMessage": "<string>"
},
"providerAuthorization": {
"networkAuthorizationCode": "<string>",
"networkResponseCode": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"threeDSecure2": {
"setupId": "<string>",
"dataOnly": true,
"requiresLiabilityShift": true,
"redirectURL": "<string>",
"requestorURL": "<string>",
"browser": {
"acceptBrowserValue": "<string>",
"acceptContent": "<string>",
"acceptHeader": "<string>",
"colorDepth": 123,
"javaEnabled": true,
"javaScriptEnabled": true,
"language": "<string>",
"screenHeight": 123,
"screenWidth": 123,
"timeZoneOffset": "<string>",
"userAgent": "<string>",
"ip": "<string>"
},
"billingAddress": {
"city": "<string>",
"country": "<string>",
"streetNumber": "<string>",
"zipCode": "<string>",
"state": "<string>",
"street": "<string>"
},
"shippingAddress": {
"city": "<string>",
"country": "<string>",
"streetNumber": "<string>",
"zipCode": "<string>",
"state": "<string>",
"street": "<string>"
},
"cardHolder": {
"email": "<string>",
"mobilePhone": "<string>"
},
"authData": {
"action": "REDIRECT",
"providerType": "ADYEN",
"responseType": "AUTHENTICATION",
"response": {}
}
},
"appInfo": {
"platform": {
"name": "<string>",
"version": "<string>",
"integrator": "<string>"
},
"device": {
"name": "<string>",
"version": "<string>",
"sessionId": "<string>"
},
"system": {
"name": "<string>",
"version": "<string>"
}
},
"splitRules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"sellerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"percentage": 123,
"amount": 123,
"processingFee": true,
"chargeEntireFee": true,
"chargeRemainderFee": true,
"fareFee": true,
"fareMdr": 123
}
]
}id da cobrança que deseja alterar no sandbox
status da transação
pending, pre_authorized, authorized, failed, canceled, voided, charged_back, created, processed, refund_pending, capture_pending Success
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
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 dados para cobrança por cartão de crédito salve
Data de criação do cartão
Data de atualização do cartão
Parâmetros adicionais para analise de fraude
Show child attributes
Valor em Minutos de SLA máximo de Análise do Pedido, se houver
Dados do comprador
Show child attributes
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
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
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
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 do gênero, em caso de evento
Informações relacionadas aos ingressos, em caso de evento
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
Padrão ISO 3166-1 alpha-2
Estado
Cidade
Bairro
Codigo postal CEP
Nome da rua/avenida/travessa
Numero da rua
Complemento caso exista
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
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
Show child attributes
Id da sessão de autenticação Malga, utilizado somente para 3DS2 Malga
Indica se a transação foi processada apenas para coleta de dados 3DS
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
Show child attributes
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
Show child attributes
Cidade
Padrão ISO 3166-1 alpha-2
Número da rua
Codigo postal CEP
Estado
Rua
Endereço para envio
Show child attributes
Cidade
Padrão ISO 3166-1 alpha-2
Número da rua
Codigo postal CEP
Estado
Rua
Dados de autenticação do provedor
Show child attributes
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
Show child attributes
Parâmetros adicionais para transacionar com Split
Show child attributes
identificador da regra de split
data de criação da regra de split
porcentagem do valor da transação que será enviada ao recebedor
valor que será enviado ao recebedor
indica se o recebedor vinculado à regra será cobrado pelas taxas da transação
indica se o recebedor será cobrado pela taxa inteira da transação
indica se o recebedor será cobrado pela taxa restante da transação
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
Was this page helpful?