Modelo Webhook

Webhook de recebimento pix cash in
Entity: pix-payment-in

{
                        "entity": "pix-payment-in",
                        "createTimestamp": "2023-07-27T10:03:25.2647394",
                        "status": "CONFIRMED",
                        "body": {
                            "amount": 450,
                            "oldBalance": 50,
                            "currentBalance": 6.52,
                            "debitParty": {
                                "bank": 20018183,
                                "taxId": 46463721000,
                                "name": "teste",
                                "branch": 1,
                                "account": 300123,
                                "accountType": "TRAN"
                            },
                            "id": "fe47040e-e24e-4e0b-942b-1870d780ee1f",
                            "endToEndId": "E1393589320230727130301498341234",
                            "creditParty": {
                                "bank": 13935893,
                                "taxId": 46463721000,
                                "name": "teste",
                                "branch": 1,
                                "account": 300123,
                                "accountType": "TRAN"
                            },
                            "initiationType": "MANUAL",
                            "transactionType": "RECEIVEPIX",
                            "urgency": "HIGH",
                            "paymentType": "IMMEDIATE"
                        }
                    }

Tabela de apoio

Campo	Descrição
amount	Valor do recebimento
oldBalance	Saldo anterior
currentBalance	Saldo atual
debitParty	Dados do pagador
bank	ISPB do banco do pagador
taxId	CPF/CNPJ do pagador
name	Nome do pagador
branch	Agência do banco do pagador
account	Número da conta do pagador
accountType	Tipo de conta
id	identificador do recebimento
endToEndId	Identificador ponta-a-ponta associado ao pagamento.
creditParty	Dados do creditado
bank	ISPB do banco creditado
taxId	CPF/CNPJ do creditado
name	Nome de quem será creditado
branch	Agência do creditado
account	Número da conta do creditado
accountType	Tipo da conta
initiationType	Tipo de iniciação do pagamento (MANUAL, DICT, STATIC_QRCODE, DYMANIC_QRCODE)
transactionType	Tipo da transação Pix
urgency	Determina a urgência do pagamento
paymentType	Tipo de pagamento (IMMEDIATE, FRAUD, SCHEDULED)

Webhook de devolução de pix cash in

entity: pix-reversal-out

{
"entity": "pix-reversal-out",
"createTimestamp": "2023-07-27T10:46:30.360+00:00",
"status": "CONFIRMED",
"body": {
"amount": 250,
"oldBalance": 50,
"currentBalance": 6.52,
"id": "b94150c9-7dad-4b21-8183-50c83f4c5dd8",
"clientCode": "719d673b-4bec-434e-98f7-f28a9871cb48",
"reason": "MD06",
"returnIdentification": "D13935893202307271346SPpDyb4f123",
"originalEndToEndId": "E1393589320230727130301498341234",
"originalPaymentId": "4d22dea5-5507-45dd-9126-c6be307e6208"
 }
}

Tabela de apoio


amount	Valor
oldBalance	Saldo anterior
currentBalance	Saldo atual
id	Identificador da transação do recebimento pix
clientCode	Código do cliente
reason	Razão da Devolução, podendo ser: BE08: Devolvido como resultado de um erro bancário. FR01: Devolução por suspeita de fraude. MD06: Devolução solicitada pelo cliente final. SL02: Devolução do valor em dinheiro devido a um erro relacionado ao Pix Saque ou Pix Troco.
returnIdentification	Identificação do retorno
originalEndToEndId	EndtoEnd id da transação recebida, que é o pix que você deseja devolver
originalPaymentId	Id do pagamento

Webhook QR code expirado

Entity: pix-qrcode-expired

{
        "body": {
            "status": "EXPIRED",
            "transactionId": "4000405507",
            "payerQuestion": "Pagar ate a data de vencimento",
            "additionalInformation": null,
            "debtor": {
                "name": "MARIA IRANDI DOS SANTOS",
                "city": null,
                "publicArea": null,
                "state": null,
                "postalCode": null,
                "email": null,
                "txId": "06856109342",
                "fantasyName": null
            },
            "key": "c07a4e09-11a4-4df7-8f47-1055baffdd77",
            "receiver": {
                "name": "Primepag Solucoes em Pag",
                "city": "SAO PAULO",
                "publicArea": null,
                "state": null,
                "postalCode": "04543011",
                "email": null,
                "txId": null,
                "fantasyName": null
            },
            "amount": {
                "original": 20,
                "changeType": null,
                "withdrawal": null,
                "change": null,
                "discount": null,
                "abatement": null,
                "fine": null,
                "interest": null
            },
            "calendar": {
                "expirationAfterPayment": 0,
                "expiration": 1800,
                "createdAt": "2025-09-15T11:19:41.611Z",
                "dueDate": "2025-09-15T11:49:41.611Z",
                "expirationDate": "2025-09-15T14:49:41.611Z"
            },
            "clientRequestId": null,
            "transactionIdentification": "kk6g232xel65a0daee4dd13kk4000405507",
            "updateAt": null,
            "merchant": {
                "postalCode": "04543011",
                "city": "SAO PAULO",
                "merchantCategoryCode": 0,
                "name": "Primepag Solucoes em Pag"
            },
            "url": "qrcode-h.pix.celcoin.com.br/pixqrcode/v2/aedf0b1099b2edd52935c8626e6a9d",
            "emv": "00020101021226930014br.gov.bcb.pix2571qrcode-h.pix.celcoin.com.br/pixqrcode/v2/aedf0b1099b2edd52935c8626e6a9d5204000053039865802BR5924Primepag Solucoes em Pag6009SAO PAULO62070503***6304C5AC",
            "type": "COB",
            "recurrency": null
        },
        "entity": "pix-qrcode-expired",
        "createTimestamp": "2025-05-07T17:58:00.9251466",
        "status": "EXPIRED"
    }

Updated 7 days ago