Eventos

Os eventos descrevem mudanças específicas que acontecem nos recursos da API.
A presente documentação faz o detalhamento , assim como o conteúdo da notificação que é enviada em cada caso.

Mudança de status

Código do evento: pix.updated

Conteúdo da notificação de uma cobrança

{
    "event": "pix.updated",
    "pix_charge_id": "15462a7028864ef6baffb86fd7ca7eb0", //id da cobrança
    "status": "2", //status da cobrança
    "timestamp": "134567890", // Timestamp em segundos do momento em que a notificação foi enviada
    "pix": {
        "e2eid": "E18236120202402232105s01b97d477e",
        "txid" : "24tBY786lQfy3BH6559tn17Qg0",
        "valor" : "20.00",
        "horario" : "2024-02-23",
        "infoPagador" : "",
        "statusLabel": "CONCLUIDA",
    }
}

Conteúdo da notificação de uma devolução

{
    "event": "pix.updated",
    "pix_charge_id": "15462a7028864ef6baffb86fd7ca7eb0", //id da cobrança
    "status": 2, //status da cobrança
    "timestamp": "134567890", // Timestamp em segundos do momento em que a notificação foi enviada
    "pix": {
        "e2eid": "E18236120202402232105s01b97d477e",
        "txid" : "24tBY786lQfy3BH6559tn17Qg0",
        "valor" : "20.00",
        "infoPagador" : "",
        "statusLabel": "CONCLUIDA",
        "devolucoes" : 
            {
                "rtrId" : "DOX3viiaj744l65I7017R5ZWN6Tp0I0f",
                "valor" : "20.00",
                "status" : 2,
                "statusLabel" : "DEVOLVIDO",
            }
        
    }
}

Lista de status do Pix

A tabela abaixo descreve cada código numérico de status e seu correspondente lógico:

Código numérico	Descrição
1	ATIVA
2	CONCLUIDA
3	REMOVIDA_PELO_USUARIO_RECEBEDOR
4	REMOVIDA_PELO_PSP
5	EXPIRADA
6	DEVOLVIDA
7	SOLICITADA_DEVOLUCAO

Lista de status de uma devolução

A tabela abaixo descreve cada código numérico de status e seu correspondente lógico:

Código numérico	Descrição
1	EM_PROCESSAMENTO
2	DEVOLVIDO
3	NAO_REALIZADO