Criar cobrança com session

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.

uuid

required

Chave pública gerada unicamente para o pagamento da session

uuid

required

ID da session que será usada para a cobrança

object

required

Dados do pagamento conforme método de pagamento usado

uuid

ID do Customer que será usado na cobrança

object

Dados do cliente para criação e vinculação automática à cobrança

Show Parâmetros do customer

string

required

Nome do cliente

string

required

E-mail do cliente

string

required

Telefone do cliente

object

Dados do documento do cliente

Show Parâmetros do document

string

required

Tipo do documento

string

required

Número do documento

string

País do documento

object

Dados do endereço do cliente

Show Parâmetros do address

string

required

Cidade

string

required

País

string

required

Bairro

string

required

Estado

string

required

Nome da rua, avenida ou travessa

string

required

Número da rua

string

required

Código postal

string

Complemento onde se localiza o endereço, caso exista

object

Dados para utilização das funcionalidades de antifraude

Show Parâmetros do fraudAnalysis

number

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

object

Dados do cliente

Show Parâmetros do customer

string

Nome do cliente

string

E-mail do cliente

string

Telefone do cliente

string

Número do documento do cliente

string

Tipo do documento cliente

string

Data de regisro do cliente

object

Dados do endereço de entrega do cliente

Show Parâmetros do deliveryAddress

string

required

Cidade

string

required

País

string

required

Bairro

string

required

Estado

string

required

Nome da rua, avenida ou travessa

string

required

Número da rua

string

required

Código postal

string

Complemento onde se localiza o endereço, caso exista

object

Dados do endereço de cobrança do cliente

Show Parâmetros do billingAddress

string

required

Cidade

string

required

País

string

required

Bairro

string

required

Estado

string

required

Nome da rua, avenida ou travessa

string

required

Número da rua

string

required

Código postal

string

Complemento onde se localiza o endereço, caso exista

object

Dados do navegador do cliente

Show Parâmetros do browser

string

required

Fingerprint gerado dos dados do navegador

boolean

required

Indica se os cookies foram aceitados

string

required

E-mail logado no navegador

string

required

Nome do host do usuário

string

required

Endereço de IP do usuário

string

required

User-Agent do navegador

object

Dados dos itens do carrinho

Show Parâmetros do cart

array

required

Show Parâmetros do items

string

required

Nome do produto

number

required

Quantidade do produto

string

required

Identificador único do item na loja

number

required

Preço de cada produto

string

required

Definição do índice de risco do produto

Os tipos suportados são: Low ou High

string

Descrição do produto

string

Categoria do produto

string

Localidade onde ocorrerá o evento

string

Data do evento

number

Tipo do evento

string

Definição do gênero do evento

object

Dados do ingresso

Show Parâmetros do tickets

number

Quantidade total de ingressos à venda

number

Quantidade de vezes que o evento será realizado na casa

number

Taxa de conveniência

number

Quantidade de ingressos com valor integral

number

Quantidade de ingresso com desconto (meia entrada)

number

Lote do ingresso

object

Dados do endereço do evento

Show Parâmetros do location

string

Cidade

string

País

string

Bairro

string

Estado

string

Nome da rua, avenida ou travessa

string

Número da rua

string

Código postal

string

Complemento onde se localiza o endereço, caso exista

object

Dados do aparelho do cliente

Show Parâmetros do device

string

Nome do modelo do aparelho

string

Capacidade da memória RAM do aparelho

string

Capacidade da armazenamento do aparelho

number

Quantidade de armazenamento livre do aparelho

number

Resolução do aparelho

object

Dados do sistema operacional do aparelho

Show Parâmetros do os

string

Tipo do sistema operacional

string

Versão do sistema operacional

object

Dados dos atributos do aparelho

Show Parâmetros do vendorAttributes

boolean

Aparelho possui flash na câmera

boolean

Aparelho pode realizar chamadas

boolean

Aparelho pode enviar SMS

boolean

Aparelho possui câmera de video

number

Quantidade de CPUs do aparelho

boolean

Aparelho possui simulador

string

Linguagem do aparelho

string

Idioma do aparelho

string

Plataforma do sistema operacional

string

Nome do aparelho

string

Família do aparelho

boolean

Aparelho possui display de retina

boolean

Aparelho possui câmera

string

Modelo do aparelho

boolean

Aparelho possui câmera frontal

array

Dados adicionais do aparelho

Show Parâmetros do vendors

string

Nome do atributo do fornecedor

string

Valor do atributo do fornecedor

array

Dados para utilização da funcionalidade de Split

Show Parâmetros do splitRules

uuid

required

ID do Recebedor

boolean

required

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

boolean

required

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

number

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

number

Valor que será enviada ao recebedor

object

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

Show Parâmetros do fares

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

number

required

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

object

Dados para utilização da funcionalidade de 3DS

Show Parâmetros do threeDSecure

string

required

URL para redirecionamento da autenticação

string

required

URL de origem da requisição

object

required

Dados do navegador do cliente

Show Parâmetros do browser

string

required

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

number

required

A profundidade de cores da tela

boolean

required

Indica se o Java está habilitado

boolean

required

Indica se o JavaScript está habilitado

string

required

A linguagem utilizada pelo sistema do usuário

number

required

Altura da tela

number

required

Largura da tela

string

required

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

string

required

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

string

required

Endereço de IP do usuário

object

Dados do endereço de cobrança

Show Parâmetros do billingAddress

string

required

Cidade

string

required

País

string

required

Estado

string

required

Nome da rua, avenida ou travessa

string

required

Número da rua

string

required

Código postal

object

Dados do endereço de envio

Show Parâmetros do shippingAddress

string

required

Cidade

string

required

País

string

required

Estado

string

required

Nome da rua, avenida ou travessa

string

required

Número da rua

string

required

Código postal

object

Dados do titular do cartão

Show Parâmetros do cardHolder

string

required

E-mail do titular do cartão

string

Telefone do titular do cartão

object

Dados adicionais para uso em condicionais dos Fluxos Inteligentes

Show Parâmetros do paymentFlow

object

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

object

Dados para a rastreabilidade da cobrança

Show Parâmetros do appInfo

object

Dados sobre o dispositivo

Show Parâmetros do device

string

required

Nome do sistema operacional

string

required

Versão do sistema operacional

object

Dados sobre o sistema proprietário de captura do merchant

Show Parâmetros do system

string

required

Nome da empresa e/ou plataforma

string

required

Versão do software da plataforma

Tokenization SDK

API SDKs

UI SDKs

Plugins

Criar cobrança com session

Método

Parâmetros

​Método

​Parâmetros

Método

Parâmetros