> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onepay.la/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar cobros

> Este endpoint te permite obtener una lista de todos los cobros

### Query Parameters

<ParamField query="filter[id]" type="string">
  ID único del cobro
</ParamField>

<ParamField query="filter[status]" type="string">
  Filtra los cobros por estado. Valores posibles: pending, completed, failed, cancelled.
</ParamField>

<ParamField query="filter[reference]" type="string">
  Referencia de pago para que el usuario pueda interactuar con el portal de recaudo.
</ParamField>

<ParamField query="sort" type="string">
  Orden de los resultados por fecha de creación \[created\_at | -created\_at | paid\_at | -paid\_at]
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl https://api.onepay.la/v1/payments?filter[status]=completed&sort=-created_at \
    -H "Authorization: Bearer sk_test_xxx"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.onepay.la/v1/payments?filter[status]=completed&sort=-created_at', {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer sk_test_xxx'
    }
  });
  const data = await response.json();
  console.log(data.data); // Array de cobros
  console.log(data.current_page); // Página actual
  ```

  ```python Python theme={null}
  import requests

  url = "https://api.onepay.la/v1/payments"
  headers = {
      "Authorization": "Bearer sk_test_xxx"
  }
  params = {
      "filter[status]": "completed",
      "sort": "-created_at"
  }

  response = requests.get(url, headers=headers, params=params)
  data = response.json()
  print(data["data"])  # Array de cobros
  print(data["current_page"])  # Página actual
  ```

  ```php PHP theme={null}
  <?php
  $ch = curl_init();

  $url = "https://api.onepay.la/v1/payments?" . http_build_query([
      "filter" => ["status" => "completed"],
      "sort" => "-created_at"
  ]);

  curl_setopt_array($ch, [
      CURLOPT_URL => $url,
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_HTTPHEADER => [
          "Authorization: Bearer sk_test_xxx"
      ]
  ]);

  $response = curl_exec($ch);
  $data = json_decode($response, true);

  print_r($data["data"]); // Array de cobros
  echo $data["current_page"]; // Página actual

  curl_close($ch);
  ?>
  ```
</RequestExample>

### Response

<ResponseField name="data" type="array">
  Lista de cobros encontrados

  <Expandable title="Toggle object">
    <ResponseField name="id" type="string">
      Identificador único del cobro
    </ResponseField>

    <ResponseField name="amount" type="number">
      Monto del cobro en centavos
    </ResponseField>

    <ResponseField name="currency" type="string">
      Moneda del cobro (ej: MXN)
    </ResponseField>

    <ResponseField name="status" type="string">
      Estado actual del cobro
    </ResponseField>

    <ResponseField name="created_at" type="string">
      Fecha de creación en formato ISO 8601
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="pagination" type="object">
  Información de paginación

  <Expandable title="Toggle object">
    <ResponseField name="total" type="number">
      Número total de cobros
    </ResponseField>

    <ResponseField name="page" type="number">
      Página actual
    </ResponseField>

    <ResponseField name="pages" type="number">
      Número total de páginas
    </ResponseField>
  </Expandable>
</ResponseField>

### Response Example

<ResponseExample>
  ```json 200 theme={null}
  {
     "current_page":1,
     "data":[
        {
           "id":"9bf2bc44-28d4-4693-9896-7fc1fe1f5b65",
           "status":"cancelled",
           "currency":"COP",
           "amount":63040,
           "external_id":null,
           "title":"Factura Movistar Noviembre",
           "description":"Factura Movistar Noviembre",
           "document_link":"https:\/\/s3.us-east-2.amazonaws.com\/onepay.production\/examples\/movistar.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEIj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJIMEYCIQDsCxYOf9h%2BnJE%2F%2BCb1xw8MHe4Va%2BhS0y%2BN0T0Hmk1pSAIhAKjTeQ1CwkDngSJLRnLno0w9zSLZRBF85Q0ZE5QBy6B0KosDCIH%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQABoMNDE5MjQzNzMzMzU1IgydbiKzTvDFE2Z7kZsq3wJs7LXSTWKJuPy59ioMYVx9IaGIvpbmA8VeweFROkm4bEqg%2BdXmu5em2USXkIO34u4htN2GhjYnPDz3JpbJZuqPc0sAMbUQuiQPr5AS1ZKhOlBz5BwrBVmaiAnQej1wda8M0SO0gkBAdR6PaX7VG5mTpT6fqIb58FuwGETmR4T11VkJg0fn8FzU7N2JGpoM5uKC9bVaDFh53B%2B4G2VFulCWXRjfJMsYJvTL4AvrTnb6hYFYKRPkAzcdg6yX%2FGELN6V%2Bb5o%2B75DNw96mtF%2FXlbxJg7mLmu3pV8VXRh6otYUtL2wsHAVKCDMu0l5biDjcXkgKtsK%2BvtI9zN4AenE%2BLasZ8TCLJlyi4uuirDnJ%2BQ%2BZ4RJYEXS25Cqq1sa9a%2Bgt79hhR9CmfrgZYOn7ytP01%2FfPspLYFyd4HW3cpeo7%2BC6vmaaErhDpsGn8nuujZM9esGRZTzFUTxKKibuJKbwn4RowsIGxvAY6nQGc8SORqhGHoPWPoKLYMSJ6KImpPLXIfvwxaQFAivgDucwsIhlDNE%2BneS8gqDofMozpGFkCIXudPBvcR0nhMnOdpy1rcRTGhBKLcDQ3k598DjegYtqfOUHpSj1PkxumM6j3vjiY%2FnAS47kGpsAKUOygCXu%2FtFNSUqQxIHnhXcxZS%2Bzcuo9re9IeIpoVdqC1SDpSiFck2QhxAtFAzy1K&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAWDHG7WFV4AZBUR5Z%2F20250119%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250119T015132Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=7597b9bd823c6350964231139fdbae9844f549f9dd7498cfa18c31bfbd14a703",
           "phone":"+573138977841",
           "expiration_at":"2024-05-03T16:47:09.000000Z",
           "created_at":"2024-05-02T16:47:09.000000Z",
           "paid_at":null,
           "metadata":null,
           "source":"demo",
           "allows":{
              "cards":true,
              "accounts":true,
              "card_extra":false,
              "realtime":false,
              "pse":true,
              "transfiya":true
           },
           "exchange":null,
           "extra_value":null,
           "scheduled_date":null,
           "source_id":null,
           "reference":null,
           "email":null,
           "redirect_url":null,
           "remarks":null,
           "amount_label":"$63.040",
           "deletable":false,
           "payment_link":"https:\/\/pagos.onepay.la\/payment\/9bf2bc44-28d4-4693-9896-7fc1fe1f5b65",
           "coupon_discount":0,
           "customer":{
              "first_name":"Juan",
              "last_name":"Demo",
              "email":"hola@onepay.la",
              "phone":"+573167591039",
              "user_type":"natural",
           },
           "method":null,
           "splits":[
              
           ],
           "coupon":null
        },
        ...
     ],
     "to":20,
     "per_page":20
  }
  ```
</ResponseExample>