Transfers

Ressources

Accès aux envois d’argent :

- Accès aux paiements de l’utilisateur connecté
/api/(domainePartenaire)/payments/

- Accès aux paiements d’un utilisateur appartenant à l’application tierce connectée
/api/(domainePartenaire)/users/appuserid/payments/

1.Payment
L’objet envoi d’argent est un objet permettant d’envoyer de l’argent entre deux comptes (ou sous compte).

Propriété Type Exemple Description
OrderId String “order_001” Identifiant de l’envoi d’argent chez l’application tierce
Id Long 18 Identifiant de l’envoi d’argent
PaymentDate DateTime "2013-09-10T
15:50:37.2363199
+02:00"
Date du paiement
Amount Long 1250 Montant du paiement (en centimes)
Fee Fee Objet contenant la commission
Status Int 1 Statut du paiement
0 = En attente
1 = Remboursé
2 = Expiré
3 = Validé
4 = Erreur
Beneficiary SubAccountRef Objet contenant le détail du receveur
Message String "Déjeuner au restaurant" Message de l’envoi d’argent
Sender SubAccountRef Objet contenant le détail de l’envoyeur.
Si non précisé, c’est le sous-compte principal de l’utilisateur connecté qui est utilisé

2.SubAccountRef
Cet objet permet d’identifier les comptes entre lesquels les opérations s’effectuent.

Propriété Type Exemple Description
Id Long 98 Identifiant du compte.
AppAccountId String "123" Identifiant du compte fournit par l’appli tierce.
DisplayName String "Jean Dupont" Nom d’affichage du compte
Href Uri "/api/accounts/123" Uri vers le détail du compte

3.Fee
L’objet Fee définit les commissions qui seront appliquées.

Propriété Type Exemple Description
Amount long 150 Montant HT de la commission (en centimes)
VAT double 20 Pourcentage de la commission (en pourcentage)
AmountWithVAT long 180 Montant TTC de la commission (en centimes)
Status Int 1 Statut de la commission
0 = En attente
1 = Réalisé
2 = Remboursé
3 = Echoué
5 = Annulé

Créer un transfert d’argent

Pour créer un envoi d’argent veuillez vous référer à l’exemple présent en marge de droite de cette page.

Cas d’erreurs :

Code HTTP Code erreur Explication
401 362 Opération non autorisée
401 569 Token OAuth expiré
401 570 Token OAuth invalide
400 704 Paramètre d’appel manquant
400 177 Paramètre d’appel invalide
404 147 Compte introuvable
400 500 Le compte de l’envoyeur est en opposition
400 111 Statut de l’envoyeur invalide
400 127 L’envoyeur et le bénéficiaire ne peuvent pas être le même compte
400 345 Compte du bénéficiaire incorrect ou incomplet
400 110 Solde insuffisant pour effectuer l’opération
400 701 Plafond de transaction atteint (client non bancarisé)
400 702 Plafond de transaction atteint (client KYC)
400 703 Plafond de transaction atteint (client non KYC)
400 177 Valeur de paramètre invalide (orderId déjà existant)
400 177 Valeur de paramètre invalide (Tous les paramètres orderId doivent être uniques)

Récupérer la liste des transferts d’argent

Pour récupérer la liste des envois d’argent veuillez vous référer à l’exemple présent en marge de droite de cette page.

Cas d’erreurs :

Code HTTP Code erreur Explication
401 362 Opération non autorisée
401 569 Token OAuth expiré
401 570 Token OAuth invalide

Récupérer un transfert d’argent

Pour récupérer la liste des envois d’argent veuillez vous référer à l’exemple présent en marge de droite de cette page.

Cas d’erreurs :

Code HTTP Code erreur Explication
401 362 Opération non autorisée
401 569 Token OAuth expiré
401 570 Token OAuth invalide
404 356 Opération introuvable