Venflow API
V1Pagos

Listar todos los pagos

GET
/v1/payments

Authorization

Api-Key<token>

Tu clave API privada (comienza con pvk_)

In: header

Organization<token>

Tu ID de organización

In: header

Query Parameters

limit?integer

Límite en el número de objetos a devolver. El límite puede estar entre 1 y 100, y el valor predeterminado es 10

Range1 <= value <= 100
starting_after?string

Un cursor para paginación. starting_after es un ID de objeto que define tu posición en la lista

Formatuuid
ending_before?string

Un cursor para paginación. ending_before es un ID de objeto que define tu posición en la lista

Formatuuid
customer?string

Solo devuelve pagos del cliente especificado por este ID de cliente

Formatuuid
status?string

Solo devuelve pagos con el estado especificado

Value in"pending" | "completed" | "failed" | "pending_to_verify"
created_gte?string

Un filtro en la lista, basado en el campo de fecha de creación. El valor puede ser una fecha exacta

Formatdate-time
created_lte?string

Un filtro en la lista, basado en el campo de fecha de creación

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.venflow.app/v1/payments"
{
  "data": [
    {
      "amount": 0.1,
      "bank_reference": "string",
      "created": 0.1,
      "customer": "string",
      "failure_message": "string",
      "id": "string",
      "livemode": true,
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "object": "payment",
      "paid_at": 0,
      "payment_method": "string",
      "payment_method_details": {
        "bank": {
          "id": "string",
          "name": "string"
        },
        "type": "string"
      },
      "retries": 0.1,
      "status": "pending",
      "subscription": "string"
    }
  ],
  "has_more": true,
  "object": "list",
  "url": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}

Actualizar un payment link PATCH

Activa o desactiva un payment link. Es el interruptor de apagado: los payment links no se eliminan. - Un link desactivado rechaza cualquier visita nueva y deja de generar sesiones. - Los pagos, facturas y suscripciones que ya se generaron con él no se ven afectados. - Repetir el mismo valor no produce error. Activa o desactiva un payment link. Los payment links no se eliminan: al desactivarlos dejan de generar sesiones y cualquier visita al link es rechazada, sin afectar los pagos ni las suscripciones que ya se hicieron con él. Volver a activarlo lo deja operativo de nuevo, y repetir el mismo valor no produce error.

Obtener un pago GET

Obtiene el pago con el ID especificado.