Skip to main content

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.

Para criar um Link de Pagamento via API, você pode utilizar o serviço de Sessões. Ao criar uma sessão, a sessão possuirá um paymentLink, que retornará na criação e na rota de detalhes de um Link, esta será a URL em que o ambiente de pagamento estará disponível para você. Você pode ler mais detalhes sobre a criação de uma sessão na especificação da API.
Para dividir valores entre recebedores neste fluxo, configure splitRules no corpo de criação da sessão. O pagamento do link não recebe novo split no corpo. Veja Split em sessão ou link de pagamento.
Para criar um Link de Pagamento via API, você deve acessar o endpoint de criação de sessões. O retorno da criação da sessão será uma sessão com o paymentLink preenchido, acessando a URL retornada você poderá pagar o Link de Pagamento.
Você pode configurar o paymentLink para que ele tenha o seu domínio alterando o companyUrl na API de configurações do Link. Saiba mais aqui.
curl --location 'https://api.malga.io/v1/sessions' \
--header 'X-Client-Id: <YOUR_CLIENT_ID>' \
--header 'X-Api-Key: <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
   "amount": 1000,
   "name": "Loja 1",
   "merchantId": "<YOUR_MERCHANT_ID>",
   "dueDate": "2030-10-25T09:28:45.000Z",
   "statementDescriptor": "<YOUR_STATEMENT_DESCRIPTOR>",
   "paymentMethods": [
      {
         "paymentType": "credit",
         "installments": 10
      },
      {
         "paymentType": "pix",
         "expiresIn": 10000
      },
      {
         "paymentType": "boleto",
         "expiresDate": "2026-01-01"
      }
   ],
   "items": [
      {
         "name": "Fone de Ouvido Bluetooth TWS-X1",
         "description": "Fone sem fio com cancelamento de ruído ativo, case de carregamento e 8h de bateria. Cor: Preto Fosco.",
         "unitPrice": 35000,
         "quantity": 1,
         "tangible": false
      },
      {
         "name": "Caneca \"Code & Coffee\"",
         "description": "Fone sem fio com cancelamento de ruído ativo, case de carregamento e 8h de bateria. Cor: Preto Fosco.",
         "unitPrice": 4500,
         "quantity": 1,
         "tangible": false
      },
      {
         "name": "Kit de Anotações \"Inspire\"",
         "description": "1 caderno A5 pautado (capa dura), 1 bloco de notas adesivas e 2 canetas esferográficas.",
         "unitPrice": 8990,
         "quantity": 1,
         "tangible": false
      }
   ]
}'
O valor final do Link de Pagamento não será a soma dos valores dos itens, mas sim o valor da sessão, que é enviada no parâmetro amount. Para pagar um Link de Pagamento, você deve utilizar o endpoint de pagamento de uma sessão. Você pode ler mais detalhes sobre o endpoint de pagamento de uma sessão na especificação da API.
Links de Pagamento só podem ser pagos uma única vez. Após o pagamento, o Link de Pagamento terá seu status alterado para paid e não poderá ser pago novamente.