Ir al contenido

API

En esta página

Obtener

Lee un canal de pago con sus direcciones permanentes por red, los tokens que cada red acepta ahora mismo y tus porcentajes de comisión vigentes.

GET/v1/payment-channels/:payment_channel_id

Clave de API: Payment

Lee un canal por su identificador pc_. Es la llamada que haces antes de enseñarle a un cliente dónde enviar el dinero: devuelve la dirección actual de cada red y los tokens que esa red acepta en este momento.

Respuesta (200 OK)

{
  "id": "pc_2QhKZv6mRt9WdA3nYpLbXf",
  "project_id": "prj_xFukZuAJZR06pLVBh3uwzv",
  "external_id": "customer-42",
  "status": "active",
  "is_accepting_payments": true,
  "is_fully_provisioned": false,
  "is_test": false,
  "applied_fee_percent": 1.0,
  "customer_fee_percent": 0,
  "networks": [
    {
      "network": "TRC20",
      "status": "active",
      "address": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
      "tokens": [
        { "symbol": "USDT", "minimum_deposit": "1.00" },
        { "symbol": "USDC", "minimum_deposit": "1.00" }
      ]
    },
    {
      "network": "ERC20",
      "status": "active",
      "address": "0x9f2a6c1b4e8d7350ab11c9e5f0d2743b86ce41d9",
      "tokens": [
        { "symbol": "USDT", "minimum_deposit": "12.00" },
        { "symbol": "USDC", "minimum_deposit": "12.00" }
      ]
    },
    {
      "network": "SOL",
      "status": "provisioning",
      "tokens": [
        { "symbol": "USDC", "minimum_deposit": null }
      ]
    }
  ],
  "created_at": 1767225600,
  "updated_at": 1767225780
}

Estados

Estado Significado Admite depósitos
provisioning Creado, todavía sin ninguna dirección lista No
active Existe al menos una dirección
blocked Pausaste el canal No

active no retrocede. Cuando un canal ha producido su primera dirección, ya no vuelve solo a provisioning: las redes que faltan siguen en marcha por detrás y aparecen a medida que se completan. No hay estado de fallo: el aprovisionamiento reintenta hasta que lo consigue.

is_accepting_payments es la única bandera sobre la que ramificar en tu interfaz. Vale true solo cuando el proyecto está activo, el canal no está bloqueado y al menos una red tiene a la vez dirección y un token aceptado.

Las direcciones son permanentes

La dirección que se devuelve para un canal le pertenece de forma definitiva y no se reasigna a nadie más. Mantenla en caché y deja de volver a pedirla en cada carga de página.

Dos cosas sí cambian, y tu integración debería seguirlas:

  • Los tokens de cada red. Activar o desactivar un token en el proyecto cambia el array tokens. Enseña solo lo que aparezca ahí.
  • Qué redes aparecen. Quitar del proyecto todos los tokens de una red saca esa red de la respuesta. La dirección no se borra —volver a activar el token la trae de vuelta, la misma—, pero retira de tu interfaz cualquier vía que la API haya dejado de devolver.

El mínimo va por red y por token

Una entrada de tokens es un objeto, no un símbolo:

Campo Significado
symbol El código del token, por ejemplo USDT.
minimum_deposit Cadena decimal, en las unidades del propio token. La transferencia más pequeña que esa vía abona.

El mínimo pertenece al token y a la red a la vez, y entre los dos extremos del rango hay órdenes de magnitud: el mismo token no se limita igual en una cadena que cuesta céntimos que en una que cuesta dólares. El valor se consulta en vivo en cada lectura, así que sácalo de la respuesta que vas a mostrar y no lo dejes fijo en el código.

Una transferencia por debajo del mínimo no se abona al canal ni vuelve sola. Pon la cifra junto a la dirección.

minimum_deposit viene a null cuando esa vía no se puede cotizar en ese momento. No significa que no lo tenga: tampoco se conoce ningún importe seguro en esa vía, así que no la ofrezcas hasta que vuelva una cifra. Tratar null como cero es la forma exacta de recibir un pago que no hay manera de abonar.

Las comisiones son las de hoy, no las históricas

applied_fee_percent y customer_fee_percent describen tu tarifa de hoy. Son informativos. Los números que mandan en un pago concreto están en el depósito que lo registró, que lleva sus propias tarifas congeladas y su propio gross, fee y net. Consulta Obtener depósito.

Errores

Code HTTP Cuándo
payment_channels_disabled 503 Los canales de pago no están activados para tu cuenta en este entorno.
payment_key_required 403 La petición se firmó con una clave Payout (rk_).
payment_channel_not_found 404 El id no resuelve a nada que esta credencial pueda ver.
field_invalid_format 400 El segmento de la ruta no es un identificador pc_ válido.

Un canal de otro comercio, de otro entorno o de un proyecto fuera del alcance de tu credencial responde payment_channel_not_found, exactamente igual que un canal que no existe: la API nunca confirma lo que no te va a enseñar.

Consulta Códigos de error para el catálogo completo.