Skip to main content
Novidade na Malga! Agora você pode enviar instruções de boleto diretamente na criação de uma sessão de link de pagamento por meio do campo instructions no paymentMethod do boleto. Esse campo atende fluxos de ERP e cobrança que precisam repassar instruções como vencimento, juros e multa ao provedor de boleto, com o mesmo comportamento já existente nas cobranças via API.

​
Como funciona

O campo instructions é opcional e anulável e aceita uma string de até 255 caracteres. Quando omitido ou enviado como null, a sessão é criada normalmente. Utilize \n para incluir quebras de linha na instrução exibida no boleto.

​
Exemplo

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,
   "merchantId": "<YOUR_MERCHANT_ID>",
   "paymentMethods": [
      {
         "paymentType": "boleto",
         "expiresDate": "2026-01-01",
         "instructions": "Não receber após o vencimento. Multa de 2% e juros de 1% ao mês."
      }
   ]
}'
Na consulta da sessão, o campo instructions é retornado no objeto paymentMethod do boleto, espelhando o valor informado na criação. Para mais detalhes, consulte a referência de criação de sessão.
Features:
  1. Campo instructions no paymentMethod do boleto na criação de sessões
  2. Campo opcional e anulável, com limite de 255 caracteres
  3. Paridade de comportamento com as cobranças via API
  4. Suporte a quebras de linha com \n