paymentResponse

L'objet paymentResponse détaille les informations sur la transaction.

Tableau 1. Objet paymentResponse
paymentResponse Format
transactionUuid

Référence unique de la transaction générée par la plateforme de paiement.

string

ans32

transactionId

Identifiant de la transaction lors de la création ou la modification d'une transaction de paiement.

Sa valeur est unique sur une même journée.

  • Soit cet identifiant est généré par la plateforme.
  • Soit cet identifiant est généré par le site marchand.

an..6
amount

Montant de la transaction dans sa plus petite unité monétaire (le centime pour l'euro) .

n..12
currency

Code de la devise de la transaction (norme ISO 4217).

Ex : 978 pour l'euro (EUR)

n3
effectiveAmount

Montant de la transaction dans la devise réellement utilisée pour effectuer la remise en banque.

n..12
effectiveCurrency

Devise réellement utilisée pour effectuer la remise en banque.

n3
expectedCaptureDate

Date de remise en banque souhaitée.

Remarque : si le délai avant remise est supérieur à 365 jours dans la requête de paiement, il est automatiquement repositionné à 365 jours.

dateTime ans..40
operationType

Type d'opération.

Les valeurs possibles sont :

  • 0 pour une opération de débit.
  • 1 pour une opération de remboursement.
  • 5 pour une transaction de type VERIFICATION
n1
creationDate

Date et heure de l’enregistrement de la transaction exprimée au format W3C.

dateTime ans..40
externalTransactionId

Référence fournie par un tiers : numéro de transaction pour PayPal, Boleto, RRN pour Prism, etc…

string
liabilityShift

Transfert de responsabilité.

Les valeurs possibles sont :

  • YES lorsque le paiement est garanti.
  • NO lorsque le paiement n'est pas garanti.
string
paymentType

Type de paiement.

Les valeurs possibles sont :

  • SINGLE
    Paiement en une seule fois.
  • INSTALLMENT
    Paiement en plusieurs fois.
  • SPLIT
    Paiement effectué avec plusieurs moyens de paiement.
  • SUBSCRIPTION
    Paiement par alias ou paiement récurrent. S'applique aussi aux transactions de type Vérification (création et mise à jour d'un alias).
  • RETRY
    Lors d'un paiement refusé, il est possible de réitérer la demande de paiement. Pour toute(s) réitération(s), le paiement est valorisé avec cette valeur.

Remarque :

Les valeurs INSTALLMENT et SPLIT peuvent être retournées uniquement si des paiements ont été créés via le formulaire de paiement.

string

(enum)

sequenceNumber
Numéro de séquence de la transaction. Sa valeur est fonction du contexte du paiement :
  • Est valorisé à "1" pour un paiement unitaire.
  • Est valorisé à "2" lors du rejeu d'un paiement initialement refusé.
  • Prend la valeur du numéro d’échéance dans le cas d’un paiement en plusieurs fois créé à partir du formulaire de paiement.
n..3
paymentError

Complément d’information en cas d’erreur technique. Retourne un code d'erreur associé à l'erreur technique (voir chapitre Codes d'erreurs pouvant survenir durant le paiement).

n..3
nsu

Apparaît lorsque isNsuRequested est valorisé à 1 dans la requête.

string