These docs are for v1.0. Click to read the latest docs for v4.1.


## Listar ordens de pagamentos

A cada intervalo de recorrência nos planos automáticos, o PagSeguro irá gerar uma Ordem de Pagamento. Ela indica a necessidade de cobrança da próxima parcela. Na data de vencimento da ordem de pagamento, será gerada uma Transação, que é a cobrança dessa ordem.

Se a transação for bem sucedida, a Ordem de Pagamento fica com o status 5 (Paga). Caso contrário, podem ser geradas novas tentativas de cobrança, através de novas Transações, dentro da mesma Ordem de Pagamento.

Com este método é possível verificar todas as Ordens de Pagamento geradas para uma adesão, bem como as Transações associadas a cada Ordem de Pagamento. A partir destes dados pode-se verificar se as cobranças foram efetuadas ou não, e por qual motivo.

Para listar as ordens de pagamento de uma adesão, utilize o método **/pre-approvals/{{preApprovalCode}}/payment-orders**.

O parâmetro `preApprovalCode` é o código da adesão obtido no método **/pre-approvals** já documentado em Adesão ao plano.

O retorno deste método pode ser paginado, verifique na referência da API os parâmetros de entrada.

Os status de ordem de pagamento podem ser vistos na Tabela de [Status de Ordem de Pagamento](🔗)

Os status das transações podem ser vistos na Tabela de Status de Transação.

## Consulta pelo código de Adesão

Esta consulta possibilita o acesso a todos os dados de uma adesão a partir de seu código identificador.

Para recuperar os dados de uma adesão, utilize o método **/pre-approvals/{{preApprovalCode}}**.

O parâmetro `{preApprovalCode}` é o código da adesão obtido no método **/pre-approvals** já documentado em Adesão ao plano.

No retorno, o status da adesão pode ser lido de acordo com a Tabelas de Status de Adesão.

## Consulta por intervalo de datas

Esta consulta possibilita o acesso aos dados de todas as recorrências criadas dentro do intervalo de datas fornecido como parâmetro. Note que a consulta não retorna resultados para datas anteriores a 6 (seis) meses da data atual.

Para recuperar os dados das recorrências, utilize o método **/pre-approvals**.

O retorno deste método pode ser paginado, verifique na referência da API os parâmetros de entrada.

No retorno, o status da recorrência pode ser lido de acordo com a Tabela de Status de Adesão.

## Consulta pelo código de notificação

A API de Notificações pode lhe enviar mensagens a cada mudança de status ocorrida em alguma recorrência.

Para consultar os dados da recorrência em questão, utilize o método **/pre-approvals/notifications/{{notificationCode}}** .

O parâmetro `{notificationCode}` é o código da notificação recebida.

No retorno, o status da recorrência pode ser lido de acordo com a Tabela de Status de Adesão.

## Consulta de notificações por intervalos de dias

A API de Notificações pode lhe enviar mensagens a cada mudança de status ocorrida em alguma recorrência.

Para consultar os dados de todas as recorrências que tiveram algum tipo de notificação dentro de um intervalo em dias, utilize o método **/pre-approvals/notifications**.

O retorno deste método pode ser paginado, verifique na referência da API os parâmetros de entrada.

No retorno, o status da recorrência pode ser lido de acordo com a Tabela de Status de Adesão.