{
"type": "payment",
"paymentType": 1, // Tipo de pagamento | Inteiro específico (vide abaixo).
"amount": 3, // Montante a cobrar | Inteiro (> 0).
"installments": 1, // Número de parcelas | Inteiro (> 0).
"referenceId": "123.456-abc", // Identificador personalizado | String alfanumérica.
"metadata": {} // Campos adicionais personalizados | Objeto em JSON.
}
paymentType
deve ser um dentre:
0
para crédito;1
para débito;2
para crédito parcelado.amount
é dado em centavos:
175
.installments
, quando omitido, é 1
.referenceId
é opcional, podendo ser omitido. Seu valor deve ser um identificador alfanumérico, com um máximo de 50 caracteres, fornecido pelo parceiro para fins próprios:
"1237ab31-g99c-4e25-9hjs-32u4d3gf7fh2"
.metadata
é opcional, podendo ser omitido. Seu valor deve ser um objeto em JSON, com um máximo de 512 caracteres quando condensado, fornecido pelo parceiro para fins próprios:
{
"type": "payment",
// ...
"metadata": {
"comerciante": {
"endereco": {
"cep": 99999555,
"cidade": "SÃO PAULO",
"complemento": "",
"logradouro": "AVENIDA X",
"numero": 1200,
"unidade_federativa": "SP",
},
"id": "abc12345",
"nome": "REDE SUPERMERCADOS X",
"telefone": "+99 99 555-9999",
"tipo": "business",
},
"parcelado": false,
"taxa": 0.07,
"tentativa": 1,
"versao": "1.23.4",
},
}
let paymentRequest = {
type: "payment",
paymentType: 1,
amount: 150,
installments: 1
}
// Onde `socket` é um objeto de `WebSocket`.
socket.send(JSON.stringify(paymentRequest))
socket.onmessage = (event) => {
let response = JSON.parse(event.data)
if (response == null) {
return
}
if (response.type == "payment") {
if (response.status == "started") {
// O processo de pagamento foi iniciado.
// ...
return
}
if (response.status == "message") {
/* Uma mensagem foi recebida no campo `message`, e deverá ser apresentada
ao operador/cliente. */
// ...
return
}
if (response.status == "success") {
/* Pagamento bem-sucedido, e os dados poderão ser extraídos dos campos da
resposta. */
// ...
return
}
if (response.status == "failed") {
// Falha no pagamento.
// ...
return
}
if (response.status == "finished") {
// O processo de pagamento terminou.
// ...
return
}
}
// ...
}
Um exemplo mais completo pode ser encontrado no aplicativo de exemplo, na função eventPayment
do arquivo payment.js
.
status
:
started
: o início do pagamento;message
: o recebimento de uma mensagem;success
: o sucesso do pagamento;failed
: a falha do pagamento e a causa;finished
: ou o término do pagamento.{
"type": "payment",
"message": "Iniciando pagamento",
"status": "started"
}
{
"type": "payment",
"status": "message",
"message": "Processando"
}
{
"type": "payment",
"status": "success",
"message": "Transação aprovada",
"value": 3, // Montante pago | Inteiro (> 0).
"paymentType": 1, // Tipo de pagamento | Inteiro específico (vide abaixo).
"brand": "Maestro", // Bandeira do cartão | String alfanumérica.
"address": "-----", // Endereço do seller | String alfanumérica.
"sellerName": "-----", // Nome do seller | String alfanumérica.
"pan": "************3930", // PAN anonimizado do cartão | String alfanumérica.
"autoCode": "-----", // Código de autorização (AUTO) | String alfanumérica.
"documentType": "CPF", // Tipo de documento do seller | String alfanumérica.
"document": "-----", // Documento do seller | String alfanumérica.
"nsu": "-----", // NSU do pagamento | String alfanumérica.
"date": "11/10/2023", // Data do pagamento | String com data no formato "DD/MM/AAAA".
"hour": "15:56", // Horário do pagamento | String com horário no formato "HH:MM".
"cv": "-----", // CV do pagamento | String alfanumérica.
"arqc": "-----", // ARQC do pagamento | String alfanumérica.
"aid": "-----", // ID da aplicação de pagamento (AID) | String alfanumérica.
"sellerReceipt": "Maestro - Via Estabelecimento\n\n-----\n-----\nCPF:-----\nCV:-----\nAUTO:----- NSU:013686\nARQC:-----\n\nMaestro\nAID:-----\nVENDA DEBITO A VISTA\n\n************3930 11/10 15:56\nVALOR APROVADO R$ 0,03\n\n\n\n APROVADA PELO EMISSOR\n", // Recibo, via do estabelecimento | String alfanumérica.
"customerReceipt": "@ Maestro - Via Cliente@@-----@-----@CPF:-----@CV:-----@AUTO:-----@ARQC:-----@@Maestro@VENDA DEBITO A VISTA@@************3930 11/10 15:56@VALOR APROVADO R$ 0,03@", // Recibo, via do cliente | String alfanumérica.
"approvalMessage": "APROVADA PELO EMISSOR", // Mensagem de aprovação | String alfanumérica.
"aidLabel": "Maestro", // Nome da aplicação de pagamento | String alfanumérica.
"transactionId": "-----" // ID do pagamento | String numérica hexadecimal.
}
value
é dado em centavos:
94
.paymentType
será um dentre:
0
para crédito;1
para débito;2
para crédito parcelado.{
"type": "payment",
"status": "failed",
"message": "83 - CARTAO INVALIDO, USE CHIP/TARJA",
"statusCode": 83,
}
statusCode
será o código do erro que ocasionou a falha, sendo -1
caso não haja um código para a causa.{
"type": "payment",
"status": "finished",
"message": "Transação finalizada"
}
{
"type": "abort"
}