4. Listando Cobranças – Central de Ajuda iPAGARE

Este recurso permite que sejam consultadas cobranças já criadas anteriormente via API ou Televendas.

Você pode enviar parâmtros para filtrar as cobranças a serem consultadas. Um máximo de 1.000 cobranças serão retornadas a cada consulta.

Com exceção do código do estabelecimento (merchant_id), nenhum filtro é obrigatório. Se nenhum filtro for enviado, retornará as primeiras 1.000 cobranças por ordem decrescente de data de última atualização.

AUTENTICAÇÃO

Veja a seção "Autenticação e Autorização".

Endpoint URL

GET https://api.southpayments.com/orders/list

REQUEST BODY (Json)

Nome	Tipo	Tamanho Máximo / Valores	Comentário/Exemplo
merchant_id	string	20	Código de estabelecimento fornecido pela Southpayments. Ex: 987heuiwqg8912g
sandbox	boolean	true/false	Filtra por cobranças de teste ou de produção. Padrão FALSE (produção).
status	array (string)	open pending paid expired cancelled	Filtra pelo status da cobrança.
created_at_begin	string	yyyy-mm-dd	Filtra pela data inicial de criação do pedido. Ex: 2020-10-02
created_at_end	string	yyyy-mm-dd	Filtra pela data final de criação do pedido. Ex: 2020-10-02
updated_at_begin	string	yyyy-mm-dd	Filtra pela data inicial da última atualização do pedido. Ex: 2020-10-02
updated_at_end	string	yyyy-mm-dd	Filtra pela data inicial da última atualização do pedido. Ex: 2020-10-02
customer	object	-	Objeto contendo parâmetros para filtrar por dados do cliente.
customer.name	string	255	Filtro por nome (parcial ou total) do cliente. Ex: Pedro
customer.legal_number	string	20	Filtro pelo CPF/CNPJ do cliente, somente dígitos. Ex: 33333333333
customer.email	string	255	Filtra pelo e-mail do cliente. Ex: joao@silva.com
customer.merchant_key	string	40	Filtra pelo código identificador do cliente. Ex: 123-cliente

Exemplos de Consultas

1. Cobranças com status ABERTO e PENDENTE do cliente com CPF 333.333.333-33:

{
  "merchant_id": "4398yfnru3f7813",
  "status": ["open", "pending"],
  "customer": 
  {
   "legal_number": "33333333333"
  }
}

2. Cobranças com status PAGO que foram pagas no mês de agosto de 2020:

{ 
  "merchant_id": "4398yfnru3f7813",
  "status": ["paid"],
  "updated_at_begin": "2020-08-01",
  "updated_at_end": "2020-08-31", 
}

RETORNO

Se a consulta for realizada com sucesso, será retornado o código HTTP de sucesso juntamente com um ARRAY de objetos do tipo COBRANÇA.

Se nenhuma cobrança for encontrada com os critérios informados, um array vazio será retornado.

Código HTTP

200 (OK): Consulta realizada com sucesso.

Corpo da Resposta (Json)

Será um array de objetos do tipo COBRANÇA, cujos atributos estão detalhados no artigo Cobrança (ou Pedido).

RETORNO - INSUCESSO

Os erros que podem ocorrer ao listar cobranças é problema com autenticação e autorização.

Detalhes sobre os códigos HTTP e os motivos de insucesso estão apresentados na seção Códigos de Erro de Retorno.