Webhook de Resposta da Transação
O AZPAY Checkout realiza um POST a cada alteração de status na transação para uma URL informada durante a criação do Checkout chamada URL de Webhook.
Utilize o merchant_id e o merchant_key para validar a requisição. Como essas chaves são privadas, você pode utilizá-las como verificação que somos nós mesmos que estamos te enviando a atualização de status.
Os dados são enviados no formato JSON e contém os dados específicos do AZPAY Checkout quanto os dados informados pela AZPay API:
PARÂMETRO | TIPO | DESCRIÇÃO |
---|---|---|
order_id | string | ID da Order em que a transação ocorreu. É o mesmo ID gerado quando se cria um "Order-Token". |
merchant_id | string | Seu Merchant ID, que pode ser verificado no painel da AZPay. |
merchant_key | string | Seu Merchant Key, que pode ser verificado no painel da AZPay. |
checkout_id | string | ID do Checkout onde a transação passou. |
checkout_title | string | Nome do Checkout onde a transação passou. |
payment_processor_fee | number | Taxa do processador cadastrada no método de pagamento utilizado na transação, pode ser usada para controle interno do cliente AZPay. (Dado opcional) |
credit_card | object | Objeto com informações sobre o cartão de crédito(apenas caso um cartão de crédito tenha sido utilizado na transação). |
credit_card.bin | string | O bin do cartão de crédito utilizado na transação. |
credit_card.last4 | string | Os 4 últimos dígitos do cartão de crédito. |
credit_card.brand | string | A marca do cartão de crédito utilizado na transação. Exemplo: mastercad, visa, etc. |
credit_card.expire_date | string | Validade do cartão de crédito utilizado na transação. |
customer | object | Objeto com os dados do comprador. |
customer.email | string | E-mail do comprador. |
customer.first_name | string | Primeiro nome do comprador. |
customer.last_name | string | Sobrenome do comprador. |
customer.phone | string | Telefone do comprador. |
customer.address | object | Objeto com o endereço do comprador. |
customer.address.country_iso_31661_alpha_3 | string | País do comprador em [ISO 3166-1 Alfa-3] |
customer.address.postal_code | string | CEP/Zip code do comprador. |
customer.address.city | string | Cidade do comprador. |
customer.address.state | string | Estado do comprador. |
customer.address.street | string | Rua do comprador. |
customer.address.number | string | Número da casa do comprador. |
customer.address.complement | string | Complemento do endereço do comprador. |
created_at | string | Data de criação da transação. |
updated_at | string | Data da última atualização da transação |
operator_code | string | O código da operadora/adquirente responsável pela transação. Códigos de Operadora |
operator_name | string | Nome da operadora/adquirente responsável pela transação. |
azpay_api_tid | object | TID da transação vindo da API. |
azpay_api_status | object | Status da transação vindo da API |
azpay_api_response | object | O objeto completo enviado pela API da AZPay, o conteúdo deste objeto pode ser encontrado em Webhook |
custom_field | string | Valor opcional passado durante a criação da transação. |
Recomenda-se o uso do order_id para rastrear a atualização da transação dentro do seu sistema. O order_id é gerado para se obter o Order-Token antes de realizar uma transação.
Exemplo de POST:
{
"order_id": "512312312fasdaswe123ea",
"merchant_id": "111",
"merchant_key": "123128dashd91cjk198231",
"checkout_id": "507f191e810c19729de860ea",
"checkout_title": "Checkout Loja 1",
"payment_processor_fee": 3.2,
"credit_card": {
"bin": "431231",
"last4": "1234",
"brand": "mastercard",
"expiration_date": "10/20"
},
"customer": {
"email": "[email protected]",
"cpf": "11111111111",
"first_name": "John",
"last_name": "Smith",
"phone": "+55 11 12345-12345",
"address": {
"country_iso_31661_alpha_3": "BRA",
"postal_code": "11111111",
"city": "São Paulo",
"state": "SP",
"street": "Alameda das Flores",
"number": "123",
"complement": "Apto 1",
},
},
"created_at":"2018-12-12T19:06:36.654Z",
"updated_at": "2018-12-12T19:20:00.654Z",
"operator_code": "1",
"operator_name": "CIELO - BUY PAGE LOJA",
"azpay_api_tid": "A1A7486D-5286-6C76-3AC8-84488728361C",
"azpay_api_status": 0,
"azpay_api_response": {},
"custom_field: "abdef"
}
Verifique se a URL de retorno é válida ou se ela está ativa. O AZPAY Checkout realiza 3 tentativas para validar o envio. O código HTTP de resposta deve ser 200 para validar a recepção do POST.
Updated about 5 years ago