API Documentation
\

\Transfer

Classe listant les differentes méthodes liées aux paiements

  • Méthodes :
    • makePayment (Méthode pour effectuer un paiement)
    • refundPayment (Méthode pour rembourser une commande)
    • getTransactions (Lister les transactions d'un utilisateur)
    • getStatusTransaction (Connaitre le statut d'un paiement)

Summary

Methods
Properties
Constants
makePayment()
refundPayment()
getTransactions()
getStatusTransaction()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

makePayment()

makePayment(integer  $userToDebited, integer  $idCardDebited, integer  $userToCredited, float  $amount, float  $amountFees, \Entity\ApplicationEntity  $ApplicationEntity, boolean  $codeVoucher = false) : array

Méthode pour effectuer un paiement

Parameters

integer $userToDebited

ID de l'utilisateur à debiter
integer $idCardDebited

ID de la carte à utiliser appartenant à $userToDebited
integer $userToCredited

ID de l'utilisateur à créditer
float $amount

Montant du transfert (incluant la commission)
float $amountFees

Montant de la commission (inclut dans $amount)
\Entity\ApplicationEntity $ApplicationEntity

Ne pas tenir compte
boolean $codeVoucher

(facultatif) Code du bon de réduction à utiliser

Returns

array —

Success paiement :

['success'] (string) Paiement effectué
['idTransferGroup'] (int) ID du paiement/commande
['amountPayWithCard'] (float) Montant payé par carte (!! Est renseigné seulement si un paiement a été effectué par carte !!)
['amountPayWithWallet'] (float) Montant payé par wallet (!! Est renseigné seulement si un paiement a été effectué par wallet !!)

Paiement nécessitant une autorisation 3DSecure:

['url3DSecure'] (string) Url pour saisir le code 3DSecure
['idTransferGroup'] (int) ID du paiement/commande

Error paiement :

['error'] (string) Description de l'erreur
['urlMakeNewPayment'] (string) URL permettant d'effectuer un nouveau paiement en saisissant une nouvelle carte bleu (!! N'apparait pas dans tous les retours 'error' !!)
['idTransferGroup'] (int) ID du paiement/commande


!! Pour vérifier si le paiement a bien été effectué pour un paiement avec 3DSecure ou avec une nouvelle URL, voir la méthode : getStatusTransaction() prenant comme paramètre le 'idTransferGroup' retourné

refundPayment()

refundPayment(integer  $user_id, integer  $transfer_id_group, \Entity\ApplicationEntity  $ApplicationEntity) : array

Méthode pour rembourser une commande

Parameters

integer $user_id

ID de l'utilisateur qui a été débité pour le paiement
integer $transfer_id_group

ID du paiement/commande
\Entity\ApplicationEntity $ApplicationEntity

Ne pas tenir compte

Throws

\Exception

Returns

array —

Success : 

['success'] (string) La commande a bien été remboursée.

Error :

['error'] (string) Le remboursement de la commande n'a pas abouti.

getTransactions()

getTransactions(integer  $userId, \Entity\ApplicationEntity  $ApplicationEntity) : array

Lister les transactions d'un utilisateur

Parameters

integer $userId

ID de l'utilisateur pour lequel on souhaite lister les transactions
\Entity\ApplicationEntity $ApplicationEntity

Ne pas tenir compte

Returns

array —

Success :

[]['id_transfer_group'] (int) ID du paiement/commande
[]['transfer'] (string) Définit si l'utilisateur a été débité ou crédité ('debited' ou 'credited')
[]['userIdWith'] (int) ID de l'autre utilisateur participant à la transaction
[]['amountTotal'] (float) Montant de la commande ('debited': montant total payé, 'credited': montant crédité sur son wallet)
[]['amountVoucher'] (float) Montant du bon de réduction utilisé qui a été déduit de 'amountTotal' (0 si pas de bon de réduction utilisé) (!! Est renseigné seulement si 'transfer' == 'debited' !!)
[]['statusPayment'] (string) Statut du paiement ('payed' : paiement effectué, 'refunded' : paiement remboursé, 'canceled' : Paiement annulé, 'pending' : une partie a été payé)
[]['date'] (string) Date du transfert (ex: 2016-05-09 14:14:18)
[]['detail'] (array) (!! Est renseigné seulement si 'transfer' == 'debited' !!)
     []['payWith'] (string) Moyen de paiement ('card' ou 'wallet')
     []['amount'] (float) Montant payé

Retourne un tableau vide si aucune transaction pour l'utilisateur

Error :

['error'] (string) Description de l'erreur

getStatusTransaction()

getStatusTransaction(integer  $idTransferGroup, \Entity\ApplicationEntity  $ApplicationEntity) : array

Connaitre le statut d'un paiement

Parameters

integer $idTransferGroup

ID du paiement dont on souhaite connaitre le statut
\Entity\ApplicationEntity $ApplicationEntity

Ne pas tenir compte

Throws

\Exception

Returns

array —

Success :

['statusTransfer'] (string) Statut du paiement
     ('payed' : Paiement effectué, 'initialized' : Aucun paiement n'a été effectué, 'refunded' : Paiement remboursé, 'canceled' : Paiement annulé, 'pending' : Une partie a été payé)

Error :

['error'] (string) Description de l'erreur