Skip to main content
Utilisez l’API Transfers pour envoyer de l’argent, trouver les destinataires que vous pouvez payer, lister et récupérer des transferts lors du rapprochement des mouvements de fonds, et prévisualiser ou utiliser des liens de réclamation. Abonnez-vous à transfer.completed et transfer.failed pour connaître les résultats au lieu d’interroger l’API. Chaque compte participant peut s’abonner à ces événements. transfer.created est également émis en cas de succès, et non au début du traitement. Un transfert échoué peut être relancé sous le même ID et réussir plus tard ; récupérez le transfert pour rapprocher son statut actuel. Un transfert de solde réussi crédite le solde disponible du destinataire, sauf si une date de libération s’applique. Les transferts financés à partir du solde en attente conservent une date de libération et créditent le solde en attente ; les réserves applicables au destinataire ou les blocages pour fraude peuvent rendre les fonds indisponibles. succeeded confirme que le transfert est terminé, et non que tous les fonds peuvent être retirés.

Endpoints

Attributs

string
requis
ID du transfert.
object | null
requis
Montant crédité au destinataire. Null tant que le transfert n’a pas réussi.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales du montant. Il s’agit de la précision à laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, ce qui donne 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
string
requis
Date de création du transfert.
object | null
requis
Compte d’entreprise ou utilisateur qui reçoit le transfert.

Propriétés

string
requis
ID du compte ou de l’utilisateur.
string | null
requis
URL du logo de l’entreprise ou de l’avatar de l’utilisateur. Null si aucune image n’est disponible.
string | null
requis
Nom d’affichage de l’entreprise ou de l’utilisateur.
string
requis
Indique si le profil est un compte d’entreprise ou un utilisateur.Options disponibles : account, user
string | null
requis
Heure d’échec enregistrée. Null sauf si le transfert a échoué.
string | null
requis
Code d’échec lisible par machine. Null sauf si le transfert a échoué.
string | null
requis
Explication de l’échec. Null sauf si le transfert a échoué.
object | null
requis
Tous les frais de transfert applicables, majoration de la plateforme comprise. Null lorsque le total de référence n’est pas disponible.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales du montant. Il s’agit de la précision à laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, ce qui donne 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
object
requis
Métadonnées personnalisées associées au transfert.
string | null
requis
Note du transfert.
string
requis
Le type d’objet.
object | null
requis
Compte d’entreprise ou utilisateur qui envoie le transfert.

Propriétés

string
requis
ID du compte ou de l’utilisateur.
string | null
requis
URL du logo de l’entreprise ou de l’avatar de l’utilisateur. Null si aucune image n’est disponible.
string | null
requis
Nom d’affichage de l’entreprise ou de l’utilisateur.
string
requis
Indique si le profil est un compte d’entreprise ou un utilisateur.Options disponibles : account, user
string
requis
Statut actuel du transfert. Un transfert peut être créé avec le statut processing et être réglé quelques secondes plus tard ; interrogez Retrieve Transfer ou écoutez les webhooks transfer.completed et transfer.failed au lieu de considérer la réponse de création comme définitive. succeeded et failed sont des statuts finaux.Options disponibles : processing, succeeded, failed
string | null
requis
Heure enregistrée de la transition actuelle. Null lorsque l’heure de la transition historique est inconnue.
string | null
requis
Heure de réussite enregistrée. Null si inconnue.
string
requis
Page de suivi du transfert. Sa consultation nécessite une connexion et un accès au transfert.
Transfer