/lending/v1/credit-lines/{credit-line-id}/statements

Buscar Estados de cuenta

El endpoint /credit-lines/{credit-line-id}/statements te permite realizar una búsqueda de estados de cuenta filtrando según los atributos que especifiques.

Filtros

Puedes encontrar más información sobre cómo aplicar los filtros en la sección de Filtros y paginado.

Parámetros disponibles

Path Parameters
credit-line-idString
Query Parameters
filter[status]enum
filter[period][from]String
filter[period][to]String
includeenum
page[size]String
page[number]String
sortenum

Detalle de respuestas

Ejemplo de código
curl -X GET "https://api.pomelo.la/lending/v1/credit-lines/example_value/statements?filter[status]=CREATED&filter[period][from]=2023-03&filter[period][to]=2023-04&include=rates,limits&page[size]=10&page[number]=2&sort=status,-period" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"
Ejemplo de respuesta (200)OK
{
  "meta": {
    "pagination": {
      "total_pages": 1,
      "current_page": 1,
      "page_size": 10
    }
  },
  "data": [
    {
      "id": "lst-2Lm1ZH2rmhP6F1NRRBRneXAmpLe",
      "status": "GENERATED",
      "period": "2020-07",
      "header": {
        "credit_line_id": "lcr-2Lm1P1BcJXkAxaseQJjAeXAMple",
        "user": {
          "id": "usr-2LlzusFUb3CCg6q8HjpCeXAmpLe"
        },
        "balance": {
          "local_amount": "3577.50",
          "local_currency": "BRL",
          "minimum_local_amount": "357.50",
          "minimum_payment_fee_amount": "35.50",
          "upcoming_installments_debt_amount": "10.00",
          "total_local_debt_amount": "3587.50"
        },
        "upcoming_installment_debt": [
          {
            "period": "2021-11",
            "local_amount": "4500.00",
            "local_currency": "BRL"
          }
        ],
        "financing_options": [
          {
            "installments": 6,
            "amount": "25.57"
          }
        ],
        "summary": {
          "purchases": "8500.00",
          "cash_advance": "1000.00",
          "fees": "0.00",
          "interest": "12.00",
          "taxes": "0.00",
          "returns": "0.00",
          "others": "0.00",
          "refinancings": "0.00",
          "payments": "0.00",
          "insurance": "0.00"
        },
        "regional": {
          "repayment_estimates": [
            {
              "time": 1,
              "time_unit": "MONTH",
              "repayment_amount": "500.00"
            }
          ],
          "average_daily_balance": "450.00"
        },
        "available": {
          "single_payment": "30.50",
          "installments": "80",
          "cash_advance": "101.05"
        }
      },
      "operations": [
        {
          "id": "ste-3x17pjnWCuM8dXgUG4pRIp0NyRp",
          "date": "2022-06-22",
          "type": "ADDITIONAL_CHARGE",
          "local_currency": "BRL",
          "local_amount": "500.00",
          "total_amount": "450.00",
          "taxes": [
            {
              "concept": "PRINCIPAL",
              "name": "IVA",
              "amount": "string",
              "rate": "string"
            }
          ],
          "description": "string",
          "interest": "10.00",
          "collection_id": "string",
          "base_amount": "500.00"
        }
      ],
      "card_statements": [
        {
          "card_id": "crd-20gRqyp809SvDzXzhSeG2w6UiO5",
          "last_four": "5123",
          "total_local_amount": "3577.50",
          "total_local_currency": "BRL",
          "items": [
            {
              "date": "2021-10-29",
              "date_time": "2021-10-29T00:00:00",
              "local_amount": "2577.50",
              "total_local_amount": "2627.50",
              "local_currency": "BRL",
              "transaction_id": "ctx-2P18pjnWCuM8dXgUG4pRIp0MeEx",
              "transaction_type": "PURCHASE",
              "transaction_amount": "2577.50",
              "transaction_currency": "BRL",
              "settlement_amount": "5000.00",
              "settlement_currency": "USD",
              "merchant_id": "1213123451",
              "merchant_mcc": "27",
              "merchant_name": "SERVICE SRL",
              "transaction_exchange": {
                "rate": "1.50",
                "currency": "BRL"
              },
              "installment": {
                "total": "12",
                "current": "6"
              },
              "original_transaction_id": "ctx-2q2NKRfTgjPxvtboliM3yXZ7Djh",
              "taxes": [
                {
                  "name": "Some Tax",
                  "amount": "50.00",
                  "currency": "BRL"
                }
              ],
              "fees": [
                {
                  "name": "BOARDING_FEE",
                  "amount": "25.00",
                  "currency": "BRL"
                }
              ]
            }
          ]
        }
      ],
      "payments": [
        {
          "date": "2022-06-22",
          "local_amount": "500.00",
          "local_currency": "BRL",
          "description": "This is a sample description of the payment"
        }
      ],
      "refinancings": [
        {
          "date": "2022-04-29",
          "type": "STATEMENT",
          "amount": "20000.00",
          "interest": "9800.00",
          "taxes": "200.00",
          "down_payment": "5000.00"
        }
      ],
      "payment_options": [
        {
          "type": "PAYMENT_CODE",
          "value": "12345678"
        }
      ],
      "manual_refinancing": [
        {
          "total_amount": "3000",
          "total_interest": "300",
          "total_principal": "2700",
          "taxes": [
            {
              "name": "Some Tax",
              "amount": "50.00",
              "currency": "BRL"
            }
          ],
          "down_payment": "500",
          "installment_quantity": 6,
          "rates": [
            {
              "rate": "20.34",
              "type": "cash_advance"
            }
          ]
        }
      ]
    }
  ]
}

Pomelo AI

Asistente de inteligencia artificial para consultas sobre la API de Pomelo
¡Hola!¿Cómo puedo ayudarte hoy?
Buscar Estados de cuenta | Pomelo API Reference