Sessions
Recupera sessão com os dados das configurações da empresa
Visão Geral
Tokens
Charges
Sessions
Customers
Merchants
Vendors
Sellers
Webhooks
Reports
Sessions
Recupera sessão com os dados das configurações da empresa
GET
/
v1
/
sessions
/
{id}
/
link
curl --request GET \
--url https://api.malga.io/v1/sessions/{id}/link \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'
{
"properties": {
"id": {
"type": "string",
"description": "Identificação da sessão a ser utilizada"
},
"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"
}
},
"required": [
"paymentType",
"expiresDate"
]
},
{
"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"
},
"settings": {
"allOf": [
{
"type": "object"
},
{
"description": "Configurações da empresa"
},
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Identificador das configurações da empresa"
},
"logo": {
"type": "string",
"format": "uri",
"description": "URL do logo da empresa"
},
"mainColor": {
"type": "string",
"description": "Cor primária"
},
"secondaryColor": {
"type": "string",
"description": "Cor secundária"
},
"attentionColor": {
"type": "string",
"description": "Cor utilizada para alertas"
},
"errorColor": {
"type": "string",
"description": "Cor utilizada para as mensagens de erro"
},
"successColor": {
"type": "string",
"description": "Cor utilizada nas mensagens de sucesso"
},
"backgroundColor": {
"type": "string",
"description": "Cor de fundo"
},
"clientId": {
"type": "string",
"description": "Identificador do cliente na Malga"
},
"companyUrl": {
"type": "string",
"description": "Url que deve ser utilizada no link de pagamento. Ex: https://www.company.com"
}
}
}
]
}
},
"example": {
"id": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"name": "Nome da sessão",
"status": "created",
"isActive": true,
"clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"orderId": null,
"amount": 100,
"currency": "BRL",
"capture": true,
"merchantId": "69aea152-ba70-49a3-a31c-044ac1651146",
"dueDate": "2022-10-25T09:28:45.000Z",
"description": "Promoção Black Friday",
"statementDescriptor": "LOJA JOAO",
"paymentMethods": [
{
"paymentType": "credit",
"installments": 1
}
],
"items": [
{
"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"name": "Item 1",
"description": "Descrição do item",
"unitPrice": 10000,
"quantity": 1,
"tangible": false
}
],
"createdAt": "2022-10-25T09:28:45.000Z",
"updatedAt": "2022-10-25T09:28:45.000Z",
"publicKey": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"settings": {
"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"email": "company@email.com",
"phone": "5551996225566",
"statementDescription": "LOJA JOAO",
"logo": "https://logo.com/images/logo.png",
"mainColor": "#fff000",
"secondaryColor": "#fff000",
"attentionColor": "#333333",
"errorColor": "#ff0000",
"successColor": "#00FF00",
"backgroundColor": "#fff000",
"companyName": "Company Name",
"clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"documentNumber": "011001001001000010",
"language": "pt_BR"
}
}
}
Path Parameters
Identificação da sessão a ser recuperada
Response
201 - application/json
Created
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.malga.io/v1/sessions/{id}/link \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'
{
"properties": {
"id": {
"type": "string",
"description": "Identificação da sessão a ser utilizada"
},
"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"
}
},
"required": [
"paymentType",
"expiresDate"
]
},
{
"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"
},
"settings": {
"allOf": [
{
"type": "object"
},
{
"description": "Configurações da empresa"
},
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Identificador das configurações da empresa"
},
"logo": {
"type": "string",
"format": "uri",
"description": "URL do logo da empresa"
},
"mainColor": {
"type": "string",
"description": "Cor primária"
},
"secondaryColor": {
"type": "string",
"description": "Cor secundária"
},
"attentionColor": {
"type": "string",
"description": "Cor utilizada para alertas"
},
"errorColor": {
"type": "string",
"description": "Cor utilizada para as mensagens de erro"
},
"successColor": {
"type": "string",
"description": "Cor utilizada nas mensagens de sucesso"
},
"backgroundColor": {
"type": "string",
"description": "Cor de fundo"
},
"clientId": {
"type": "string",
"description": "Identificador do cliente na Malga"
},
"companyUrl": {
"type": "string",
"description": "Url que deve ser utilizada no link de pagamento. Ex: https://www.company.com"
}
}
}
]
}
},
"example": {
"id": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"name": "Nome da sessão",
"status": "created",
"isActive": true,
"clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"orderId": null,
"amount": 100,
"currency": "BRL",
"capture": true,
"merchantId": "69aea152-ba70-49a3-a31c-044ac1651146",
"dueDate": "2022-10-25T09:28:45.000Z",
"description": "Promoção Black Friday",
"statementDescriptor": "LOJA JOAO",
"paymentMethods": [
{
"paymentType": "credit",
"installments": 1
}
],
"items": [
{
"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"name": "Item 1",
"description": "Descrição do item",
"unitPrice": 10000,
"quantity": 1,
"tangible": false
}
],
"createdAt": "2022-10-25T09:28:45.000Z",
"updatedAt": "2022-10-25T09:28:45.000Z",
"publicKey": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"settings": {
"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"email": "company@email.com",
"phone": "5551996225566",
"statementDescription": "LOJA JOAO",
"logo": "https://logo.com/images/logo.png",
"mainColor": "#fff000",
"secondaryColor": "#fff000",
"attentionColor": "#333333",
"errorColor": "#ff0000",
"successColor": "#00FF00",
"backgroundColor": "#fff000",
"companyName": "Company Name",
"clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"documentNumber": "011001001001000010",
"language": "pt_BR"
}
}
}