Pular para o conteúdo principal

payment.completed

Enviado quando uma transação de pagamento é concluída.

Request
{
"id": "d3skor3r425c54fi9frg",
"type": "payment.completed",
"data": {
"id": "d3skoqrr425c54fi9fr0",
"processedAt": "2025-10-22T21:28:11.436914699Z",
"acquirer": "pagseguro",
"transactionType": "pre_authorization",
"transactionStatus": "denied",
"terminalId": "d3e7s9br425c0klkg9r0",
"merchantId": "d3e7s2br425c0klkg8q0",
"merchantCategoryCode": "5691",
"merchantTaxId": "00.000.000/0001-00",
"acquirerMerchantIdentifier": "CF20251125",
"acquirerTerminalIdentifier": "TL1534",
"currency": "BRL",
"amount": {
"amount": 123,
"scale": 2
},
"paymentMethod": "credit_card",
"processingMode": "credit",
"installments": 12,
"installmentInterest": false,
"authorizationCode": "AUH000",
"retrievalReferenceNumber": "221022182812",
"responseCode": "51",
"cardData": {
"entryMode": "typed",
"holderName": "Jose Matias",
"brand": "visa",
"firstDigits": "424242",
"lastDigits": "3456",
"productAid": "A0000000041010000000000000000000"
},
"deviceData": {
"manufacturer": "Positivo",
"model": "L400",
"serialNumber": "PST09732089",
"type": "smart-pos",
"communicationType": "WIFI",
"fingerprintId": "a3f1c9d8e2b04567",
"ipAddress": "10.12.34.56",
"geolocation": [-23.55052, -46.63331]
}
}
}

Campos do Payload​

CampoTipoDescrição
idstringIdentificador único do evento de webhook
typestringTipo do evento (ex: payment.completed)
dataobjectDados da transação

Campos do Objeto data​

CampoTipoDescrição
idstringIdentificador da transação
processedAtstringTimestamp de processamento (ISO 8601)
acquirerstringNome do adquirente/provedor, ex: pagseguro, btg_pactual
transactionTypestringUm dos seguintes: authorization, pre_authorization, capture, void, reversal
transactionStatusstringUm dos seguintes: pending, approved, denied
terminalIdstringIdentificador do terminal
merchantIdstringIdentificador do estabelecimento
merchantCategoryCodestringCódigo de categoria do comerciante (MCC, ex.: 5347)
merchantTaxIdstringDocumento fiscal do estabelecimento
acquirerMerchantIdentifierstringIdentificador do estabelecimento no adquirente
acquirerTerminalIdentifierstringIdentificador do terminal no adquirente
currencystringCódigo de moeda ISO 4217 (ex: BRL)
amountobjectValor da transação como objeto decimal (ver Objeto amount)
paymentMethodstringUm dos seguintes: credit_card, debit_card, voucher, pix
processingModestringModo em que a transação foi processada pelo adquirente, que pode diferir de paymentMethod: credit, debit, voucher, pre-paid. Ausente quando não informado pelo adquirente
installmentsintegerNúmero de parcelas; pode ser null para pagamentos sem parcelamento
installmentInterestbooleanSe as parcelas cobram juros; pode ser null se não aplicável
authorizationCodestringCódigo de autorização do adquirente; pode ser null para status pending/denied
retrievalReferenceNumberstringRRN/NSU do adquirente; pode ser null dependendo do provedor/estado
responseCodestringCódigo de resposta ABECS; pode ser null quando não fornecido
cardDataobjectDetalhes do cartão para pagamentos com cartão; null para pix (ver Objeto cardData)
deviceDataobjectInformações do dispositivo (ver Objeto deviceData)

O campo amount é um objeto decimal {amount, scale} neste evento. Os endpoints Consultar Transação e Listar Transações representam o mesmo conceito como string decimal (ex.: 150.00).

Campos do Objeto amount​

O valor é representado como um objeto decimal para suportar diferentes moedas e precisões, incluindo criptomoedas.

CampoTipoDescrição
amountintegerValor inteiro, sem ponto decimal
scaleintegerQuantidade de casas decimais aplicada ao valor

Para obter o valor real, divida amount por 10 elevado a scale. Exemplo: amount: 123 com scale: 2 equivale a 1.23.

Campos do Objeto cardData​

CampoTipoDescrição
entryModestringVer Modos de Entrada
holderNamestringNome do titular; pode ser null se indisponível
brandstringex: visa, mastercard; pode ser null
firstDigitsstringPrimeiros 6-8 dígitos; pode ser null
lastDigitsstringÚltimos 4 dígitos; pode ser null
productAidstringEMV Application Identifier (AID); null para métodos não-EMV ou não-cartão

Campos do Objeto deviceData​

CampoTipoDescrição
manufacturerstringFabricante do dispositivo (ex: Positivo)
modelstringModelo do dispositivo (ex: L400)
serialNumberstringNúmero de série do dispositivo
typestringTipo do dispositivo (ex: smart-pos)
communicationTypestringMeio de comunicação usado na transação (ex: WIFI, 4G, ETHERNET); pode ser null
fingerprintIdstringIdentificador de fingerprint do dispositivo; pode ser null
ipAddressstringEndereço IP do dispositivo; pode ser null
geolocationarrayCoordenadas [latitude, longitude]; pode ser null

Modos de Entrada​

  • typed - Cartão digitado manualmente
  • magstripe - Leitura de tira magnética
  • chip - Cartão com chip EMV
  • typed_fallback_791 - Fallback digitado (erro 791)
  • typed_fallback_821 - Fallback digitado (erro 821)
  • magstripe_fallback_801 - Fallback de tira magnética (erro 801)
  • magstripe_fallback_811 - Fallback de tira magnética (erro 811)
  • contactless_chip - Chip sem contato
  • contactless_magstripe - Tira magnética sem contato
  • typed_for_recurrence - Digitado para pagamento recorrente