> ## Documentation Index > Fetch the complete documentation index at: https://docs.rivoopay.com/llms.txt > Use this file to discover all available pages before exploring further. # Buscar Cobrança por ID > Retorna os detalhes de uma cobrança pelo seu ID ## OpenAPI ````yaml GET /charge/{id} openapi: 3.0.0 info: title: payera-api description: Documentação de endpoints e entidades da payera version: '1.0' contact: {} servers: - url: https://api.rivoopay.com security: - ApiKeyAuth: [] paths: /charge/{id}: get: tags: - Charges summary: Buscar cobrança por ID description: Retorna os detalhes de uma cobrança pelo seu ID operationId: ChargeController_getById parameters: - name: id required: true in: path description: ID da cobrança schema: type: string responses: '200': description: Cobrança encontrada content: application/json: schema: $ref: '#/components/schemas/GetChargeByIdResponseDto' '404': description: Cobrança não encontrada components: schemas: GetChargeByIdResponseDto: type: object properties: status: type: number message: type: string data: $ref: '#/components/schemas/ChargeDetailDto' required: - status - message - data ChargeDetailDto: type: object properties: id: type: string example: charge_123456 description: ID único da cobrança total: type: number example: 100000 description: 'Valor total da cobrança em centavos (ex: 100000 = R$ 1000,00)' url: type: string example: https://pay.rivoopay.com/c/charge_123456 description: URL de pagamento onde o cliente pode realizar o pagamento status: type: string example: OPEN enum: - OPEN - COMPLETED - EXPIRED - CANCELED description: >- Status atual da cobrança (OPEN: aguardando pagamento, COMPLETED: pago, EXPIRED: expirado, CANCELED: cancelado) paymentStatus: type: string example: PROCESSING enum: - PROCESSING - PAID - RECIEVED - EXPIRED - REFUNDED description: >- Status do processamento do pagamento (PROCESSING: processando, PAID: pago, RECIEVED: recebido, EXPIRED: expirado, REFUNDED: reembolsado) paymentDate: format: date-time type: string example: '2024-12-03T10:30:00.000Z' description: Data e hora em que o pagamento foi realizado successUrl: type: string example: https://example.com/success description: URL de redirecionamento em caso de pagamento bem-sucedido failedUrl: type: string example: https://example.com/failed description: URL de redirecionamento em caso de falha no pagamento devMode: type: boolean example: false description: Indica se a cobrança está em modo de desenvolvimento/teste needShipping: type: boolean example: false description: Indica se a cobrança requer informações de entrega/shipping brCode: type: string example: 00020101021226950014br.gov.bcb.pix... description: Código BR Code para pagamento via PIX brCodeBase64: type: string example: data:image/png;base64,iVBORw0KGgoAAA... description: QR Code em formato base64 para pagamento via PIX expiresAt: format: date-time type: string example: '2024-12-04T09:30:00.000Z' description: Data e hora de expiração da cobrança items: description: Itens detalhados da cobrança type: array items: $ref: '#/components/schemas/ChargeItemsDto' customer: description: Dados do cliente associado à cobrança allOf: - $ref: '#/components/schemas/CustomerChargeDto' company: description: Dados da empresa associada à cobrança allOf: - $ref: '#/components/schemas/CompanyChargeDTO' isRecurring: type: boolean description: true se a cobrança é uma assinatura/recorrência pixAutomaticEmv: type: string pixAutomaticQrCode: type: string description: QR code do EMV em PNG base64 (data URL), gerado pelo backend pixAutomaticPaymentLinkUrl: type: string recurrenceAuthStatus: type: string enum: - CREATED - APPROVED - REJECTED - CANCELED - EXPIRED recurrenceChargeId: type: string description: >- Id do acordo de recorrência já iniciado para este link (quando a assinatura já começou). O checkout usa esse id para abrir o QR de autorização direto, sem recriar o acordo. frequency: type: string enum: - WEEKLY - MONTHLY - SEMIANNUAL - ANNUAL required: - id - total - url - status - paymentStatus - devMode - needShipping - expiresAt - company ChargeItemsDto: type: object properties: productId: type: string example: prod_123456 description: ID do produto companyId: type: string example: company_123456 description: id da empresa proprietária do produto quantity: type: number example: 2 description: Quantidade do item product: description: Detalhes do produto associado ao item da cobrança allOf: - $ref: '#/components/schemas/ProductDTO' required: - productId - companyId - quantity CustomerChargeDto: type: object properties: name: type: string example: João da Silva description: Nome do cliente taxId: type: string example: '***.***.529-25' description: CPF ou CNPJ do cliente (mascarado) email: type: string example: j***@gmail.com description: Email do cliente (mascarado) phone: type: string example: (**) *****-9999 description: Telefone do cliente (mascarado) required: - name CompanyChargeDTO: type: object properties: taxId: type: string example: '36062381000180' description: Company I ID (CNPJ/CPF) name: type: string example: Empresa Bola Ltda description: Company name color: type: string example: '#000000' description: Company color imageUrl: type: string example: https://i.imgur.com/ONMjk45.jpeg description: Company Image required: - taxId - name - color ProductDTO: type: object properties: id: type: string description: Product identifier example: prod_01F4Z8Z5Y6X7W8V9U0T1S2R3Q4 maxLength: 255 name: type: string description: Product name example: Produto Bola maxLength: 255 description: type: string description: Product description example: Produto muito bom para uso diário price: type: number description: Product price in cents (centavos) example: 1990 minimum: 0 needShipping: type: boolean description: Indicates if the product requires shipping example: false default: false sku: type: string description: Stock Keeping Unit - unique identifier for inventory management example: SKU-ABCD-123 nullable: true imageUrl: type: string description: URL of the product image example: https://example.com/image.png format: uri nullable: true categories: type: array description: Product categories example: - Eletronicos e Tecnologia - Celulares e Smartphones items: type: string enum: - Jogos - Eletrônicos - Roupas - Acessórios - Casa e Decoração - Esportes - Brinquedos - UGC - Cursos - Serviços - Livros - E-books - Música - Filmes e Séries - Alimentos e Bebidas - SaaS - Outros companyId: type: string description: Company ID that owns this product example: f96a489c-8a4d-4c7b-a1f6-347acbd832df format: uuid status: type: string description: Product status example: ACTIVE enum: - ACTIVE - INACTIVE default: ACTIVE marketplaceStatus: type: string description: Marketplace status example: INACTIVE enum: - APPROVED - ANALYSIS - DECLINED - INACTIVE default: INACTIVE type: type: string enum: - ONE_TIME - RECURRING frequency: type: string enum: - WEEKLY - MONTHLY - SEMIANNUAL - ANNUAL description: Obrigatório quando type=RECURRING dayDue: type: number description: Prazo de pagamento em dias após a geração (1-7) minimum: 1 maximum: 7 dayGenerateCharge: type: number description: Dia de geração da cobr (1-28) minimum: 1 maximum: 28 required: - id - name - description - price - needShipping - companyId - status securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY ````