Criar cobrança com session

API SDK Documentação - Charges

Crie cobranças com session e comece a transacionar com Malga.

Método

Node.js

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',
  },
})

Response

{
	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

Show Parâmetros do customer

name · string · required

Nome do cliente

email · string · required

E-mail do cliente

phoneNumber · string · required

Telefone do cliente

document · object

Dados do documento do cliente

Show Parâmetros do document

type · string · required

Tipo do documento

number · string · required

Número do documento

country · string

País do documento

address · object

Dados do endereço do cliente

Show Parâmetros do address

city · string · required

Cidade

country · string · required

País

district · string · required

Bairro

state · string · required

Estado

street · string · required

Nome da rua, avenida ou travessa

streetNumber · string · required

Número da rua

zipCode · string · required

Código postal

complement · string

Complemento onde se localiza o endereço, caso exista

fraudAnalysis · object

Dados para utilização das funcionalidades de antifraude

Show Parâmetros do fraudAnalysis

sla · number

Valor em minutos de SLA máximo de análise do pedido

customer · object

Dados do cliente

Show Parâmetros do customer

name · string

Nome do cliente

email · string

E-mail do cliente

phone · string

Telefone do cliente

identity · string

Número do documento do cliente

identityType · string

Tipo do documento cliente

registrationDate · string

Data de regisro do cliente

deliveryAddress · object

Dados do endereço de entrega do cliente

Show Parâmetros do deliveryAddress

city · string · required

Cidade

country · string · required

País

district · string · required

Bairro

state · string · required

Estado

street · string · required

Nome da rua, avenida ou travessa

number · string · required

Número da rua

zipCode · string · required

Código postal

complement · string

Complemento onde se localiza o endereço, caso exista

billingAddress · object

Dados do endereço de cobrança do cliente

Show Parâmetros do billingAddress

city · string · required

Cidade

country · string · required

País

district · string · required

Bairro

state · string · required

Estado

street · string · required

Nome da rua, avenida ou travessa

number · string · required

Número da rua

zipCode · string · required

Código postal

complement · string

Complemento onde se localiza o endereço, caso exista

browser · object

Dados do navegador do cliente

Show Parâmetros do browser

browserFingerprint · string · required

Fingerprint gerado dos dados do navegador

cookiesAccepted · boolean · required

Indica se os cookies foram aceitados

email · string · required

E-mail logado no navegador

hostName · string · required

Nome do host do usuário

ipAddress · string · required

Endereço de IP do usuário

type · string · required

User-Agent do navegador

cart · object

Dados dos itens do carrinho

Show Parâmetros do cart

items · array · required

Show Parâmetros do items

name · string · required

Nome do produto

quantity · number · required

Quantidade do produto

sku · string · required

Identificador único do item na loja

unitPrice · number · required

Preço de cada produto

risk · string · required

Definição do índice de risco do produto

Os tipos suportados são: Low ou High

description · string

Descrição do produto

categoryId · string

Categoria do produto

locality · string

Localidade onde ocorrerá o evento

date · string

Data do evento

type · number

Tipo do evento

genre · string

Definição do gênero do evento

tickets · object

Dados do ingresso

Show Parâmetros do tickets

quantityTicketSale · number

Quantidade total de ingressos à venda

quantityEventHouse · number

Quantidade de vezes que o evento será realizado na casa

convenienceFeeValue · number

Taxa de conveniência

quantityFull · number

Quantidade de ingressos com valor integral

quantityHalf · number

Quantidade de ingresso com desconto (meia entrada)

batch · number

Lote do ingresso

location · object

Dados do endereço do evento

Show Parâmetros do location

city · string

Cidade

country · string

País

district · string

Bairro

state · string

Estado

street · string

Nome da rua, avenida ou travessa

number · string

Número da rua

zipCode · string

Código postal

complement · string

Complemento onde se localiza o endereço, caso exista

device · object

Dados do aparelho do cliente

Show Parâmetros do device

model · string

Nome do modelo do aparelho

ramCapacity · string

Capacidade da memória RAM do aparelho

diskCapacity · string

Capacidade da armazenamento do aparelho

freeDiskSpace · number

Quantidade de armazenamento livre do aparelho

resolution · number

Resolução do aparelho

os · object

Dados do sistema operacional do aparelho

Show Parâmetros do os

type · string

Tipo do sistema operacional

version · string

Versão do sistema operacional

vendorAttributes · object

Dados dos atributos do aparelho

Show Parâmetros do vendorAttributes

flash · boolean

Aparelho possui flash na câmera

phoneCalls · boolean

Aparelho pode realizar chamadas

sendSms · boolean

Aparelho pode enviar SMS

videoCamera · boolean

Aparelho possui câmera de video

cpuCount · number

Quantidade de CPUs do aparelho

simulator · boolean

Aparelho possui simulador

language · string

Linguagem do aparelho

idiom · string

Idioma do aparelho

platform · string

Plataforma do sistema operacional

name · string

Nome do aparelho

family · string

Família do aparelho

retinaDisplay · boolean

Aparelho possui display de retina

camera · boolean

Aparelho possui câmera

model · string

Modelo do aparelho

frontCamera · boolean

Aparelho possui câmera frontal

vendors · array

Dados adicionais do aparelho

Show Parâmetros do vendors

name · string

Nome do atributo do fornecedor

value · string

Valor do atributo do fornecedor

splitRules · array

Dados para utilização da funcionalidade de Split

Show Parâmetros do splitRules

sellerId · uuid · required

ID do Recebedor

processingFee · boolean · required

Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação

liable · boolean · required

Indica se o recebedor atrelado assumirá os riscos de chargeback da transação

percentage · number

Porcentagem do valor da transação que será enviada ao recebedor

amount · number

Valor que será enviada ao recebedor

fares · object

Informações sobre as taxas que serão cobradas do recebedor, apenas para sellers com provedor Braspag

Show Parâmetros do fares

mdr · number · required

Indica o percentual a ser descontado do valor de uma transação, definido por produto (crédito/débito/boleto), bandeira e faixa de parcelamento

fee · number · required

Indica valor em centavos a ser cobrado por transação capturada. É descontado no momento da “montagem” da agenda financeira

threeDSecure · object

Dados para utilização da funcionalidade de 3DS

Show Parâmetros do threeDSecure

redirectURL · string · required

URL para redirecionamento da autenticação

requestorURL · string · required

URL de origem da requisição

browser · object · required

Dados do navegador do cliente

Show Parâmetros do browser

acceptHeader · string · required

O Accept do cabeçalho de requisição HTTP

colorDepth · number · required

A profundidade de cores da tela

javaEnabled · boolean · required

Indica se o Java está habilitado

javaScriptEnabled · boolean · required

Indica se o JavaScript está habilitado

language · string · required

A linguagem utilizada pelo sistema do usuário

screenHeight · number · required

Altura da tela

screenWidth · number · required

Largura da tela

timeZoneOffset · string · required

Diferença em minutos do deslocamento de fuso horário entre o UTC e a localidade atual

userAgent · string · required

O User-Agent do cabeçalho de requisição HTTP

ip · string · required

Endereço de IP do usuário

billingAddress · object

Dados do endereço de cobrança

Show Parâmetros do billingAddress

city · string · required

Cidade

country · string · required

País

state · string · required

Estado

street · string · required

Nome da rua, avenida ou travessa

streetNumber · string · required

Número da rua

zipCode · string · required

Código postal

shippingAddress · object

Dados do endereço de envio

Show Parâmetros do shippingAddress

city · string · required

Cidade

country · string · required

País

state · string · required

Estado

street · string · required

Nome da rua, avenida ou travessa

streetNumber · string · required

Número da rua

zipCode · string · required

Código postal

cardHolder · object

Dados do titular do cartão

Show Parâmetros do cardHolder

email · string · required

E-mail do titular do cartão

mobilePhone · string

Telefone do titular do cartão

paymentFlow · object

Dados adicionais para uso em condicionais dos Fluxos Inteligentes

Show Parâmetros do paymentFlow

metadata · object

Dados adicionais da cobrança enviados na criação da mesma

appInfo · object

Dados para a rastreabilidade da cobrança

Show Parâmetros do appInfo

device · object

Dados sobre o dispositivo

Show Parâmetros do device

name · string · required

Nome do sistema operacional

version · string · required

Versão do sistema operacional

system · object

Dados sobre o sistema proprietário de captura do merchant

Show Parâmetros do system

name · string · required

Nome da empresa e/ou plataforma

version · string · required

Versão do software da plataforma