> ## Documentation Index > Fetch the complete documentation index at: https://nexus-docs.ticto.dev/llms.txt > Use this file to discover all available pages before exploring further. # Consultar status do PIX Automático > Retorna o estado atual do mandato de PIX Automático, consultado no Payments da Ticto. Traz campos que o detalhe não traz, como `cancelled_at`, `last_retry_at` e `subscription_canceled_at`. O token `Authorization: Bearer` deve ser do **produtor** do pedido que originou a assinatura. ## OpenAPI ````yaml /api-reference/openapi.yaml get /financial/pix-recurring/{subscription_code}/status openapi: 3.0.3 info: title: Nexus version: 1.0.2 description: > API para integração entre Ticto e clientes externos # Autenticação Para autenticar as solicitações aos endpoints descritos a seguir, por favor, siga os passos abaixo: 1. **Solicite** seu cadastro como cliente através do e-mail **infraestrutura@ticto.com.br** para obter seu `client_id` e `token`. 2. **Use** seu token e ID de cliente para fazer login no Nexus e obter seu `client_token`. 3. **Em todas as outras requisições**, envie seu `client_token` no header como `X-Api-Client-Token`. 4. **Crie** seus usuários na rota de criação de usuário. Para cada usuário, será retornado um `public_token` único. 5. **Para endpoints que não estão em public.php**, adicione o `public_token` do usuário no cabeçalho **Authorization** utilizando o formato: ```http Authorization: Bearer {public_token} ``` ## Restrição de origem O acesso a esta API não está disponível para todos os sellers. Seu uso é estritamente permitido para parceiros comerciais que a utilizarão em cenários específicos. Por este motivo, o acesso será restrito a endereços IP e domínios previamente informados por esses parceiros. Essa medida visa proporcionar um ambiente mais controlado e seguro para todos os nossos usuários e parceiros. ### O que isso significa para os desenvolvedores? - **Acesso Limitado:** Somente os IPs e domínios pré-autorizados poderão realizar chamadas à API. Qualquer tentativa de acesso de um IP ou domínio não listado será automaticamente rejeitada. - **Processo de Autorização:** Para garantir a continuidade do acesso à API sem interrupções, é essencial que os desenvolvedores enviem os endereços IP ou domínios que necessitam de acesso diretamente à nossa equipe de suporte. - **Como Solicitar Acesso:** Envie um e-mail para **liberacao@ticto.com.br** com o assunto _"Solicitação de Acesso à API de pagamentos"_, incluindo: - Nome da empresa ou do desenvolvedor - Endereços IP ou domínios a serem autorizados - Justificativa para o acesso - Informações de contato para eventuais esclarecimentos ## Alterações e/ou inclusão de novos domínios e IPs Recomendamos que solicitações de adição ou alteração de IPs/domínios sejam feitas o mais breve possível para garantir uma transição suave. Em casos de alterações, os domínios e/ou IPs anteriores serão imediatamente bloqueados após sua remoção. ## Suporte e Dúvidas Para dúvidas ou suporte adicional, entre em contato conosco através do e-mail **liberacao@ticto.com.br**. Estamos comprometidos em auxiliar neste processo e garantir a melhor experiência possível. servers: - url: https://nexus.ticto.com.br/api/v1 description: Produção security: [] tags: - name: Autenticação - name: Configurações do Cliente - name: Usuários - name: Onboarding de usuário - name: Contas Bancárias - name: Faixas de Taxa description: >- Endpoints para consulta de faixas de taxa personalizadas e histórico de alterações. - name: Frete - name: Financeiro - name: PIX Automático description: >- Consulta, cancelamento e nova tentativa de cobrança de assinaturas com PIX Automático (débito recorrente autorizado pelo pagador). - name: Produtos - name: Integrações - name: 'Webhooks: Usuários' description: Eventos relacionados a cadastro e atualização de usuários. - name: 'Webhooks: Contas Bancárias' description: Eventos relacionados a contas bancárias dos sellers. - name: 'Webhooks: Produtos e Ofertas' description: Eventos relacionados a produtos, ofertas, afiliados e coprodutores. - name: 'Webhooks: Financeiro' description: Eventos de reembolso, saque e antecipação. - name: 'Webhooks: Faixas de Taxa' description: Eventos de criação, atualização e exclusão de faixas de taxa. - name: 'Webhooks: Pedidos' description: Eventos de criação e atualização de pedidos. - name: 'Webhooks: Cobranças' description: >- Eventos de criação e mudança de status de cobranças (transações), na primeira compra e nas renovações. - name: 'Webhooks: Assinaturas' description: Eventos do ciclo de vida de assinaturas, cobranças e trial. paths: /financial/pix-recurring/{subscription_code}/status: get: tags: - PIX Automático summary: Consultar status do PIX Automático description: > Retorna o estado atual do mandato de PIX Automático, consultado no Payments da Ticto. Traz campos que o detalhe não traz, como `cancelled_at`, `last_retry_at` e `subscription_canceled_at`. O token `Authorization: Bearer` deve ser do **produtor** do pedido que originou a assinatura. operationId: pixRecurringStatus parameters: - $ref: '#/components/parameters/PixRecurringSubscriptionCode' responses: '200': description: Status do PIX Automático content: application/json: schema: type: object properties: status: type: string example: success message: type: string example: Recurso listado com sucesso. data: $ref: '#/components/schemas/PixRecurringMandate' '400': description: A assinatura não é de PIX Automático content: application/json: schema: $ref: '#/components/schemas/PixRecurringErrorResponse' '401': description: Token do cliente ou do usuário ausente ou inválido '403': description: O usuário do token não é o produtor do pedido da assinatura content: application/json: schema: $ref: '#/components/schemas/PixRecurringErrorResponse' '404': description: Assinatura não encontrada, ou a assinatura não tem PIX Automático content: application/json: schema: $ref: '#/components/schemas/PixRecurringErrorResponse' '500': description: >- Falha ao consultar o status. A resposta traz só uma mensagem genérica. content: application/json: schema: $ref: '#/components/schemas/PixRecurringErrorResponse' example: status: error message: Erro ao obter status do PIX Automático. security: - ApiClientToken: [] bearerAuth: [] components: parameters: PixRecurringSubscriptionCode: name: subscription_code in: path required: true description: Código da assinatura com PIX Automático schema: type: string example: TS7QK4M2XJ9BVN5RLD3W schemas: PixRecurringMandate: type: object description: >- Estado do mandato de PIX Automático devolvido pelo Payments da Ticto (status, cancelamento e retry). properties: subscription_code: type: string description: Código da assinatura vinculada ao mandato example: TS7QK4M2XJ9BVN5RLD3W subscription_canceled_at: type: string format: date-time nullable: true description: >- Data de cancelamento da assinatura (ISO 8601). `null` enquanto a assinatura está ativa. example: null status: $ref: '#/components/schemas/PixRecurringStatus' frequency: $ref: '#/components/schemas/PixRecurringFrequency' authorization_type: $ref: '#/components/schemas/PixRecurringAuthorizationType' authorization_date: type: string format: date-time nullable: true description: Data em que o pagador autorizou o mandato (ISO 8601) example: '2026-08-01T12:00:00.000000Z' expires_at: type: string format: date-time nullable: true description: Data de expiração da autorização (ISO 8601) example: null cancelled_at: type: string format: date-time nullable: true description: Data de cancelamento do mandato (ISO 8601) example: null retry_attempts: type: integer nullable: true description: >- Tentativas de cobrança já feitas no ciclo atual. O retry manual zera este valor. example: 1 max_retry_attempts: type: integer nullable: true description: Máximo de tentativas por ciclo example: 7 last_retry_at: type: string format: date-time nullable: true description: Data da última nova tentativa solicitada (ISO 8601) example: null failed_charges: type: integer nullable: true description: Quantidade de cobranças que falharam example: 0 variable_amount: type: boolean nullable: true description: Se o mandato aceita valores variáveis example: false min_amount: type: string nullable: true description: >- Valor mínimo em reais, com duas casas decimais (só quando `variable_amount = true`) example: null max_amount: type: string nullable: true description: >- Valor máximo em reais, com duas casas decimais (só quando `variable_amount = true`) example: null created_at: type: string nullable: true description: Data de criação do mandato (formato dd/mm/yyyy HH:mm:ss) example: 01/08/2026 11:58:40 PixRecurringErrorResponse: type: object properties: status: type: string example: error message: type: string description: >- Motivo da falha. Em erros 5xx vem só uma mensagem genérica, sem detalhe interno. example: Recurso não encontrado. PixRecurringStatus: type: string nullable: true description: > Status do mandato de PIX Automático. - Status finais, que não aceitam cancelamento: `denied`, `cancelled`, `expired`, `authorization_expired` - Aceitam nova tentativa de cobrança: `failed`, `denied` enum: - created - pending - processing - authorized - approved - denied - active - scheduled - delivered - success - failed - cancelled - expired - authorization_expired - paused example: active PixRecurringFrequency: type: string nullable: true description: Frequência de cobrança do mandato enum: - weekly - biweekly - monthly - quarterly - biannual - annual example: monthly PixRecurringAuthorizationType: type: string nullable: true description: >- Tipo de autorização do mandato. Só a autorização mensal com retentativa mensal existe hoje. enum: - monthly_auth_monthly_retry example: monthly_auth_monthly_retry securitySchemes: ApiClientToken: type: apiKey in: header name: X-Api-Client-Token description: Token de autenticação do cliente obtido via endpoint /auth bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Token de autenticação do usuário (public_token) obtido na criação do usuário ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.