Clientes

Crea el cliente antes de construir un cobro, pago o cuenta bancaria emitida. Las capacidades, cuentas y transferencias están asociadas a ese cliente. Utiliza externalId como mapeo estable al registro correspondiente en tu sistema.

export API_BASE='https://platform.swipelux.com'
export SWIPELUX_API_KEY='replace-with-your-api-key'

Clientes individuales

Un individuo solo requiere type. Incluye los campos de perfil que ya conozcas y añade más solo cuando la capacidad o tarea actual los necesite. Crea el cliente con POST /v3/customers:

curl --request POST \
  "${API_BASE}/v3/customers" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: customer-user-123" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "type": "individual",
  "externalId": "user_123",
  "individual": {
    "firstName": "Amina",
    "lastName": "Diallo",
    "residenceCountry": "FR"
  }
}
JSON

Guarda el data.id devuelto como CUSTOMER_ID. Consulta Onboarding de individuos para el contexto de la política.

Clientes empresa

Una empresa requiere business.legalName. Crea la empresa con la misma operación:

curl --request POST \
  "${API_BASE}/v3/customers" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: customer-company-456" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "type": "business",
  "externalId": "company_456",
  "business": {
    "legalName": "Acme Payments SAS"
  }
}
JSON

Guarda el data.id devuelto como CUSTOMER_ID. Consulta Onboarding de empresas para el contexto de política y documentos.

Añade partes relacionadas de la empresa

Añade directores, propietarios y otros participantes de la empresa cuando sean conocidos o solicitados. Este ejemplo crea un director con POST /v3/customers/{customerId}/related-parties:

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/related-parties" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: related-party-director-001" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "partyType": "person",
  "roles": ["director"],
  "title": "Chief executive officer",
  "person": {
    "firstName": "Amina",
    "lastName": "Diallo",
    "residenceCountry": "FR"
  }
}
JSON

Guarda el data.id devuelto como RELATED_PARTY_ID.

Lee la disponibilidad desde las capacidades

Un cliente no tiene un estado de verificación o disponibilidad en la API. Lee el cliente con GET /v3/customers/{customerId} para obtener los datos actuales del perfil, luego utiliza las capacidades y sus openTaskIds para decidir qué puede hacer el cliente a continuación.

curl --request GET \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}"

A continuación, pasa a Capacidades y tareas para descubrir y activar el resultado de producto que necesites.

Comienza

Incorpora clientes

Crea flujos de dinero

Lanzamiento

Clientes individuales

Clientes empresa

Añade partes relacionadas de la empresa

Lee la disponibilidad desde las capacidades

​Clientes individuales

​Clientes empresa

​Añade partes relacionadas de la empresa

​Lee la disponibilidad desde las capacidades

Clientes individuales

Clientes empresa

Añade partes relacionadas de la empresa

Lee la disponibilidad desde las capacidades