Skip to content

Clientes (API)

Un cliente representa a la persona a la que cobrarás dentro del proyecto. La forma habitual de crear un cliente es capturando su tarjeta con un : Zelta Pay tokeniza la tarjeta y crea el cliente automáticamente, emitiendo el webhook customer.created. También puedes crear clientes directamente por API y adjuntarles una tarjeta vaulteada.

Un cliente vaulteado es aquel que tiene una tarjeta almacenada de forma segura por el procesador activo de la cuenta (NMI o Emetec). El token registra qué procesador la guardó, de modo que todos los cobros posteriores se enrutan a ese mismo procesador. Solo los clientes vaulteados pueden ser cobrados con o suscritos con .

Todos los endpoints requieren tu API key de proyecto en el header X-API-Key.

Clientes de un proyecto con tarjeta en bóveda

Listar clientes

http
GET /v1/customers

Parámetros de consulta: paginación estándar (lim, off).

bash
curl "https://api-pay.zelta.dev/v1/customers?lim=10" \
  -H "X-API-Key: tu-api-key-de-proyecto"

Crear un cliente

http
POST /v1/customers

Cuerpo de la solicitud:

CampoTipoRequeridoDescripción
namestringNombre del cliente
emailstringNoCorreo del cliente
phonestringNoTeléfono del cliente
bash
curl -X POST https://api-pay.zelta.dev/v1/customers \
  -H "X-API-Key: tu-api-key-de-proyecto" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+50760000000"
  }'

Un cliente creado así aún no tiene tarjeta almacenada. Para poder cobrarle debes adjuntarle una tarjeta vaulteada (ver abajo) o capturarla con un .

Obtener un cliente

http
GET /v1/customers/:id
bash
curl "https://api-pay.zelta.dev/v1/customers/1234567890" \
  -H "X-API-Key: tu-api-key-de-proyecto"

Adjuntar una tarjeta vaulteada

Asocia al cliente una tarjeta ya tokenizada por el procesador indicado. Esto convierte al cliente en vaulteado y habilita cobros y suscripciones.

http
POST /v1/customers/:id/vault

Cuerpo de la solicitud:

CampoTipoRequeridoDescripción
providerstringProcesador que almacenó la tarjeta: nmi o emetec
bash
curl -X POST https://api-pay.zelta.dev/v1/customers/1234567890/vault \
  -H "X-API-Key: tu-api-key-de-proyecto" \
  -H "Content-Type: application/json" \
  -d '{ "provider": "nmi" }'

Las colecciones son solo tarjeta

El vaulteo solo aplica a tarjetas (NMI o Emetec). Yappy no puede almacenar una credencial, por lo que no puede usarse para crear clientes vaulteados.

Siguientes pasos

  • — captura la tarjeta y crea el cliente en un solo paso
  • — cobra a un cliente vaulteado
  • — suscribe a un cliente vaulteado a un plan
  • — el evento customer.created

Documentación oficial de Zelta