Listar Recebíveis

📘

O que você irá aprender com esse artigo?

  • Pré-requisitos para usar essa API
  • O que são recebíveis?
  • Listar recebíveis via API

Pré-requisitos para usar essa API

Necessário utilizar token API para realizar a requisição. Para saber como gerar token API, acesse aqui.

O que são recebíveis?

Quando é realizada uma venda no cartão de crédito e o pagamento é aprovado, existe um tempo para que esse pagamento fique disponível para saque, que geralmente é de 30 dias. Chamamos de recebíveis esses valores que foram pagos, mas que ainda não estão disponíveis para saque, pois estão dentro do prazo para liquidação.

Listar recebíveis via API

Uma das APIs iugu disponíveis, refere aos recebíveis, é a Listar Recebíveis. Essa consulta retorna o status do recebível, o scheduled_date, executed_date e updated_at. Os status podem ser:

DONE -> esse status indica que o valor foi liquidado ou antecipado
PENDING -> significa que esse recebível ainda não foi executado, ou seja, ainda será liquidado.
CANCELED -> quando o valor foi reembolsado

O scheduled_date é a data prevista para liquidação desse recurso e o executed_date é a data que o recurso foi de fato liquidado. Supondo que um pagamento no cartão de crédito foi criado e autorizado dia 01/11, nesse cenário a data prevista de liquidação é 30/11. Isso significa que, nesse exemplo, o scheduled_date é 30/11 e se ele for liquidado nessa data o executed_date também será 30/11. Porém, se esse pagamento for antecipado para o dia 14/11, então scheduled_date continuaria como 30/11 (que era a previsão) e o executed_date será 14/11 que é a data que ele de fato foi liquidado.

O updated_at é a data que houve atualização no recebível, seja de status, de data de liquidação e etc.

Para consultar a lista de recebíveis via API basta realizar um GET na API de Listar Recebíveis informando o token_api da conta. Essa consulta também suporta outros parâmetros como: limit que limita o número de registros retornados (o máximo é 100), o start que indica a partir de qual registro deve ser mostrado o retorno e o status_filter que filtra o retorno pelo status que o recebível pode assumir (pending, done ou canceled).

Modelo de request

curl --location --request GET 'https://api.iugu.com/v1/financial_transaction_requests' \ 
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic {{api_token in base64}}' \
--header 'Cookie: __cfruid=8333722be930c1b02e7057547b478f4e9187ad58-1637951926'

Modelo de response

709709