Criar cobrança com boleto

API SDK Documentação - Charges

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.

merchantId · uuid · required

ID do Merchant que será usado na cobrança

amount · number · required

Valor da cobrança em centavos

paymentMethod · object · required

Dados do pagamento com boleto

Show Parâmetros do paymentMethod

type · string · required

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

Com boleto sempre será boleto

expiresDate · string

Data de vencimento do boleto

instructions · string

Instruções do boleto

interest · object

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

Show Parâmetros do interest

days · number · required

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

amount · number

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

percentage · number

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

fine · object

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

Show Parâmetros do interest

days · number · required

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

amount · number

Valor em centavos da multa

percentage · number

Valor em porcentagem da multa

orderId · string

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

providerReferenceKey · string

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

description · string

Descrição da cobrança

currency · string

Moeda que será usada para a cobrança

customerId · uuid · required

ID do Customer que será usado na cobrança

customer · object · required

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

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

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