Criar sessão

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

Método

Node.js

import { Malga } from "malga";

const malga = new Malga({
  apiKey: "8468a624-68c1-49a3-b9f1-a22455053a38",
  clientId: "ebb9c69c-4ad6-49fd-a565-a35cb4c967b3",
});

await malga.sessions.create({
  merchantId: "2ed73b94-175a-438d-ae73-d11902492b75",
  amount: 100,
  dueDate: "2023-12-31T03:00:00.000Z",
  name: "Link de Pagamento",
  createLink: true,
  maxPayments: 5,
  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,
    },
  ],
});

Response

{
	id: '7936be48-fd3d-4d55-a9b3-c1b776a2cbab',
	name: 'Link de Pagamento',
	status: 'created',
	isActive: true,
	clientId: 'ebb9c69c-4ad6-49fd-a565-a35cb4c967b3',
	orderId: null,
	amount: 100,
	currency: 'BRL',
	capture: null,
	merchantId: '2ed73b94-175a-438d-ae73-d11902492b75',
	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: 'd6041197-4158-473d-82de-8594bbe69b59',
	multiplePayments: {
		allow: true,
		maxPayments: 5,
		paymentCount: 0,
		pendingCount: 0,
		status: 'active'
	},
}

Parâmetros

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

uuid

required

ID do Merchant que será usado na sessão

number

required

Valor da sessão em centavos

string

required

Data de expiração da sessão

string

required

Nome de identificação da sessão

array

required

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

Show Parâmetros de cartão de crédito

string

required

Identificador do tipo de pagamento, com cartão de crédito sempre será credit

number

required

Número de parcelas possíveis na venda

Show Parâmetros de Pix

string

required

Identificador do tipo de pagamento, com Pix sempre será pix

number

required

Tempo de expiração do Pix em segundos

Show Parâmetros de boleto

string

required

Identificador do tipo de pagamento, com boleto sempre será boleto

string

required

Data de vencimento do boleto

string

Instruções do boleto

object

Dados opcionais da condição de juros para pagamento em atraso

Show Parâmetros do interest

number

required

Dias após a expiração do boleto em que ocorrerá a cobrança dos juros

number

Valor em centavos da taxa de juros que será cobrado ao dia

number

Valor em porcentagem da taxa de juros que será cobrado ao mês

object

Dados opcionais da condição de multa para pagamento em atraso

Show Parâmetros do fine

number

required

Dias após a expiração do boleto em que ocorrerá a cobrança da multa

number

Valor em centavos da multa

number

Valor em porcentagem da multa

Show Parâmetros de Drip

string

required

Identificador do tipo de pagamento, com Drip sempre será drip

string

Link de redirecionamento em caso de aprovação do pagamento no ambiente de checkout da Drip

string

Link de redirecionamento em caso de cancelamento do pagamento no ambiente de checkout da Drip

Show Parâmetros de NuPay

string

required

Identificador do tipo de pagamento, com NuPay sempre será nupay

string

URL de origem da cobrança

string

URL para a qual o cliente será redirecionado após finalizar o pagamento

string

URL para onde o cliente será direcionado caso escolha não finalizar o pagamento e cancele o pedido

number

Total de taxas aplicadas em centavos

number

Tempo em minutos para a expiração de uma cobrança criada que não tenha sido paga

array

required

Dados dos produtos da sessão

Show Parâmetros de items

string

required

Nome do produto

number

required

Preço do produto

number

required

Quantidade do produto

string

Descrição do produto

boolean

Define se é um produto tangível

string

Descrição da sessão

string

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

boolean

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

number

Configura a sessão como 1:N para múltiplos pagamentos. Use -1 para permitir pagamentos ilimitados ou um número entre 1 e 99999 para definir um limite finito. Quando omitido, a sessão segue o fluxo 1:1.

string

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

string

Moeda que será usada para a sessão

boolean

Define se a sessão está ativa

boolean

Define se a sessão deve ser capturada automaticamente

Tokenization SDK

API SDKs

UI SDKs

Plugins

Criar sessão

Método

Parâmetros