{"openapi":"3.0.0","paths":{"/api/v1/charges":{"get":{"operationId":"PaymentsController_list","parameters":[],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]},"post":{"operationId":"PaymentsController_create","parameters":[{"name":"idempotency-key","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChargeDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/plans":{"get":{"operationId":"PaymentsController_listPlans","parameters":[],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]},"post":{"operationId":"PaymentsController_createPlan","parameters":[{"name":"idempotency-key","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentPlanDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/balance":{"get":{"operationId":"PaymentsController_balance","parameters":[],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/transfers":{"get":{"operationId":"PaymentsController_transfers","parameters":[],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]},"post":{"operationId":"PaymentsController_sendPix","parameters":[{"name":"idempotency-key","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendPixDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/transfers/{id}":{"get":{"operationId":"PaymentsController_transfer","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/bill-payments":{"get":{"operationId":"PaymentsController_billPayments","parameters":[],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]},"post":{"operationId":"PaymentsController_payBill","parameters":[{"name":"idempotency-key","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayBillDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/items":{"get":{"operationId":"PaymentsController_listChargeItems","parameters":[{"name":"incluirInativos","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]},"post":{"operationId":"PaymentsController_createChargeItem","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChargeItemDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/items/{id}":{"patch":{"operationId":"PaymentsController_updateChargeItem","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChargeItemDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/item-categories":{"get":{"operationId":"PaymentsController_listChargeItemCategories","parameters":[],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]},"post":{"operationId":"PaymentsController_createChargeItemCategory","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeItemCategoryDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/item-categories/{id}":{"patch":{"operationId":"PaymentsController_updateChargeItemCategory","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeItemCategoryDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/withdrawals/balance":{"get":{"operationId":"PaymentsController_withdrawableBalance","parameters":[],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/withdrawals":{"get":{"operationId":"PaymentsController_listWithdrawals","parameters":[],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]},"post":{"operationId":"PaymentsController_requestWithdrawal","parameters":[{"name":"idempotency-key","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestWithdrawalDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/withdrawals/{id}/cancel":{"post":{"operationId":"PaymentsController_cancelWithdrawal","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/{id}/send-email":{"post":{"operationId":"PaymentsController_sendChargeEmail","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendChargeEmailDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/{id}":{"get":{"operationId":"PaymentsController_get","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/{id}/events":{"get":{"operationId":"PaymentsController_events","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/plans/{id}/cancel":{"post":{"operationId":"PaymentsController_cancelPlan","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelChargeDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/{id}/cancel":{"post":{"operationId":"PaymentsController_cancel","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelChargeDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/{id}/simulate-payment":{"post":{"operationId":"PaymentsController_simulatePayment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/{id}/reconcile":{"post":{"operationId":"PaymentsController_reconcile","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/transfers/key-lookup":{"post":{"operationId":"PaymentsController_lookupPixKey","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupPixKeyDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/charges/bill-payments/details":{"post":{"operationId":"PaymentsController_billDetails","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupBarcodeDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["charges"]}},"/api/v1/public/charges/{token}":{"get":{"operationId":"PublicPaymentsController_charge","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["public payments"]}},"/api/v1/public/plans/{token}":{"get":{"operationId":"PublicPaymentsController_plan","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["public payments"]}},"/api/v1/webhook-endpoints":{"get":{"operationId":"WebhookEndpointsController_list","parameters":[],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["webhook endpoints"]},"post":{"operationId":"WebhookEndpointsController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookEndpointDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["webhook endpoints"]}},"/api/v1/webhook-endpoints/{id}":{"delete":{"operationId":"WebhookEndpointsController_remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["webhook endpoints"]}},"/api/v1/webhook-endpoints/{id}/rotate-secret":{"post":{"operationId":"WebhookEndpointsController_rotate","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["webhook endpoints"]}},"/api/v1/webhook-endpoints/deliveries":{"get":{"operationId":"WebhookEndpointsController_deliveries","parameters":[{"name":"endpointId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["webhook endpoints"]}},"/api/v1/webhook-endpoints/deliveries/{id}/resend":{"post":{"operationId":"WebhookEndpointsController_resend","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["webhook endpoints"]}},"/api/v1/customers":{"get":{"operationId":"CustomersController_list","parameters":[{"name":"q","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["customers"]},"post":{"operationId":"CustomersController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomerDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"tags":["customers"]}},"/api/v1/customers/{id}":{"get":{"operationId":"CustomersController_get","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["customers"]},"patch":{"operationId":"CustomersController_update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomerDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"tags":["customers"]}}},"info":{"title":"PAGUEO API","description":"API pública de cobrança Pix: cobranças, carnês, clientes e webhooks. Guia: https://pagueo.com.br/docs · versão em texto para agentes de IA: https://pagueo.com.br/llms.txt","version":"1.0","contact":{}},"tags":[],"servers":[{"url":"https://pagueo-api.apps.devoracloud.com"}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","description":"Chave de API (vk_test_… ou vk_live_…)."}},"schemas":{"CreateChargeItemDto":{"type":"object","properties":{"name":{"type":"string","example":"Mensalidade do plano Pro"},"description":{"type":"string","example":"Acesso completo à plataforma, cobrado todo dia 10."},"defaultAmountCents":{"type":"number","example":14990,"description":"Valor sugerido em centavos de BRL. A cobrança grava o valor dela."},"categoryId":{"type":"string","example":"clx_category_id","description":"Categoria do item. Precisa ser da mesma conta."}},"required":["name"]},"UpdateChargeItemDto":{"type":"object","properties":{"name":{"type":"string","example":"Mensalidade do plano Pro"},"description":{"type":"object","example":"Acesso completo à plataforma."},"defaultAmountCents":{"type":"object","example":14990,"description":"Valor sugerido em centavos de BRL."},"categoryId":{"type":"object","example":"clx_category_id","description":"Vazio remove a categoria do item."},"active":{"type":"boolean","example":false,"description":"false desativa o item: ele some da escolha e permanece no histórico."}}},"ChargeItemCategoryDto":{"type":"object","properties":{"name":{"type":"string","example":"Serviços recorrentes"}},"required":["name"]},"RequestWithdrawalDto":{"type":"object","properties":{"amountCents":{"type":"number","example":5000,"description":"Valor em centavos de BRL."},"pixKey":{"type":"string","example":"cnpj@empresa.com","description":"Chave Pix para onde o cliente quer receber."},"note":{"type":"string","example":"Repasse semanal","description":"Observação opcional para o dono."},"transferPassword":{"type":"string","example":"••••••","description":"Senha de transferência (não é a senha de acesso)."},"otpChallengeId":{"type":"string","example":"clx_financial_challenge_id"},"otpCode":{"type":"string","example":"482931"}},"required":["amountCents","pixKey","transferPassword","otpChallengeId","otpCode"]},"SendChargeEmailDto":{"type":"object","properties":{"email":{"type":"string","example":"cliente@exemplo.com","description":"E-mail do cliente da cobrança. Se omitido, usa o cadastrado."}}},"CreateChargeDto":{"type":"object","properties":{"amountCents":{"type":"number","example":14990,"description":"Valor em centavos de BRL."},"description":{"type":"string","example":"Licença do plano Pro","description":"Obrigatória quando não vier `chargeItemId`."},"chargeItemId":{"type":"string","example":"clx_charge_item_id"},"customerId":{"type":"string","example":"clx_customer_id"},"externalId":{"type":"string","example":"pedido-1033"},"environment":{"type":"string","enum":["TEST","LIVE"],"default":"TEST"},"expiresInSeconds":{"type":"number","example":3600},"payerName":{"type":"string","example":"Maria da Silva"},"payerDocument":{"type":"string","example":"12345678901"}},"required":["amountCents"]},"CreatePaymentPlanDto":{"type":"object","properties":{"title":{"type":"string","example":"Carnê Plano Pro"},"installmentAmountCents":{"type":"number","example":12500,"description":"Valor de cada parcela em centavos de BRL."},"installmentCount":{"type":"number","example":6},"firstDueDate":{"type":"string","example":"2026-10-10"},"description":{"type":"string","example":"Mensalidade referente ao contrato 1033"},"customerId":{"type":"string","example":"clx_customer_id"},"environment":{"type":"string","enum":["TEST","LIVE"],"default":"TEST"}},"required":["title","installmentAmountCents","installmentCount","firstDueDate"]},"CancelChargeDto":{"type":"object","properties":{"reason":{"type":"string","example":"Pedido cancelado pelo cliente","description":"Motivo interno para auditoria."}}},"LookupPixKeyDto":{"type":"object","properties":{"pixKey":{"type":"string","example":"cliente@exemplo.com","description":"CPF, CNPJ, e-mail, telefone com DDD ou chave aleatória."},"pixKeyType":{"type":"string","enum":["CPF","CNPJ","TELEFONE","EMAIL","ALEATORIA"]}},"required":["pixKey"]},"SendPixDto":{"type":"object","properties":{"amountCents":{"type":"number","example":2500,"description":"Valor em centavos de BRL."},"pixKey":{"type":"string","example":"cliente@exemplo.com"},"pixKeyType":{"type":"string","enum":["CPF","CNPJ","TELEFONE","EMAIL","ALEATORIA"]},"favorecidoDocumento":{"type":"string","example":"12453401661","description":"CPF ou CNPJ do favorecido. Se informado, o provedor recusa a transferência quando a chave não pertence a ele."},"description":{"type":"string","example":"Repasse do pedido 1033"},"transferPassword":{"type":"string","example":"••••••","description":"Senha de transferência (não é a senha de acesso)."},"otpChallengeId":{"type":"string","example":"clx_financial_challenge_id"},"otpCode":{"type":"string","example":"482931"}},"required":["amountCents","pixKey","description","transferPassword","otpChallengeId","otpCode"]},"LookupBarcodeDto":{"type":"object","properties":{"barcode":{"type":"string","example":"836600000015123400481009180975007004123456789012","description":"Código de barras ou linha digitável, com 44 a 48 dígitos."}},"required":["barcode"]},"PayBillDto":{"type":"object","properties":{"barcode":{"type":"string","example":"836600000015123400481009180975007004123456789012","description":"Código de barras ou linha digitável, com 44 a 48 dígitos."},"amountCents":{"type":"number","example":1512,"description":"Valor final confirmado na consulta, em centavos de BRL."},"description":{"type":"string","example":"Conta de energia - setembro"},"paymentDate":{"type":"string","example":"2026-09-05","description":"Data de pagamento. Se omitida, solicita o pagamento para a data atual."},"environment":{"type":"string","enum":["TEST","LIVE"],"default":"TEST"},"transferPassword":{"type":"string","example":"••••••","description":"Senha de transferência (não é a senha de acesso)."},"otpChallengeId":{"type":"string","example":"clx_financial_challenge_id"},"otpCode":{"type":"string","example":"482931"}},"required":["barcode","amountCents","description","transferPassword","otpChallengeId","otpCode"]},"CreateWebhookEndpointDto":{"type":"object","properties":{"url":{"type":"string","example":"https://seusistema.com.br/webhooks/pagueo","description":"Endereco https que vai receber as notificacoes. Precisa ser publico."},"description":{"type":"string","example":"Loja principal","description":"So para voce reconhecer depois."},"events":{"example":["charge.paid"],"description":"Eventos assinados. Em branco, assina todos.","type":"array","items":{"type":"string"}}},"required":["url"]},"CreateCustomerDto":{"type":"object","properties":{"name":{"type":"string","example":"Maria da Silva Souza","description":"Nome completo, como no documento."},"document":{"type":"string","example":"12345678901","description":"CPF ou CNPJ. Máscara é aceita e descartada."},"phone":{"type":"string","example":"11999990000","description":"Telefone com DDD. Aceita máscara e o 55 na frente."},"email":{"type":"string","example":"maria@empresa.com.br"},"identityDocument":{"type":"string","example":"MG-12.345.678","description":"RG ou outro documento de identidade."},"gender":{"type":"string","enum":["FEMALE","MALE","OTHER","UNDISCLOSED"]},"addressStreet":{"type":"string","example":"Rua das Acácias"},"addressNumber":{"type":"string","example":"1033"},"addressComplement":{"type":"string","example":"Apto 42"},"addressNeighborhood":{"type":"string","example":"Centro"},"addressCity":{"type":"string","example":"Belo Horizonte"},"addressState":{"type":"string","example":"MG","description":"Sigla da UF, duas letras."},"addressPostalCode":{"type":"string","example":"30110000"},"externalCode":{"type":"string","example":"cliente-1033","description":"Seu código para este cliente, se você tiver um."}},"required":["name","document","phone"]},"UpdateCustomerDto":{"type":"object","properties":{"name":{"type":"string","example":"Maria da Silva Souza","description":"Nome completo, como no documento."},"document":{"type":"string","example":"12345678901","description":"CPF ou CNPJ. Máscara é aceita e descartada."},"phone":{"type":"string","example":"11999990000","description":"Telefone com DDD. Aceita máscara e o 55 na frente."},"email":{"type":"string","example":"maria@empresa.com.br"},"identityDocument":{"type":"string","example":"MG-12.345.678","description":"RG ou outro documento de identidade."},"gender":{"type":"string","enum":["FEMALE","MALE","OTHER","UNDISCLOSED"]},"addressStreet":{"type":"string","example":"Rua das Acácias"},"addressNumber":{"type":"string","example":"1033"},"addressComplement":{"type":"string","example":"Apto 42"},"addressNeighborhood":{"type":"string","example":"Centro"},"addressCity":{"type":"string","example":"Belo Horizonte"},"addressState":{"type":"string","example":"MG","description":"Sigla da UF, duas letras."},"addressPostalCode":{"type":"string","example":"30110000"},"externalCode":{"type":"string","example":"cliente-1033","description":"Seu código para este cliente, se você tiver um."}}}}}}