Tokenization SDK
API SDKs
- Introdução
- Getting started
- Documentação
- Introdução
- Auth
- Charges
- Criar cobrança com cartão de crédito
- Criar cobrança com boleto
- Criar cobrança com Drip
- Criar cobrança com NuPay
- Criar cobrança com PIX
- Criar cobrança com cartão armazenado
- Criar cobrança com session
- Criar cobrança com cartão tokenizado
- Criar cobrança com voucher
- Capturar cobrança
- Buscar cobrança
- Listar as cobranças
- Estornar cobrança
- Cards
- Customers
- Sandbox
- Sellers
- Sessions
- Webhooks
- Exemplos API SDKs
UI SDKs
- Introdução
- Checkout
- Checkout Full
Plugins
Criar cobrança com NuPay
API SDK Documentação - Charges
Crie cobranças com NuPay e comece a transacionar com Malga.
Método
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',
orderId: '3c066bcb-0fe6-4ec3-be2e-9158b12ea2e2',
amount: 100,
paymentMethod: {
type: 'nupay',
items: [
{
sku: '123',
name: 'Produto 1',
quantity: 1,
unitPrice: 100,
risk: 'Low',
}
]
},
})
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',
orderId: '3c066bcb-0fe6-4ec3-be2e-9158b12ea2e2',
amount: 100,
paymentMethod: {
type: 'nupay',
items: [
{
sku: '123',
name: 'Produto 1',
quantity: 1,
unitPrice: 100,
risk: 'Low',
}
]
},
})
{
id: 'e09ef791-1aaa-4b11-8173-698f2689a04d',
clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
merchantId: '8cfef0d1-73af-4bdb-b6c4-09ad3fbfc7f1',
description: null,
orderId: '3c066bcb-0fe6-4ec3-be2e-9158b12ea2e2',
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: '2c48166b-51fe-4d8d-a450-1385df8a95b9',
},
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: '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',
nupay: {
paymentUrl: 'https://nubank.com.br'
}
}
],
appInfo: null
}
{
id: 'e09ef791-1aaa-4b11-8173-698f2689a04d',
clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
merchantId: '8cfef0d1-73af-4bdb-b6c4-09ad3fbfc7f1',
description: null,
orderId: '3c066bcb-0fe6-4ec3-be2e-9158b12ea2e2',
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: '2c48166b-51fe-4d8d-a450-1385df8a95b9',
},
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: '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',
nupay: {
paymentUrl: 'https://nubank.com.br'
}
}
],
appInfo: null
}
Parâmetros
Lista de todos os parâmetros suportados pelo método.
ID do Merchant que será usado na cobrança
Valor da cobrança em centavos
Dados do pagamento com NuPay
Método de pagamento que será utilizado na cobrança
Com NuPay sempre será nupay
URL de origem da cobrança
URL para a qual o cliente será redirecionado após finalizar o pagamento
URL para onde o cliente será direcionado caso escolha não finalizar o pagamento e cancele o pedido
Total de taxas aplicadas em centavos
Tempo em minutos para a expiração de uma cobrança criada que não tenha sido paga
Identificador único da cobrança do lado do cliente para conciliação futura
Identificador único da cobrança do lado do cliente utilizado para referenciar a cobrança do lado do provedor
Descrição da cobrança
Moeda que será usada para a cobrança
ID do Customer que será usado na cobrança
Dados do cliente para criação e vinculação automática à cobrança
Nome do cliente
E-mail do cliente
Telefone do cliente
Dados do endereço do cliente
Cidade
País
Bairro
Estado
Nome da rua, avenida ou travessa
Número da rua
Código postal
Complemento onde se localiza o endereço, caso exista
Dados para utilização da funcionalidade de Split
ID do Recebedor
Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação
Indica se o recebedor atrelado assumirá os riscos de chargeback da transação
Porcentagem do valor da transação que será enviada ao recebedor
Valor que será enviada ao recebedor
Informações sobre as taxas que serão cobradas do recebedor, apenas para sellers com provedor Braspag
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
Indica valor em centavos a ser cobrado por transação capturada. É descontado no momento da “montagem” da agenda financeira
Dados adicionais para uso em condicionais dos Fluxos Inteligentes
Dados adicionais da cobrança enviados na criação da mesma
Dados para a rastreabilidade da cobrança
Was this page helpful?