Crie sessões para ter cobranças mais seguras e gerenciar Links de Pagamento.

Método

import { Malga } from 'malga'

const malga = new Malga({
  apiKey: '17a64c8f-a387-4682-bdd8-d280493715e0',
  clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
})

await malga.sessions.create({
  merchantId: '8cfef0d1-73af-4bdb-b6c4-09ad3fbfc7f1',
  amount: 100,
  dueDate: '2023-12-31T03:00:00.000Z',
  name: 'Link de Pagamento',
  paymentMethods: [
    { paymentType: 'credit', installments: 1 },
    { paymentType: 'drip' },
    { paymentType: 'nupay' },
    { paymentType: 'pix', expiresIn: 3600 },
    { paymentType: 'boleto', expiresDate: '2023-12-31' },
  ],
  items: [
    {
      name: 'Produto 1',
      unitPrice: 100,
      quantity: 1,
    },
  ],
})
{
	id: 'bbc9d986-b65e-48fe-b879-2e1df10aea87',
	name: 'Link de Pagamento',
	status: 'created',
	isActive: true,
	clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
	orderId: null,
	amount: 100,
	currency: 'BRL',
	capture: null,
	merchantId: '8cfef0d1-73af-4bdb-b6c4-09ad3fbfc7f1',
	dueDate: '2023-12-31T03:00:00.000Z',
	description: null,
	statementDescriptor: null,
	items: [
		{
			name: 'Produto 1',
			description: null,
			unitPrice: 100,
			quantity: 1,
			tangible: null
		}
	],
	paymentLink: '',
	paymentMethods: [
		{
			paymentType: 'pix',
			expiresIn: 500
		},
		{
			paymentType: 'credit',
			installments: 1,
			recurrence: null
		},
		{
			paymentType: 'boleto',
			expiresDate: '2023-12-31T00:00:00.000Z',
			instructions: null
		},
		{
			paymentType: 'drip',
			successRedirectUrl: null,
			cancelRedirectUrl: null
		},
    {
			paymentType: 'nupay',
			delayToAutoCancel: null,
			orderUrl: null,
			returnUrl: null,
			cancelUrl: null
		},
	],
	createdAt: '2023-01-31T00:00:00.000Z',
	updatedAt: '2023-01-31T00:00:00.000Z',
	publicKey: 'b8d59a73-fd16-4d6b-9e0f-9d7b2a8a7e6d',
}

Parâmetros

Lista de todos os parâmetros suportados pelo método.

merchantId
uuid
required

ID do Merchant que será usado na sessão

amount
number
required

Valor da sessão em centavos

dueDate
string
required

Data de expiração da sessão

name
string
required

Nome de identificação da sessão

paymentMethods
array
required

Dados dos métodos de pagamento disponíveis na sessão

items
array
required

Dados dos produtos da sessão

description
string

Descrição da sessão

statementDescriptor
string

Descrição da cobrança que irá aparecer na fatura do cartão

Define se deve criar um link para pagamento com a funcionalidade de Link de Pagamento

orderId
string

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

currency
string

Moeda que será usada para a sessão

isActive
boolean

Define se a sessão está ativa

capture
boolean

Define se a sessão deve ser capturada automaticamente