Criar cobrança com boleto

Crie cobranças com boleto 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({
  merchantId: '8cfef0d1-73af-4bdb-b6c4-09ad3fbfc7f1',
  customerId: '2c48166b-51fe-4d8d-a450-1385df8a95b9',
  amount: 100,
  paymentMethod: {
    type: 'boleto'
  },
})

Response

{
	id: 'e09ef791-1aaa-4b11-8173-698f2689a04d',
	clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
	merchantId: '8cfef0d1-73af-4bdb-b6c4-09ad3fbfc7f1',
	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: 'boleto',
		barcodeData: '1111 2222 3333 4444',
		barcodeImageUrl: 'https://malga.io',
	},
	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',
			boleto: {
        expiresDate: null,
        barcodeData: '1111 2222 3333 4444',
		    barcodeImageUrl: 'https://malga.io',
      }
		}
	],
	appInfo: null
}

Parâmetros

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

uuid

required

ID do Merchant que será usado na cobrança

number

required

Valor da cobrança em centavos

object

required

Dados do pagamento com boleto

Show Parâmetros do paymentMethod

string

required

Método de pagamento que será utilizado na cobrança
Com boleto sempre será boleto

string

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 que ocorrerá a cobrança do 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 interest

number

required

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

number

Valor em centavos da multa

number

Valor em porcentagem da multa

string

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

string

Identificador único da cobrança do lado do cliente utilizado para referenciar a cobrança do lado do provedor

string

Descrição da cobrança

string

Moeda que será usada para a cobrança

uuid

required

ID do Customer que será usado na cobrança

object

required

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

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á enviado 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 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 boleto

Método

Parâmetros

​Método

​Parâmetros

Método

Parâmetros