Passer au contenu principal
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 :
Request headers
Request body
relationship décrit la relation du destinataire avec votre client. Choisissez une valeur dans le schéma de requête POST /v3/customers/{customerId}/recipients. Si vous envoyez other, n’ajoutez pas de champ texte libre. Swipelux ignore les champs que le schéma de requête ne définit pas : le texte ne serait donc pas enregistré. 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 :
Request headers
Les destinations Pix et Pix Safe reçoivent des BRL et nécessitent que la capacité Pix du client (pix_pooled) soit prête. Une destination Pix paie une clé Pix : un CPF ou un CNPJ en chiffres uniquement, un numéro de téléphone au format +55 suivi de 10 ou 11 chiffres, une adresse e-mail ou une clé aléatoire. Une destination Pix Safe paie un compte bancaire brésilien identifié par le CPF ou le CNPJ du titulaire dans taxId, le code ISPB à 8 chiffres de la banque dans bankCode, l’agence et le numéro de compte avec son chiffre de contrôle. Les réponses et les webhooks renvoient taxId masqué, à l’exception de ses quatre derniers chiffres. Swipelux valide les identifiants bancaires tels que les IBAN, les BIC, les numéros de routage ABA et les numéros CPF ou CNPJ, y compris leurs sommes de contrôle, lorsque vous créez une destination bancaire. Les valeurs mal formées renvoient 400 validation_error. Ces vérifications confirment uniquement le format, et non l’existence du compte ni l’identité de son titulaire. 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.