Listar Todos los Registros de Crédito

Endpoint

GET https://api.verifik.co/v2/credits

Recupera una lista de registros de Crédito en el sistema de Verifik. Este endpoint devuelve un array de objetos de crédito, cada uno conteniendo información detallada sobre transacciones de crédito, saldos y cuentas de cliente asociadas.

Encabezados

Content-Type

Tipo: String
Requerido: Sí

application/json

Authorization

Tipo: String
Requerido: Sí

Bearer <token>

Parámetros

page

Tipo: Number
Requerido: No

Especifica el número de página para la paginación, comenzando desde 1.

perPage

Tipo: Number
Requerido: No

Define el número de elementos por página para la paginación.

populates[]

Tipo: String
Requerido: No

Rellena el campo especificado, transformando referencias ObjectId en objetos completos. Opciones disponibles: client, superAdmin

where_status

Tipo: String
Requerido: No

Condición where para filtrar por estado. Opciones: approved, pending, failed, postPaid

where_category

Tipo: String
Requerido: No

Condición where para filtrar por categoría. Opciones: purchase, usage

where_client

Tipo: String
Requerido: No

Filtrar por ID de cliente específico

Solicitud

Node.js

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.verifik.co/v2/credits',
  params: {
    page: 1,
    perPage: 20,
    "populates[]": ["client"],
    where_status: "approved",
    where_category: "purchase"
  },
  headers: {
    Accept: 'application/json',
    Authorization: 'jwt <tu_token>'
  }
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

Python

import http.client

conn = http.client.HTTPSConnection("api.verifik.co")

headers = {
    'Accept': "application/json",
    'Authorization': "JWT token"
}

conn.request("GET", "/v2/credits?page=1&perPage=20&populates[]=client&where_status=approved&where_category=purchase", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

PHP

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.verifik.co/v2/credits?page=1&perPage=20&populates[]=client&where_status=approved&where_category=purchase', [
  'headers' => [
    'Accept' => 'application/json',
    'Authorization' => 'JWT token',
  ],
]);

echo $response->getBody();

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.verifik.co/v2/credits?page=1&perPage=20&populates[]=client&where_status=approved&where_category=purchase"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "JWT token")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}

Respuesta

200

{
  "success": true,
  "data": [
    {
      "_id": "credit_123456789",
      "amount": 1000,
      "status": "approved",
      "category": "purchase",
      "client": {
        "_id": "client_123456789",
        "name": "Example Client",
        "email": "client@example.com"
      },
      "description": "Compra de crédito para uso de API",
      "transactionId": "txn_123456789",
      "paymentMethod": "credit_card",
      "currency": "USD",
      "exchangeRate": 1.0,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "perPage": 20,
    "total": 1,
    "pages": 1
  }
}

400

{
  "success": false,
  "error": "Parámetros de consulta inválidos",
  "code": "INVALID_PARAMETERS"
}