Clients

Créez le client avant de construire un encaissement, un paiement ou un compte bancaire émis. Les capacités, les comptes et les transferts sont liés à ce client. Utilisez externalId comme mappage stable vers l’enregistrement correspondant dans votre système.

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

Clients individuels

Un individu ne requiert que type. Incluez les champs de profil que vous connaissez déjà, et ajoutez-en davantage uniquement lorsque la capacité ou la tâche actuelle en a besoin. Créez le client avec 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

Stockez le data.id renvoyé en tant que CUSTOMER_ID. Consultez Onboarding individuel pour le contexte politique.

Clients professionnels

Une entreprise requiert business.legalName. Créez l’entreprise avec la même opération :

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

Stockez le data.id renvoyé en tant que CUSTOMER_ID. Consultez Onboarding professionnel pour le contexte politique et documentaire.

Ajouter des parties liées professionnelles

Ajoutez des directeurs, des propriétaires et d’autres participants de l’entreprise lorsqu’ils sont connus ou requis. Cet exemple crée un directeur avec 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

Stockez le data.id renvoyé en tant que RELATED_PARTY_ID.

Lire la disponibilité à partir des capacités

Un client n’a pas de statut de vérification ou de disponibilité dans l’API. Lisez le client avec GET /v3/customers/{customerId} pour les données de profil actuelles, puis utilisez les capacités et leurs openTaskIds pour décider de ce que le client peut faire ensuite.

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

Ensuite, continuez vers Capacités et tâches pour découvrir et activer le résultat produit dont vous avez besoin.

Commencer

Intégrer les clients

Construire les flux monétaires

Mise en production

Clients individuels

Clients professionnels

Ajouter des parties liées professionnelles

Lire la disponibilité à partir des capacités

​Clients individuels

​Clients professionnels

​Ajouter des parties liées professionnelles

​Lire la disponibilité à partir des capacités

Clients individuels

Clients professionnels

Ajouter des parties liées professionnelles

Lire la disponibilité à partir des capacités