#Introdução

Hooks de pix podem ser configurados de acordo com os tipos de eventos desejados. Novos eventos podem ser adicionados conforme a necessidade.

Em casos de falha por problemas de comunicação, autenticação ou indisponibilidade, as notificações serão reenviadas a cada 5 minutos por um período de 2 horas. Após este período o reenvio será a cada 5 horas por um período de 3 dias.

Se após estas tentativas a notificação não tiver sucesso na entrega, será necessário a consulta do status da transação no endpoint:

https://api.gsurfnet.com/gs-payment-physical/v1/payments/pix/{gti}

#Tipos de eventos

AUTHORIZATION: Evento emitido quando um pix é autorizado no provedor (Gerado no banco emissor).

AUTHORIZATION_ERROR: Evento emitido quando houver erro na autorização do pix no provedor

CONFIRMATION: Evento emitido na recepção da confirmação do pagamento. Geralmente via hook do banco emissor, ou rotina online de conciliação.

EXPIRATION: Evento emitido quando um pix é expirado impossibilitando seu pagamento

REFUNDED: Evento emitido quando um pix é estornado

DISABLED: Evento emitido quando há um cancelamento do pix que veio diretamente do emissor sem passar por alguma requisição através da gsurf.

Obs: O payload do hook é versionado. As versões indicam os campos que são contidos no payload.

#Payload

#V1.0

versionstringconst: "1.0"

event_typestring

Enum: "AUTHORIZATION", "AUTHORIZATION_ERROR", "CONFIRMATION", "REFUNDED", "EXPIRATION"

entitystringconst: "PixPayment"

payloadobject

payment_dataobject

Dados do pagamento.

gtistring

Identificador único do Pix.

statusstring

Status do pagamento.

Enum: "NEW", "AUTHORIZED", "AUTHORIZATION_IN_PROGRESS", "AUTHORIZATION_ERROR", "DISABLED", "CONFIRMED", "EXPIRED"

channelstring

Canal

creation_timestring

Data de criação do pagamento.

update_timestring

Data da última atualização do pagamento.

effective_timestring | null

Data do pagamento no provedor.

confirm_timestring | null

Data da confirmação do pagamento no gateway.

subacquirer_documentstring

Documento do subadquirente.

creation_originstring | null

Origem da criação da transação.

terminal_idstring

Identificador do terminal.

sale_dataobject

Dados referentes a venda.

amountinteger

Valor da venda.

merchant_correlation_idstring

Identificador da venda na loja.

order_idstring

Número do pedido.

installmentsinteger | null

Número da parcela.

submerchant_idstring

Identificador da loja.

dynamic_dataarray[object]

Dados dinâmicos. Máximo 100 itens.

keystring

Chave.

valuestring

Valor. Máximo 40 caracteres.

pix_dataobject

payer_information_requestedstring | null

Mensagem a ser exibida ao pagador.

payer_information_responsestring | null

Mensagem recebida pelo pagador.

gsurf_usnstring

Número sequencial gsurf.

provider_dataobject

emvstring | null

Código onde estão contidos os dados representados na imagem do QR Code.

e2e_idstring | null

Identificação do pix no Bacen

qr_code_data_location_urlstring | null

Url de localizacão dos dados do pix no banco emissor

gsurf_correlation_idstring

Identificação do pix no provedor de pagamento

provider_namestring

Nome do provedor(banco) onde o pix foi emitido

provider_idstring

Id do provedor (banco) onde o pix foi emitido

#Exemplo

{
    "version": "1.0",
    "entity": "PixPayment",
    "event_type": "AUTHORIZATION",
    "payload": {
        "payment_data": {
            "gti": "bb6ad821-fe48-461e-adb8-f741f704e551",
            "status": "AUTHORIZED",
            "channel": "PHYSICAL",
            "creation_time": "2022-04-26T21:47:08-03:00",
            "update_time": "2022-04-26T21:47:08-03:00",
            "effective_time": "2022-04-26T21:48:08-03:00",
            "confirm_time": null,
            "subacquirer_document": "35524559000103",
            "creation_origin": null,
            "terminal_id": "11111111"
        },
        "sale_data": {
            "amount": 10000,
            "merchant_correlation_id": "20220426jaqy",
            "order_id": "20220426jaqy",
            "installments": null,
            "submerchant_id": "53391845015"
        },
        "dynamic_data": [],
        "pix_data": {
            "payer_information_requested": null,
            "payer_information_response": null,
            "gsurf_usn": "200000010757",
            "provider_data": {
                "emv": "00020101021226910014BR.GOV.BCB.PIX2569spi-h.itau.com.br/pix/qr/v2/af581bdc-624e-4333-af38-1adaddfa6ce05204000053039865802BR5914PMD BASHAR RIO6009SAO PAULO62070503***6304E7DB",
                "e2e_id": null,
                "qr_code_data_location_url": "api.itau/pix/qr/v2/7ee6fc6f-21a5-4226-9d17-891a5da871bd",
                "gsurf_correlation_id": "bbba96adf0e442a0802761bb2758d9e5",
                "provider_name": "itau",
                "provider_id": "245811fc-b564-4d0f-8e54-81e3947052ab"
            }
        }
    }
}

Hooks de Pagamento de Pix

#Introdução

#Tipos de eventos

#Payload

#V1.0

#Exemplo