- 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
Tokens
Charges
Sessions
Merchants
Customers
Webhooks
Sellers
Recuperar detalhes de uma sessão
Identificação da sessão a ser recuperada
curl --request GET \
--url https://api.malga.io/v1/sessions/{id} \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'
{
"properties": {
"id": {
"type": "string",
"description": "Identificação da sessão"
},
"name": {
"type": "string",
"description": "Nome que identifica a sessão"
},
"status": {
"type": "string",
"enum": [
"created",
"paid",
"canceled",
"voided"
],
"description": "Status da sessão"
},
"isActive": {
"type": "boolean",
"description": "Determina se a sessão está ativa"
},
"clientId": {
"type": "string",
"description": "Identificador do cliente na Malga"
},
"orderId": {
"type": "string",
"description": "Identificador único da cobrança do lado do cliente para conciliação futura"
},
"amount": {
"type": "number",
"description": "Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00"
},
"currency": {
"type": "string",
"description": "Identificador da moeda para processamento da cobrança, formato ISO 4217."
},
"capture": {
"type": "boolean",
"description": "Determina se a transação deve ser capturada automaticamente"
},
"merchantId": {
"type": "string",
"description": "Identificação do merchant id a ser utilizado"
},
"dueDate": {
"type": "string",
"description": "Data de expiração de uma sessão"
},
"description": {
"type": "string",
"description": "Descrição da sessão"
},
"statementDescriptor": {
"type": "string",
"description": "Descrição a ser exibida fatura do comprador"
},
"items": {
"type": "array",
"description": "Itens do pedido",
"items": {
"properties": {
"name": {
"type": "string",
"description": "Nome do item da sessão"
},
"description": {
"type": "string",
"description": "Descrição do item da sessão"
},
"unitPrice": {
"type": "number",
"description": "Preço unitário em centavos do item, exemplo 100 para cobrar R$ 1,00"
},
"quantity": {
"type": "number",
"description": "Define a quantidade de itens"
},
"tangible": {
"type": "boolean",
"description": "Determina se o item é tangível"
}
}
}
},
"paymentLink": {
"type": "string",
"description": "Link para acessar o Link de Pagamento desta sessão"
},
"paymentMethods": {
"type": "array",
"description": "Métodos de pagamento disponíveis na sessão",
"items": {
"anyOf": [
{
"title": "Cartão de crédito",
"type": "object",
"properties": {
"paymentType": {
"type": "string",
"enum": [
"credit",
"debit"
],
"description": "método da cobrança via Cartão Crédito/Débito"
},
"installments": {
"type": "number",
"description": "quantidade de parcelas para cobrança do tipo credito"
},
"recurrence": {
"type": "string",
"enum": [
"initial",
"subsequent",
"unscheduled"
],
"description": "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)."
}
},
"required": [
"paymentType"
]
},
{
"title": "Pix",
"properties": {
"paymentType": {
"type": "string",
"enum": [
"pix"
],
"description": "método da cobrança via PIX, o source deve ser um customer válido."
},
"expiresIn": {
"type": "number",
"description": "tempo em segundos que define a validade da cobrança."
},
"qrCodeData": {
"type": "string",
"description": "código copia e cola para o QR code dinâmico gerado, pronto para ser pago."
},
"qrCodeImageUrl": {
"type": "string",
"description": "link para download da imagem do QR code dinâmico gerado, pronto para ser scaneado e pago."
}
},
"required": [
"paymentType",
"expiresIn",
"qrCodeData",
"qrCodeImageUrl"
]
},
{
"title": "Boleto",
"properties": {
"paymentType": {
"type": "string",
"enum": [
"boleto"
],
"description": "método da cobrança via Boleto, o source deve ser um customer válido"
},
"expiresDate": {
"type": "string",
"description": "data de vencimento do boleto em ISO-Date, ex 2017-01-31",
"default": "7 dias contados da data atual"
},
"barcodeData": {
"type": "string",
"description": "código copia e cola do boleto registrado gerado, pronto para pagamento;"
},
"barcodeImageUrl": {
"type": "string",
"description": "link para download do do boleto registrado gerado, pronto para pagamento;"
}
},
"required": [
"paymentType",
"expiresDate",
"barcodeData",
"barcodeImageUrl"
]
},
{
"title": "Drip",
"type": "object",
"properties": {
"paymentType": {
"type": "string",
"enum": [
"drip"
],
"description": "método da cobrança via Drip"
},
"cancelRedirectUrl": {
"type": "string",
"description": "Link de redirecionamento em caso de cancelamento do pagamento no ambiente de checkout da Drip"
},
"successRedirectUrl": {
"type": "string",
"description": "Link de redirecionamento em caso de aprovação do pagamento no ambiente de checkout da Drip"
}
},
"required": [
"paymentType"
]
},
{
"title": "NuPay",
"type": "object",
"properties": {
"paymentType": {
"type": "string",
"enum": [
"nupay"
],
"description": "Método da cobrança via Nupay"
},
"orderUrl": {
"type": "string",
"description": "URL da cobrança"
},
"delayToAutoCancel": {
"type": "string",
"description": "Tempo em minutos para a expiração de uma cobrança criada que não tenha sido paga"
},
"returnUrl": {
"type": "string",
"description": "URL para a qual o cliente será redirecionado após finalizar o pagamento"
},
"cancelUrl": {
"type": "string",
"description": "URL para onde o cliente será direcionado caso escolha não finalizar o pagamento e cancele o pedido"
}
},
"required": [
"paymentType"
]
}
]
}
},
"createdAt": {
"type": "string",
"description": "Data de criação da sessão"
},
"updatedAt": {
"type": "string",
"description": "Data da atualização da sessão"
},
"publicKey": {
"type": "string",
"description": "Chave de acesso com escopo restrito, usada para pagar a sessão"
}
},
"example": {
"id": "c1db83fa-723c-4e1f-9722-bc19d1be6791",
"name": "Pedido 1",
"status": "created",
"isActive": true,
"clientId": "39d2d314-5412-431a-b34b-74f9f0fbe7e1",
"orderId": "b84b7694-d22f-4083-bee7-c1274b16eb4a",
"amount": 100,
"currency": "BRL",
"capture": true,
"merchantId": "9930c8d9-a7a8-4039-9faf-3715ad87baf8",
"dueDate": "2022-10-26T19:32:08.000Z",
"description": "Pedido Black Friday",
"statementDescriptor": "LOJA JOAO",
"items": [
{
"name": "Item 1",
"description": "Item do carrinho",
"unitPrice": 1000,
"quantity": 1,
"tangible": false
}
],
"paymentLink": "https://link.malga.io/7648b72d-a79f-43e1-843d-eb0133bd2438",
"paymentMethods": [
{
"paymentType": "pix",
"expiresIn": 30
}
],
"createdAt": "2022-10-25T22:49:06.588Z",
"updatedAt": "2022-10-25T22:49:06.588Z",
"publicKey": "8be71cdf-01dc-4b1a-823a-4c58be6e4cf1"
}
}
Authorizations
Path Parameters
Identificação da sessão a ser recuperada
Response
Identificação da sessão
Nome que identifica a sessão
Status da sessão
created
, paid
, canceled
, voided
Determina se a sessão está ativa
Identificador do cliente na Malga
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
Identificador da moeda para processamento da cobrança, formato ISO 4217.
Determina se a transação deve ser capturada automaticamente
Identificação do merchant id a ser utilizado
Data de expiração de uma sessão
Descrição da sessão
Descrição a ser exibida fatura do comprador
Itens do pedido
Nome do item da sessão
Descrição do item da sessão
Preço unitário em centavos do item, exemplo 100 para cobrar R$ 1,00
Define a quantidade de itens
Determina se o item é tangível
Link para acessar o Link de Pagamento desta sessão
Métodos de pagamento disponíveis na sessã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 da sessão
Data da atualização da sessão
Chave de acesso com escopo restrito, usada para pagar a sessão
curl --request GET \
--url https://api.malga.io/v1/sessions/{id} \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'
{
"properties": {
"id": {
"type": "string",
"description": "Identificação da sessão"
},
"name": {
"type": "string",
"description": "Nome que identifica a sessão"
},
"status": {
"type": "string",
"enum": [
"created",
"paid",
"canceled",
"voided"
],
"description": "Status da sessão"
},
"isActive": {
"type": "boolean",
"description": "Determina se a sessão está ativa"
},
"clientId": {
"type": "string",
"description": "Identificador do cliente na Malga"
},
"orderId": {
"type": "string",
"description": "Identificador único da cobrança do lado do cliente para conciliação futura"
},
"amount": {
"type": "number",
"description": "Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00"
},
"currency": {
"type": "string",
"description": "Identificador da moeda para processamento da cobrança, formato ISO 4217."
},
"capture": {
"type": "boolean",
"description": "Determina se a transação deve ser capturada automaticamente"
},
"merchantId": {
"type": "string",
"description": "Identificação do merchant id a ser utilizado"
},
"dueDate": {
"type": "string",
"description": "Data de expiração de uma sessão"
},
"description": {
"type": "string",
"description": "Descrição da sessão"
},
"statementDescriptor": {
"type": "string",
"description": "Descrição a ser exibida fatura do comprador"
},
"items": {
"type": "array",
"description": "Itens do pedido",
"items": {
"properties": {
"name": {
"type": "string",
"description": "Nome do item da sessão"
},
"description": {
"type": "string",
"description": "Descrição do item da sessão"
},
"unitPrice": {
"type": "number",
"description": "Preço unitário em centavos do item, exemplo 100 para cobrar R$ 1,00"
},
"quantity": {
"type": "number",
"description": "Define a quantidade de itens"
},
"tangible": {
"type": "boolean",
"description": "Determina se o item é tangível"
}
}
}
},
"paymentLink": {
"type": "string",
"description": "Link para acessar o Link de Pagamento desta sessão"
},
"paymentMethods": {
"type": "array",
"description": "Métodos de pagamento disponíveis na sessão",
"items": {
"anyOf": [
{
"title": "Cartão de crédito",
"type": "object",
"properties": {
"paymentType": {
"type": "string",
"enum": [
"credit",
"debit"
],
"description": "método da cobrança via Cartão Crédito/Débito"
},
"installments": {
"type": "number",
"description": "quantidade de parcelas para cobrança do tipo credito"
},
"recurrence": {
"type": "string",
"enum": [
"initial",
"subsequent",
"unscheduled"
],
"description": "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)."
}
},
"required": [
"paymentType"
]
},
{
"title": "Pix",
"properties": {
"paymentType": {
"type": "string",
"enum": [
"pix"
],
"description": "método da cobrança via PIX, o source deve ser um customer válido."
},
"expiresIn": {
"type": "number",
"description": "tempo em segundos que define a validade da cobrança."
},
"qrCodeData": {
"type": "string",
"description": "código copia e cola para o QR code dinâmico gerado, pronto para ser pago."
},
"qrCodeImageUrl": {
"type": "string",
"description": "link para download da imagem do QR code dinâmico gerado, pronto para ser scaneado e pago."
}
},
"required": [
"paymentType",
"expiresIn",
"qrCodeData",
"qrCodeImageUrl"
]
},
{
"title": "Boleto",
"properties": {
"paymentType": {
"type": "string",
"enum": [
"boleto"
],
"description": "método da cobrança via Boleto, o source deve ser um customer válido"
},
"expiresDate": {
"type": "string",
"description": "data de vencimento do boleto em ISO-Date, ex 2017-01-31",
"default": "7 dias contados da data atual"
},
"barcodeData": {
"type": "string",
"description": "código copia e cola do boleto registrado gerado, pronto para pagamento;"
},
"barcodeImageUrl": {
"type": "string",
"description": "link para download do do boleto registrado gerado, pronto para pagamento;"
}
},
"required": [
"paymentType",
"expiresDate",
"barcodeData",
"barcodeImageUrl"
]
},
{
"title": "Drip",
"type": "object",
"properties": {
"paymentType": {
"type": "string",
"enum": [
"drip"
],
"description": "método da cobrança via Drip"
},
"cancelRedirectUrl": {
"type": "string",
"description": "Link de redirecionamento em caso de cancelamento do pagamento no ambiente de checkout da Drip"
},
"successRedirectUrl": {
"type": "string",
"description": "Link de redirecionamento em caso de aprovação do pagamento no ambiente de checkout da Drip"
}
},
"required": [
"paymentType"
]
},
{
"title": "NuPay",
"type": "object",
"properties": {
"paymentType": {
"type": "string",
"enum": [
"nupay"
],
"description": "Método da cobrança via Nupay"
},
"orderUrl": {
"type": "string",
"description": "URL da cobrança"
},
"delayToAutoCancel": {
"type": "string",
"description": "Tempo em minutos para a expiração de uma cobrança criada que não tenha sido paga"
},
"returnUrl": {
"type": "string",
"description": "URL para a qual o cliente será redirecionado após finalizar o pagamento"
},
"cancelUrl": {
"type": "string",
"description": "URL para onde o cliente será direcionado caso escolha não finalizar o pagamento e cancele o pedido"
}
},
"required": [
"paymentType"
]
}
]
}
},
"createdAt": {
"type": "string",
"description": "Data de criação da sessão"
},
"updatedAt": {
"type": "string",
"description": "Data da atualização da sessão"
},
"publicKey": {
"type": "string",
"description": "Chave de acesso com escopo restrito, usada para pagar a sessão"
}
},
"example": {
"id": "c1db83fa-723c-4e1f-9722-bc19d1be6791",
"name": "Pedido 1",
"status": "created",
"isActive": true,
"clientId": "39d2d314-5412-431a-b34b-74f9f0fbe7e1",
"orderId": "b84b7694-d22f-4083-bee7-c1274b16eb4a",
"amount": 100,
"currency": "BRL",
"capture": true,
"merchantId": "9930c8d9-a7a8-4039-9faf-3715ad87baf8",
"dueDate": "2022-10-26T19:32:08.000Z",
"description": "Pedido Black Friday",
"statementDescriptor": "LOJA JOAO",
"items": [
{
"name": "Item 1",
"description": "Item do carrinho",
"unitPrice": 1000,
"quantity": 1,
"tangible": false
}
],
"paymentLink": "https://link.malga.io/7648b72d-a79f-43e1-843d-eb0133bd2438",
"paymentMethods": [
{
"paymentType": "pix",
"expiresIn": 30
}
],
"createdAt": "2022-10-25T22:49:06.588Z",
"updatedAt": "2022-10-25T22:49:06.588Z",
"publicKey": "8be71cdf-01dc-4b1a-823a-4c58be6e4cf1"
}
}