> ## Documentation Index > Fetch the complete documentation index at: https://docs.besimplo.com/llms.txt > Use this file to discover all available pages before exploring further. # Consultar cobrança > Consultar uma cobrança existente na sua conta pelo ID. É o mesmo objeto que chega em `data.object` nos eventos `payment_intent.*`. **Limite de taxa:** 100 requisições por minuto por chave de API. ## OpenAPI ````yaml /api-reference/openapi.yml get /api/v1/payment_intents/{id} openapi: 3.1.0 info: title: API - Simplo version: 1.0.0 description: API para cobrança e assinaturas para contas Simplo contact: name: Simplo url: https://besimplo.com email: team@besimplo.com servers: - url: https://besimplo.com description: Produção security: - apiKeyAuth: [] tags: - name: Clientes description: Clientes são as pessoas que pagarão pelos produtos da sua conta - name: Produtos description: Produtos representam os bens ou serviços que você vende - name: Preços description: Preços definem quanto cobrar e a frequência de cobrança de um Produto - name: Assinaturas description: Assinaturas conectam clientes aos seus planos para cobrança recorrente - name: Checkout description: >- Sessões de checkout permitem que clientes completem pagamentos e assinaturas através de uma interface web - name: Faturas description: Faturas representam cobranças geradas para clientes - name: Tentativas de cobrança description: >- Cada tentativa de receber o valor de uma fatura, com vencimento próprio e limite de tentativas - name: Eventos description: > O registro do que aconteceu na conta, com o corpo congelado no instante do fato. O evento existe tenha ele sido entregue ou não: a entrega por webhook é um consumidor dele. Consulte, filtre pelo resultado da entrega e reenvie o que não chegou. - name: Webhooks description: > Os eventos do catálogo, enviados por HTTP POST para os endpoints cadastrados na sua conta. Cada conta registra até 5 endpoints, cada um com a sua URL, o seu filtro de eventos e o seu segredo. O corpo é o próprio evento: `"object": "event"` no topo, e `data.object` com o recurso a que ele se refere, no mesmo formato em que `GET /api/v1//{id}` o devolve. Toda entrega vai assinada, no padrão [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md). São três cabeçalhos — `webhook-id`, `webhook-timestamp` e `webhook-signature` — e a chave é o segredo `whsec_` daquele endpoint, visível no painel em **Configurações → Webhooks**. Responda 2xx rápido e processe depois. Uma entrega que falha é retentada até 10 vezes ao longo de 93 horas, então o mesmo evento pode chegar duas vezes: use o `evt_` do cabeçalho `webhook-id` como chave de idempotência. O que não chegou continua consultável por 30 dias em `GET /api/v1/events`, e `POST /api/v1/events/{id}/resend` manda de novo. paths: /api/v1/payment_intents/{id}: get: tags: - Tentativas de cobrança summary: Consultar cobrança description: > Consultar uma cobrança existente na sua conta pelo ID. É o mesmo objeto que chega em `data.object` nos eventos `payment_intent.*`. **Limite de taxa:** 100 requisições por minuto por chave de API. operationId: getPaymentIntent parameters: - name: id in: path description: ID da cobrança, no formato TypeID com prefixo `pi_`. required: true schema: type: string pattern: ^pi_[0-9a-z]{26}$ example: pi_01h455vb4pex5vsknk084sn02r responses: '200': description: Operação realizada com sucesso content: application/json: schema: unevaluatedProperties: false allOf: - type: object required: - id - object - amount - attempts - created - currency - customer - due_at - invoice - live_mode - max_attempts - status properties: id: type: string pattern: ^pi_[0-9a-z]{26}$ readOnly: true description: >- ID único da cobrança, no formato TypeID com prefixo `pi_`. example: pi_01h455vb4pex5vsknk084sn02r object: type: string description: Tipo do objeto. Sempre 'payment_intent'. enum: - payment_intent example: payment_intent amount: type: integer description: Valor a cobrar em centavos. R$ 99,90 = 9990. example: 9990 attempts: type: integer description: Quantas tentativas de cobrança já foram feitas. example: 1 created: type: integer format: int64 readOnly: true description: Timestamp Unix da criação da cobrança. example: 1704672000 currency: type: string description: Moeda do valor. Sempre 'brl' (Real brasileiro). enum: - brl example: brl customer: type: string pattern: ^cus_[0-9a-z]{26}$ description: >- ID do cliente cobrado, no formato TypeID com prefixo `cus_`. example: cus_01h455vb4pex5vsknk084sn02p due_at: type: integer format: int64 description: Timestamp Unix do vencimento da cobrança. example: 1704758400 installments: type: - integer - 'null' nullable: true description: >- Número de parcelas da cobrança no cartão. `1` para cobrança à vista. example: 1 invoice: type: string pattern: ^in_[0-9a-z]{26}$ description: >- ID da fatura que a cobrança liquida, no formato TypeID com prefixo `in_`. example: in_01h455vb4pex5vsknk084sn02q last_payment_error: type: - object - 'null' nullable: true description: > Motivo da última tentativa recusada, ou `null` enquanto nenhuma tentativa falhou. É zerado quando uma nova tentativa começa. O código da adquirente não sai do sistema: a Simplo é multiadquirente por desenho, e estes seis códigos continuam válidos quando a mesma fatura for cobrada por outra adquirente. required: - code - message - retryable properties: code: type: string description: > Motivo da recusa. - card_declined: Recusa genérica do emissor, incluindo saldo insuficiente. - card_expired: Cartão vencido. - card_invalid: Dados do cartão inválidos. - card_canceled: Cartão cancelado pelo emissor. - card_blocked: Cartão bloqueado pelo emissor. - processing_error: Falha no processamento; o cartão não é a causa. enum: - card_declined - card_expired - card_invalid - card_canceled - card_blocked - processing_error example: card_declined message: type: string description: >- Descrição da recusa, pronta para ser exibida ao pagador. example: O banco emissor recusou a cobrança. retryable: type: boolean description: >- Indica se vale a pena cobrar o mesmo cartão de novo. example: false live_mode: type: boolean description: >- Indica ambiente de produção (true) ou sandbox (false). Dados de sandbox são limpos periodicamente. example: true max_attempts: type: integer description: >- Limite de tentativas antes de a cobrança parar de ser reprocessada. example: 3 next_attempt: type: - integer - 'null' nullable: true format: int64 description: | Timestamp Unix da próxima tentativa automática. `null` quando não há retentativa agendada. example: 1704844800 payment_method_type: type: - string - 'null' nullable: true description: > Meio de pagamento pelo qual o dinheiro se moveu, derivado da transação gerada pela cobrança. `null` enquanto nenhum checkout escolheu um meio. enum: - pix - card - null example: pix status: type: string description: > Status atual da cobrança. - pending: Aguardando processamento. - processing: Em processamento na adquirente. - paid: Paga. - failed: Recusada; pode ser retentada até `max_attempts`. - refunding: Estorno solicitado. - refunded: Estornada. - discarded: Substituída por um checkout que assumiu a fatura. enum: - pending - processing - paid - failed - refunding - refunded - discarded example: pending status_transitions: type: object description: | Timestamps de quando a cobrança mudou de status. Campos são null se a transição ainda não ocorreu. properties: paid_at: type: - integer - 'null' nullable: true format: int64 description: Timestamp Unix de quando a cobrança foi paga. example: 1704758400 subscription: type: - string - 'null' nullable: true pattern: ^sub_[0-9a-z]{26}$ description: >- ID da assinatura que originou a fatura (se aplicável), no formato TypeID com prefixo `sub_`. example: sub_01h455vb4pex5vsknk084sn02s example: id: pi_01h455vb4pex5vsknk084sn02r object: payment_intent amount: 9990 attempts: 1 created: 1764040287 currency: brl customer: cus_01h455vb4pex5vsknk084sn02p due_at: 1764126687 installments: 1 invoice: in_01h455vb4pex5vsknk084sn02q live_mode: true max_attempts: 3 next_attempt: null payment_method_type: pix status: paid status_transitions: paid_at: 1764043887 subscription: sub_01h455vb4pex5vsknk084sn02s '404': description: Não encontrado content: application/problem+json: schema: type: object required: - type - status - title - detail - code properties: type: type: string description: URI que identifica o tipo de problema format: uri enum: - https://problems-registry.smartbear.com/not-found status: type: integer description: O código de status HTTP format: int32 enum: - 404 title: type: string description: O nome do status HTTP enum: - Not Found detail: type: string description: Mensagem descritiva do erro code: type: string description: Código de erro interno da API enum: - NOT_FOUND - RESOURCE_MISSING examples: not_found: summary: Recurso não encontrado value: type: https://problems-registry.smartbear.com/not-found status: 404 title: Not Found detail: The requested resource was not found code: NOT_FOUND customer_not_found: summary: Cliente não encontrado value: type: https://problems-registry.smartbear.com/not-found status: 404 title: Not Found detail: 'No such customer: ''019abc12-3456-7890-abcd-ef1234567890''' code: RESOURCE_MISSING components: securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: > A chave de API usada para autenticar a requisição e identificar a sua conta. **Exemplo:** `Authorization: ApiKey my-secure-key` ````