--- title: "Listar webhooks" url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/listar-webhooks" --- > Full API specification: https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5.md # Listar webhooks `GET` `/hooks` Operation ID: `listar-webhooks` ## Query parameters - `status` (string, optional) - Status do webhook ('pending', 'sent' or 'failed') - `webhook_event` (string, optional) - Nome do evento do webhook - `created_since` (string, date, optional) - Data de início do período de criação a ser listado. - `created_until` (string, date, optional) - Data final do período de criação a ser listado. - `page` (integer, int32, optional) - Número da página. - `size` (integer, int32, optional) - Quantidade de itens por página. ## Responses - `200` - 200 - `400` - 400 ## OpenAPI definition ```yaml openapi: 3.1.0 info: title: Pagar.me v5 API (Legado) version: 5.0.0 servers: - url: https://api.stone.com.br/core/v5 paths: /hooks: get: summary: Listar webhooks description: "" operationId: listar-webhooks parameters: - name: status in: query description: Status do webhook ('pending', 'sent' or 'failed') schema: type: string - name: webhook_event in: query description: Nome do evento do webhook schema: type: string - name: created_since in: query description: Data de início do período de criação a ser listado. schema: type: string format: date - name: created_until in: query description: Data final do período de criação a ser listado. schema: type: string format: date - name: page in: query description: Número da página. schema: type: integer format: int32 default: 1 - name: size in: query description: Quantidade de itens por página. schema: type: integer format: int32 default: 10 responses: "200": description: "200" content: application/json: examples: Result: value: >- { "data": [ { "id": "hook_98kmOL1sMfnZqoPL", "url": "https://70cfee17.ngrok.io/notifications/payment", "account": { "id": "acc_jZkdN857et650oNv", "name": "Lojinha" }, "event": "order.paid", "status": "failed", "attempts": "3/3", "last_attempt": "2017-03-24T21:32:07Z", "created_at": "2017-03-24T21:21:59Z", "response_status": 404, "response_raw": "Tunnel 70cfee17.ngrok.io not found", "data": { "id": "or_e36l73IwgF7MlJwx", "code": "ER30H4MU4N", "amount": 199, "currency": "BRL", "closed": true, "items": [ { "id": "oi_NqW9Rb2LTbsqRa3n", "description": "FLIP Payment", "amount": 199, "quantity": 1, "status": "active", "created_at": "2017-03-24T21:21:58Z", "updated_at": "2017-03-24T21:21:58Z" } ], "customer": { "id": "cus_le6ZqXjiBSEOWdoA", "name": "Matheus Moreira", "email": "mmoreira@pagar.me", "delinquent": false, "created_at": "2016-11-25T23:45:04Z", "updated_at": "2016-12-26T21:34:45Z" }, "status": "paid", "created_at": "2017-03-24T21:21:58Z", "updated_at": "2017-03-24T21:21:59Z", "closed_at": "2017-03-24T21:21:59Z", "charge": { "id": "ch_56YNm9akt4i6mKQ8", "code": "ER30H4MU4N", "gateway_id": "b21c20f8-21e1-4f56-ac1c-34425c9e9dc9", "amount": 199, "status": "paid", "currency": "BRL", "payment_method": "credit_card", "due_at": "2017-03-24T00:00:00Z", "paid_at": "2017-03-24T21:21:59Z", "created_at": "2017-03-24T21:21:58Z", "updated_at": "2017-03-24T21:21:58Z", "customer": { "id": "cus_le6ZqXjiBSEOWdoA", "name": "Matheus Moreira", "email": "mmoreira@pagar.me", "delinquent": false, "created_at": "2016-11-25T23:45:04Z", "updated_at": "2016-12-26T21:34:45Z" }, "last_transaction": { "id": "tran_MpnYkMXhOBTb7Ze8", "transaction_type": "credit_card", "funding_source": "prepaid", "gateway_id": "9ac7ee2c-02a1-4b19-9f7e-168739a0427b", "amount": 199, "status": "captured", "success": true, "installments": 1, "acquirer_name": "simulator", "acquirer_affiliation_code": "125", "acquirer_tid": "266699", "acquirer_nsu": "848780", "acquirer_auth_code": "125", "acquirer_message": "Simulator|Transação de simulação autorizada com sucesso", "acquirer_return_code": "0", "operation_type": "auth_and_capture", "credit_card": { "id": "card_yB3ma9rS8HW7mnA9", "last_four_digits": "8229", "brand": "Amex", "holder_name": "Tony Stark", "exp_month": 1, "exp_year": 2018, "status": "active", "created_at": "2016-11-29T21:14:07Z", "updated_at": "2016-11-29T21:14:07Z", "billing_address": { "zip_code": "90265", "city": "Malibu", "state": "CA", "country": "US", "line_1": "10880, Malibu Point, Malibu Central" } }, "created_at": "2017-03-24T21:21:58Z", "updated_at": "2017-03-24T21:21:58Z" } }, "charges": [ { "id": "ch_56YNm9akt4i6mKQ8", "code": "ER30H4MU4N", "gateway_id": "b21c20f8-21e1-4f56-ac1c-34425c9e9dc9", "amount": 199, "status": "paid", "currency": "BRL", "payment_method": "credit_card", "funding_source": "prepaid", "due_at": "2017-03-24T00:00:00Z", "paid_at": "2017-03-24T21:21:59Z", "created_at": "2017-03-24T21:21:58Z", "updated_at": "2017-03-24T21:21:58Z", "customer": { "id": "cus_le6ZqXjiBSEOWdoA", "name": "Matheus Moreira", "email": "mmoreira@pagar.me", "delinquent": false, "created_at": "2016-11-25T23:45:04Z", "updated_at": "2016-12-26T21:34:45Z" }, "last_transaction": { "id": "tran_MpnYkMXhOBTb7Ze8", "transaction_type": "credit_card", "gateway_id": "9ac7ee2c-02a1-4b19-9f7e-168739a0427b", "amount": 199, "status": "captured", "success": true, "installments": 1, "acquirer_name": "simulator", "acquirer_affiliation_code": "1236", "acquirer_tid": "266699", "acquirer_nsu": "848780", "acquirer_auth_code": "12234", "acquirer_message": "Simulator|Transação de simulação autorizada com sucesso", "acquirer_return_code": "0", "operation_type": "auth_and_capture", "credit_card": { "id": "card_yB3ma9rS8HW7mnA9", "first_six_digits": "342793", "last_four_digits": "8229", "brand": "Amex", "holder_name": "Tony Stark", "exp_month": 1, "exp_year": 2018, "status": "active", "created_at": "2016-11-29T21:14:07Z", "updated_at": "2016-11-29T21:14:07Z", "billing_address": { "zip_code": "90265", "city": "Malibu", "state": "CA", "country": "US", "line_1": "10880, Malibu Point, Malibu Central" } }, "created_at": "2017-03-24T21:21:58Z", "updated_at": "2017-03-24T21:21:58Z" } } ] } } ], "paging": { "total": 34, "next": "https://api.stone.com.br/core/v5/hooks?since=2017-03-05&page=2&size=1" } } schema: type: object properties: data: type: array items: type: object properties: id: type: string example: hook_98kmOL1sMfnZqoPL url: type: string example: https://70cfee17.ngrok.io/notifications/payment account: type: object properties: id: type: string example: acc_jZkdN857et650oNv name: type: string example: Lojinha event: type: string example: order.paid status: type: string example: failed attempts: type: string example: 3/3 last_attempt: type: string example: 2017-03-24T21:32:07Z created_at: type: string example: 2017-03-24T21:21:59Z response_status: type: integer example: 404 default: 0 response_raw: type: string example: Tunnel 70cfee17.ngrok.io not found data: type: object properties: id: type: string example: or_e36l73IwgF7MlJwx code: type: string example: ER30H4MU4N amount: type: integer example: 199 default: 0 currency: type: string example: BRL closed: type: boolean example: true default: true items: type: array items: type: object properties: id: type: string example: oi_NqW9Rb2LTbsqRa3n description: type: string example: FLIP Payment amount: type: integer example: 199 default: 0 quantity: type: integer example: 1 default: 0 status: type: string example: active created_at: type: string example: 2017-03-24T21:21:58Z updated_at: type: string example: 2017-03-24T21:21:58Z customer: type: object properties: id: type: string example: cus_le6ZqXjiBSEOWdoA name: type: string example: Matheus Moreira email: type: string example: mmoreira@pagar.me delinquent: type: boolean example: false default: true created_at: type: string example: 2016-11-25T23:45:04Z updated_at: type: string example: 2016-12-26T21:34:45Z status: type: string example: paid created_at: type: string example: 2017-03-24T21:21:58Z updated_at: type: string example: 2017-03-24T21:21:59Z closed_at: type: string example: 2017-03-24T21:21:59Z charge: type: object properties: id: type: string example: ch_56YNm9akt4i6mKQ8 code: type: string example: ER30H4MU4N gateway_id: type: string example: b21c20f8-21e1-4f56-ac1c-34425c9e9dc9 amount: type: integer example: 199 default: 0 status: type: string example: paid currency: type: string example: BRL payment_method: type: string example: credit_card due_at: type: string example: 2017-03-24T00:00:00Z paid_at: type: string example: 2017-03-24T21:21:59Z created_at: type: string example: 2017-03-24T21:21:58Z updated_at: type: string example: 2017-03-24T21:21:58Z customer: type: object properties: id: type: string example: cus_le6ZqXjiBSEOWdoA name: type: string example: Matheus Moreira email: type: string example: mmoreira@pagar.me delinquent: type: boolean example: false default: true created_at: type: string example: 2016-11-25T23:45:04Z updated_at: type: string example: 2016-12-26T21:34:45Z last_transaction: type: object properties: id: type: string example: tran_MpnYkMXhOBTb7Ze8 transaction_type: type: string example: credit_card funding_source: type: string example: prepaid gateway_id: type: string example: 9ac7ee2c-02a1-4b19-9f7e-168739a0427b amount: type: integer example: 199 default: 0 status: type: string example: captured success: type: boolean example: true default: true installments: type: integer example: 1 default: 0 acquirer_name: type: string example: simulator acquirer_affiliation_code: type: string example: "125" acquirer_tid: type: string example: "266699" acquirer_nsu: type: string example: "848780" acquirer_auth_code: type: string example: "125" acquirer_message: type: string example: Simulator|Transação de simulação autorizada com sucesso acquirer_return_code: type: string example: "0" operation_type: type: string example: auth_and_capture credit_card: type: object properties: id: type: string example: card_yB3ma9rS8HW7mnA9 last_four_digits: type: string example: "8229" brand: type: string example: Amex holder_name: type: string example: Tony Stark exp_month: type: integer example: 1 default: 0 exp_year: type: integer example: 2018 default: 0 status: type: string example: active created_at: type: string example: 2016-11-29T21:14:07Z updated_at: type: string example: 2016-11-29T21:14:07Z billing_address: type: object properties: zip_code: type: string example: "90265" city: type: string example: Malibu state: type: string example: CA country: type: string example: US line_1: type: string example: 10880, Malibu Point, Malibu Central created_at: type: string example: 2017-03-24T21:21:58Z updated_at: type: string example: 2017-03-24T21:21:58Z charges: type: array items: type: object properties: id: type: string example: ch_56YNm9akt4i6mKQ8 code: type: string example: ER30H4MU4N gateway_id: type: string example: b21c20f8-21e1-4f56-ac1c-34425c9e9dc9 amount: type: integer example: 199 default: 0 status: type: string example: paid currency: type: string example: BRL payment_method: type: string example: credit_card funding_source: type: string example: prepaid due_at: type: string example: 2017-03-24T00:00:00Z paid_at: type: string example: 2017-03-24T21:21:59Z created_at: type: string example: 2017-03-24T21:21:58Z updated_at: type: string example: 2017-03-24T21:21:58Z customer: type: object properties: id: type: string example: cus_le6ZqXjiBSEOWdoA name: type: string example: Matheus Moreira email: type: string example: mmoreira@pagar.me delinquent: type: boolean example: false default: true created_at: type: string example: 2016-11-25T23:45:04Z updated_at: type: string example: 2016-12-26T21:34:45Z last_transaction: type: object properties: id: type: string example: tran_MpnYkMXhOBTb7Ze8 transaction_type: type: string example: credit_card gateway_id: type: string example: 9ac7ee2c-02a1-4b19-9f7e-168739a0427b amount: type: integer example: 199 default: 0 status: type: string example: captured success: type: boolean example: true default: true installments: type: integer example: 1 default: 0 acquirer_name: type: string example: simulator acquirer_affiliation_code: type: string example: "1236" acquirer_tid: type: string example: "266699" acquirer_nsu: type: string example: "848780" acquirer_auth_code: type: string example: "12234" acquirer_message: type: string example: Simulator|Transação de simulação autorizada com sucesso acquirer_return_code: type: string example: "0" operation_type: type: string example: auth_and_capture credit_card: type: object properties: id: type: string example: card_yB3ma9rS8HW7mnA9 first_six_digits: type: string example: "342793" last_four_digits: type: string example: "8229" brand: type: string example: Amex holder_name: type: string example: Tony Stark exp_month: type: integer example: 1 default: 0 exp_year: type: integer example: 2018 default: 0 status: type: string example: active created_at: type: string example: 2016-11-29T21:14:07Z updated_at: type: string example: 2016-11-29T21:14:07Z billing_address: type: object properties: zip_code: type: string example: "90265" city: type: string example: Malibu state: type: string example: CA country: type: string example: US line_1: type: string example: 10880, Malibu Point, Malibu Central created_at: type: string example: 2017-03-24T21:21:58Z updated_at: type: string example: 2017-03-24T21:21:58Z paging: type: object properties: total: type: integer example: 34 default: 0 next: type: string example: https://api.stone.com.br/core/v5/hooks?since=2017-03-05&page=2&size=1 "400": description: "400" content: application/json: examples: Result: value: "{}" schema: type: object properties: {} deprecated: false security: - sec0: [] components: securitySchemes: sec0: type: http scheme: basic ```