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.

Crie cobranças com session e comece a transacionar com Malga. Se a sessão foi criada com split, as regras ficam gravadas na sessão e são aplicadas automaticamente na cobrança. Não passe splitRules neste método — use splitRules apenas na criação da sessão (API POST /v1/sessions). Saiba mais em Split em sessão ou link 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.charges.create({
  publicKey: 'd04cecd3-3d16-4942-a169-1f08af3c8b32',
  sessionId: '4693cc46-5e28-4996-a964-f7212499323f',
  customerId: '2c48166b-51fe-4d8d-a450-1385df8a95b9',
  paymentMethod: {
    type: 'pix',
  },
})

{
	id: 'e09ef791-1aaa-4b11-8173-698f2689a04d',
	clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
	merchantId: '8cfef0d1-73af-4bdb-b6c4-09ad3fbfc7f1',
  sessionId: '4693cc46-5e28-4996-a964-f7212499323f'
	description: null,
	orderId: null,
	providerReferenceKey: null,
	createdAt: '2023-12-31T18:19:44.993Z',
	amount: 100,
	originalAmount: 100,
	currency: 'BRL',
	statementDescriptor: null,
	capture: false,
	isDispute: false,
	status: 'pending',
	paymentMethod: {
		paymentType: 'pix',
		qrCodeData: '00020101021126430014BR.GOV.BCB.PIX010002173fcae964ec08d0ad9196d59e1e66304477C',
		qrCodeImageUrl: 'https://malga.io',
		expiresIn: 3600,
	},
	paymentSource: {
		sourceType: 'customer',
		customerId: '2c48166b-51fe-4d8d-a450-1385df8a95b9',
	},
	transactionRequests: [
		{
			id: 'a6cc6bda-3f6d-4277-8ea2-e4bbd9166f16',
			createdAt: '2023-12-31T18:19:45.013Z',
			updatedAt: '2023-12-31T18:19:45.044Z',
			idempotencyKey: '3b42ede3-15a8-4d81-b6e9-54c5762776c6',
			providerId: '694f7eee-2966-4825-a847-65d070cbdece',
			providerType: 'SANDBOX',
			transactionId: '18242a4d-dd35-475f-b79b-5cbe8f9d1fea',
			amount: 100,
			authorizationCode: null,
			authorizationNsu: null,
			requestStatus: 'success',
			requestType: 'pending',
			responseTs: '11ms',
			pix: {
        qrCodeData: '00020101021126430014BR.GOV.BCB.PIX010002173fcae964ec08d0ad9196d59e1e66304477C',
        qrCodeImageUrl: 'https://malga.io',
        expiresIn: 3600, 
      }
		}
	],
	appInfo: null
}

​
Parâmetros

Lista de todos os parâmetros suportados pelo método.
​
publicKey
uuid
required
Chave pública gerada unicamente para o pagamento da session
​
sessionId
uuid
required
ID da session que será usada para a cobrança
​
paymentMethod
object
required
Dados do pagamento conforme método de pagamento usado
​
customerId
uuid
ID do Customer que será usado na cobrança
​
customer
object
Dados do cliente para criação e vinculação automática à cobrança
​
fraudAnalysis
object
Dados para utilização das funcionalidades de antifraude
​
threeDSecure
object
Dados para utilização da funcionalidade de 3DS
​
paymentFlow
object
Dados adicionais para uso em condicionais dos Fluxos Inteligentes
​
appInfo
object
Dados para a rastreabilidade da cobrança