Skip to main content
GET
/
v1
/
sessions
/
{id}
/
link
Recupera sessão com os dados das configurações da empresa
curl --request GET \
  --url https://api.malga.io/v1/sessions/{id}/link \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>'
{
  "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",
  "multiplePayments": {
    "allow": true,
    "maxPayments": 5,
    "paymentCount": 1,
    "pendingCount": 0,
    "status": "active"
  },
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.malga.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Client-Id
string
header
required
​
X-Api-Key
string
header
required

Path Parameters

​
id
string<uuid>
required

Identificação da sessão a ser recuperada

Response

201 - application/json

Created

​
id
string

Identificação da sessão a ser utilizada

​
name
string

Nome que identifica a sessão

​
status
enum<string>

Status da sessão

Available options:
created,
paid,
canceled,
voided
​
isActive
boolean

Determina se a sessão está ativa

​
clientId
string

Identificador do cliente na Malga

​
orderId
string

Identificador único da cobrança do lado do cliente para conciliação futura

​
amount
number

Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

​
currency
string

Identificador da moeda para processamento da cobrança, formato ISO 4217.

​
capture
boolean

Determina se a transação deve ser capturada automaticamente

​
merchantId
string

Identificação do merchant id a ser utilizado

​
dueDate
string | null

Data limite da sessão, em ISO 8601. Pode estar ausente quando a sessão foi criada sem data de vencimento.

​
description
string

Descrição da sessão

​
statementDescriptor
string

Descrição a ser exibida fatura do comprador

​
items
object[]

Itens do pedido

​
paymentLink
string

Link para acessar o Link de Pagamento desta sessão

​
paymentMethods
(Cartão de crédito · object | Pix · object | Boleto · object | Drip · object | NuPay · object)[]

Métodos de pagamento disponíveis na sessão

​
createdAt
string

Data de criação da sessão

​
updatedAt
string

Data da atualização da sessão

​
publicKey
string

Chave de acesso com escopo restrito, usada para pagar a sessão

​
multiplePayments
object

Estado conceitual de disponibilidade do link para receber uma próxima cobrança. Retornado em respostas completas de sessão. Em respostas parciais de atualização ou pagamento, consulte GET /v1/sessions/{id} para obter o estado agregado atualizado.

​
settings
object

Configurações da empresa