Destinataires et destinations

Utilisez un compte client lorsque le client détient l’endpoint. Utilisez un destinataire et une destination lorsqu’une autre personne ou entreprise reçoit les fonds. Le destinataire enregistre qui reçoit les fonds. La destination enregistre où ils les reçoivent.

1. Créer le destinataire

Créez un individu ou une entreprise avec POST /v3/customers/{customerId}/recipients. Envoyez ces en-têtes :

X-API-Key: ${SWIPELUX_API_KEY}
Idempotency-Key: recipient-create-001
Content-Type: application/json

{
  "type": "individual",
  "relationship": "contractor",
  "firstName": "Jason",
  "lastName": "Swipelux",
  "email": "jason@swipelux.com",
  "phone": "+14155551234",
  "address": {
    "streetLine1": "1 Market Street",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94105",
    "country": "US"
  },
  "label": "Jason contractor"
}

Incluez l’adresse avant de créer une destination fiat. Stockez le data.id du destinataire renvoyé en tant que RECIPIENT_ID et conservez son statut actuel.

2. Ajouter une destination

Créez l’endpoint avec POST /v3/customers/{customerId}/recipients/{recipientId}/destinations. Utilisez une nouvelle clé pour cette destination prévue :

X-API-Key: ${SWIPELUX_API_KEY}
Idempotency-Key: recipient-destination-create-001
Content-Type: application/json

Destination bancaire
Destination portefeuille

{
  "type": "ach",
  "currency": "USD",
  "details": {
    "routingNumber": "021000021",
    "accountNumber": "123456789",
    "accountType": "checking",
    "bankName": "Example Bank",
    "accountHolderName": "Jason Swipelux",
    "country": "US"
  }
}

{
  "type": "wallet",
  "currency": "USDC",
  "ownership": {
    "type": "self_custodied"
  },
  "details": {
    "network": "base",
    "address": "0x1111111111111111111111111111111111111111"
  }
}

Utilisez self_custodied uniquement lorsque le destinataire contrôle le portefeuille. Suivez la variante actuelle de la Référence API lorsque le portefeuille est détenu par un autre dépositaire. Stockez le data.id de la destination renvoyée en tant que DESTINATION_ID et conservez son statut actuel.

3. Attendre la disponibilité de la destination

Lisez GET /v3/customers/{customerId}/recipients/{recipientId}/destinations/{destinationId} avant de créer un devis. Continuez uniquement lorsque le statut actuel de la destination autorise le paiement et que sa devise, sa méthode et son réseau correspondent au mouvement prévu. Les statuts de destinataire et de destination sont indépendants. Utilisez l’ID de destination dst_ dans le devis de paiement. L’ID de destinataire rcp_ identifie l’enregistrement du propriétaire et n’est pas une destination de devis. Ensuite, apportez la destination prête à Envoyer des fonds.

Commencer

Intégrer les clients

Construire les flux monétaires

Mise en production

Destinataires et destinations

1. Créer le destinataire

2. Ajouter une destination

3. Attendre la disponibilité de la destination

​1. Créer le destinataire

​2. Ajouter une destination

​3. Attendre la disponibilité de la destination

1. Créer le destinataire

2. Ajouter une destination

3. Attendre la disponibilité de la destination