Criar cobrança com NuPay

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

Método

Node.js

import { Malga } from 'malga'

const malga = new Malga({
  apiKey: '8468a624-68c1-49a3-b9f1-a22455053a38',
  clientId: 'ebb9c69c-4ad6-49fd-a565-a35cb4c967b3',
})

await malga.charges.create({
  merchantId: '2ed73b94-175a-438d-ae73-d11902492b75',
  customerId: 'e43a18fa-bb72-4c8d-afb2-382e195ab8a5',
  orderId: '3630e825-efa3-42a8-b4b1-4528cefaaf5b',
  amount: 100,
  paymentMethod: {
    type: 'nupay',
    items: [
      {
        sku: '123',
        name: 'Produto 1',
        quantity: 1,
        unitPrice: 100,
        risk: 'Low',
      }
    ]
  },
})

Response

{
	id: '2f97378a-f174-4865-9d14-6ffc10fb34f0',
	clientId: 'ebb9c69c-4ad6-49fd-a565-a35cb4c967b3',
	merchantId: '2ed73b94-175a-438d-ae73-d11902492b75',
	description: null,
	orderId: '3630e825-efa3-42a8-b4b1-4528cefaaf5b',
	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: 'nupay',
	},
	paymentSource: {
		sourceType: 'customer',
		customerId: 'e43a18fa-bb72-4c8d-afb2-382e195ab8a5',
	},
  fraudAnalysisMetadata: {
		sla: null,
		customer: {
			name: null,
			email: null,
			identity: null,
			identityType: null,
			birthdate: null,
			phone: null,
			billingAddress: null,
			deliveryAddress: null
		},
		cart: {
			items: [
				{
					name: 'Produto 1',
					quantity: 1,
					sku: '123',
					unitPrice: 1,
					risk: 'Low',
					locality: null,
					date: null,
					type: null,
					genre: null,
					tickets: null,
					location: null
				}
			]
		}
	},
	transactionRequests: [
		{
			id: '25de917a-f977-4054-bed3-e94ed377896a',
			createdAt: '2023-12-31T18:19:45.013Z',
			updatedAt: '2023-12-31T18:19:45.044Z',
			idempotencyKey: '86fde739-7506-48f6-a070-9eca62054415',
			providerId: 'db46b9d6-daa1-4eae-ba90-15b6d3216a93',
			providerType: 'SANDBOX',
			transactionId: '12023934-42e4-4062-b4f3-f7218c694c15',
			amount: 100,
			authorizationCode: null,
			authorizationNsu: null,
			requestStatus: 'success',
			requestType: 'pending',
			responseTs: '11ms',
			nupay: {
        paymentUrl: 'https://nubank.com.br'
      }
		}
	],
	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 NuPay

Show Parâmetros do paymentMethod

string

required

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

array

required

Dados dos produtos do pedido

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

URL de origem da cobrança

string

URL para a qual o cliente será redirecionado após finalizar o pagamento

string

URL para onde o cliente será direcionado caso escolha não finalizar o pagamento e cancele o pedido

number

Total de taxas aplicadas em centavos

number

Tempo em minutos para a expiração de uma cobrança criada que não tenha sido paga

string

required

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

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

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 NuPay

Método

Parâmetros