Documentation Powered by Redocly

Monetico Split - Documentation API (22.0 2025-11-04)

Download OpenAPI specification:Download

API Version 1.2

Database: ECT7_PARTNERS_V2200

Introduction

Nos API permettent aux sites de E-commerce et Marketplaces, qui doivent être en mesure d’accepter des paiements et de procéder à des virements vers un ou plusieurs marchands, d’intégrer une solution de paiement simple et adaptée à leurs besoins opérationnels et réglementaires.

Notifications

Description des notifications envoyées par la plateforme Paysurf. Ces dernières sont envoyées au format JSON.

Changement de statut d'un compte marchand (walletStatusChanged)

Clé Description Valeur
NotifCategory Type de notification walletStatusChanged
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
Status Statut du compte marchand [ incompleteFile, rejectedDocuments, kyc1, kyc2, kyc3, expiredDocuments, blocked, closed, pendingKyc3]
AccountStatus Statut du compte marchand (Nouveau) [ 5, 6, 7, 12, 13, 17]

Bloquer un compte marchand (blockedWalletStatusChanged)

Clé Description Valeur
NotifCategory Type de notification blockedWalletStatusChanged
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
Status Etat du compte marchand blocked
AccountStatus Etat du compte marchand (Nouveau) [10]

Changement de statut document (documentStatusChanged)

Clé Description Valeur
NotifCategory Type de notification documentStatusChanged
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
DocId Identifiant du document 2
Status Statut du document [ standBy, receivedPending, accepted, rejectedOther, rejectedIllegible, rejectedExpired, rejectedWrongType, rejectedWrongHolder, pendingValidation ]

Réponse mise à jour marchand (pendingValidationProcessedByPaysurf)

Clé Description Valeur
NotifCategory Type de notification pendingValidationProcessedByPaysurf
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
Modification Type de champ [ email, title, firstName, lastName, birthName, street, postCode, city, country, mobilePhone, extraPhone, birthDate, companyName, companyWebsite, companyDescription, registrationNumber, nationality, birthCity, birthCountry, legalForm ]
Statut Statut de la modification [ pending, validated, refused ]
Commentaire Commentaire de modification Modification refusée

Chargeback - imputation partenaire (chargeback)

Clé Description Valeur
NotifCategory Type de notification chargeback
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
IdTransaction Identifiant du chargeback 255
Amount Montant du chargeback 23.99
Status Statut du chargeback [ notRecovered, partiallyRecovered, fullyRecovered ]

Recrédit impayé marchand partenaire (recreditChargeBack)

Clé Description Valeur
NotifCategory Type de notification recreditChargeBack
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
IdTransaction Identifiant de la transaction d'origine 255
Amount Montant de la transaction d'origine 23.99
Status Statut de la transaction d'origine [ complete, pending, error, pendingTunz, pendingAchievement, cancelledAddMoneyTrans, cancelledAchieveMoneyTrans, cancelled, unpaid, refunded, rejected, partialUnpaid, toValidate, registerCard]

Rejet de virement sortant (moneyOutRefused)

Clé Description Valeur
NotifCategory Type de notification moneyOutRefused
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
IdTransaction Identifiant de la transaction d'origine 255
Amount Montant de la transaction d'origine 23.99
Status Statut de la transaction d'origine rejected
Commentaire Commentaire de rejet Le compte de paiement a été re-crédité suite à une erreur technique. Merci de contacter le support Paysurf

État de transaction suite à achat par virement (moneyInByWireReceived)

Clé Description Valeur
NotifCategory Type de notification moneyInByWireReceived
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
IdTransaction Identifiant de la transaction d'origine 255
Amount Montant de la transaction d'origine 23.99
Status Statut de la transaction d'origine [ complete, pending, error, pendingTunz, pendingAchievement, cancelledAddMoneyTrans, cancelledAchieveMoneyTrans, cancelled, unpaid, refunded, rejected, partialUnpaid, toValidate, registerCard]
P2Ps Liste des couples accountId / p2PId de ventilation [ { "p2PId": "100", "accountId": "merchant1" }, { "p2PId": "101", "accountId": "merchant2" } ]

État de transaction suite à achat par initiation de paiement (moneyInByPaymentInitiationReceived)

Clé Description Valeur
NotifCategory Type de notification moneyInByPaymentInitiationReceived
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
IdTransaction Identifiant de la transaction d'origine 255
OrderReference Référence de la commande Référence
Amount Montant de la transaction d'origine 23.99
Status Statut de la transaction d'origine [complete, pending, error, pendingTunz, pendingAchievement, cancelledAddMoneyTrans, cancelledAchieveMoneyTrans, cancelled, unpaid, refunded, rejected, partialUnpaid, toValidate, registerCard]
P2Ps Liste des couples accountId / p2PId de ventilation [ { "p2PId": "100", "accountId": "merchant1" }, { "p2PId": "101", "accountId": "merchant2" } ]

État de transaction suite à achat par carte (moneyInByCardOnlineReceived)

Clé Description Valeur
NotifCategory Type de notification moneyInByCardOnlineReceived
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
OrderReference Token marchand wkToken
IdTransaction Identifiant de la transaction d'origine 255
Amount Montant de la transaction d'origine 23.99
Status Statut de la transaction d'origine [ complete, pending, error, pendingTunz, pendingAchievement, cancelledAddMoneyTrans, cancelledAchieveMoneyTrans, cancelled, unpaid, refunded, rejected, partialUnpaid, toValidate, registerCard]
P2Ps Liste des couples accountId / p2PId de ventilation [ { "p2PId": "100", "accountId": "merchant1" }, { "p2PId": "101", "accountId": "merchant2" } ]

Transaction rapprochée (operationReconciled)

Clé Description Valeur
NotifCategory Type de notification operationReconciled
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
IdTransactionOrigin Identifiant de la transaction rapprochée 255
Amount Montant de la transaction 23.99

P2P validé par les équipes Paysurf (validatedByPaysurf)

Clé Description Valeur
NotifCategory Type de notification validatedByPaysurf
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
IdTransaction Identifiant du P2P validé 128
IdTransactionOrigin Identifiant de la transaction d'origine 255
Amount Montant du P2P validé 23.99

Recouvrement marchand réalisé par Paysurf (ChargebackRecoveredByPaysurf)

Clé Description Valeur
NotifCategory Type de notification ChargebackRecoveredByPaysurf
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
IdTransaction Identifiant du chargeback 255
Amount Montant du recouvrement 5.00
Status Statut du chargeback [ notRecovered, partiallyRecovered, fullyRecovered ]

IBAN accepté, refusé ou rejeté par Paysurf (ibanStatusChanged)

Clé Description Valeur
NotifCategory Type de notification ibanStatusChanged
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
IbanId Identifiant de l'iban 199
Status Statut de l'IBAN [ ibanAcceptedPaysurf, ibanRefusedPaysurf, rejectedPaysurfIbanData ]

Nouvelle carte de paiement enregistrée (registerCard)

Clé Description Valeur
NotifCategory Type de notification registerCard
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
CardId Identifiant de la carte de paiement 1
Status Statut de la carte de paiement [ pending, complete, disabled ]
IdTransaction Identifiant de la transaction à l'origine de la création de la carte de paiement 255

État de transaction suite à achat par carte fractionné (MoneyInInstallmentPayment)

Clé Description Valeur
NotifCategory Type de notification MoneyInInstallmentPayment
NotifDate Date d'envoi de la notification 2022-01-01T12:00:00Z
IdTransaction Identifiant de la transaction d'origine 255
Amount Montant de la transaction d'origine 23.99
Status Statut de la transaction d'origine [ complete, pending, error, pendingTunz, pendingAchievement, cancelledAddMoneyTrans, cancelledAchieveMoneyTrans, cancelled, unpaid, refunded, rejected, partialUnpaid, toValidate, registerCard]
P2Ps Liste des couples accountId / p2PId de ventilation [ { "p2PId": "100", "accountId": "merchant1" }, { "p2PId": "101", "accountId": "merchant2" } ]

Seuil minimum atteint par un marchand (LowFundThresholdReached)

Clé Description Valeur
NotifCategory Type de notification LowFundThresholdReached
NotifDate Date d'envoi de la notification 2022-01-01T12:00:00Z
ExtId Id externe du compte marchand merchant
Amount Montant du compte marchand 100.99

Demande d'alimentation d'un compte marchand par virement (MoneyInMerchantTransfer)

Clé Description Valeur
NotifCategory Type de notification MoneyInMerchantTransfer
NotifDate Date d'envoi de la notification 2022-01-01T12:00:00Z
ExtId Id externe du compte marchand merchant
Amount Montant du virement 100.99
TransferReference Référence du virement XXXXXX-XXXX-XXXX-XXXX-ACP-IDEXTMARCHAND

Changement de statut de la revue KYC (KycReviewStatusChanged)

Clé Description Valeur
NotifCategory Type de notification KycReviewStatusChanged
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
Status Statut de la revue KYC [ inProgress, reviewed, expired]

État de transaction suite à achat par carte proximité (moneyInByCardInStoreReceived)

Clé Description Valeur
NotifCategory Type de notification moneyInByCardInstoreReceived
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
ArchivingKey Référence d’archivage de la transaction SIP1T123456
IdTransaction Identifiant de la transaction d'origine 255
Amount Montant de la transaction d'origine 23.99
Status Statut de la transaction d'origine [ complete, pending, error, pendingTunz, pendingAchievement, cancelledAddMoneyTrans, cancelledAchieveMoneyTrans, cancelled, unpaid, refunded, rejected, partialUnpaid, toValidate, registerCard]
P2Ps Liste des couples accountId / p2PId de ventilation [ { "p2PId": "100", "accountId": "merchant1" }, { "p2PId": "101", "accountId": "merchant2" } ]

Remboursement transaction proximité (refundInStoreReceived)

Clé Description Valeur
NotifCategory Type de notification refundInStoreReceived
NotifDate Date d'envoi de la notification 2020-01-01T12:00:00Z
ArchivingKeyTi Référence d’archivage de la transaction initiale SIP1T123456
ArchivingKeyTr Référence d’archivage de la transaction de remboursement SIP1T123457
IdTransaction Identifiant de la transaction de remboursement 255
Amount Montant de la transaction de remboursement 23.99
Status Statut de la transaction de remboursement [ complete, pending, error, pendingTunz, pendingAchievement, cancelledAddMoneyTrans, cancelledAchieveMoneyTrans, cancelled, unpaid, refunded, rejected, partialUnpaid, toValidate, registerCard]
P2Ps Liste des couples accountId / p2PId de remboursement [ { "p2PId": "100", "accountId": "merchant1" }, { "p2PId": "101", "accountId": "merchant2" } ]

Modification de l'état d'un e-mandat prélèvement (directDebitMandateStatusChanged)

Clé Description Valeur
NotifCategory Type de notification directDebitMandateStatusChanged
NotifDate Date d'envoi de la notification 2024-01-01T12:00:00Z
RUM Référence Unique du Mandat EID12300000000012345678901234567890
Status Statut d'un e-mandat prélèvement [waiting, notSigned, signed, cancelled, closed, error]

Création d'une échéance prélèvement (moneyInByDirectDebitCreated)

Clé Description Valeur
NotifCategory Type de notification moneyInByDirectDebitCreated
NotifDate Date d'envoi de la notification 2024-01-01T12:00:00Z
RUM Référence Unique du Mandat EID12300000000012345678901234567890
DirectDebitId Identifiant de l'échéancier 10
Amount Montant de la transaction 23.99
TransactionId Identifiant de la transaction 42

Annulation d'une échéance prélèvement (moneyInByDirectDebitCanceled)

Clé Description Valeur
NotifCategory Type de notification moneyInByDirectDebitCanceled
NotifDate Date d'envoi de la notification 2024-01-01T12:00:00Z
RUM Référence Unique du Mandat EID12300000000012345678901234567890
DirectDebitId Identifiant de l'échéancier 10
Amount Montant de la transaction 23.99
TransactionId Identifiant de la transaction 255

État de la transaction suite à un achat par prélèvement (moneyInByDirectDebitReceived)

Clé Description Valeur
NotifCategory Type de notification moneyInByDirectDebitReceived
NotifDate Date d'envoi de la notification 2024-01-01T12:00:00Z
RUM Référence Unique du Mandat EID12300000000012345678901234567890
DirectDebitId Identifiant de l'échéancier 10
IntId Identifiant interne compte marchand 15
ExtId Identifiant compte marchand merchant
TransactionId Identifiant de la transaction 255
Amount Montant de la transaction 23.99
Status Statut de la transaction [ complete, pending, error, pendingTunz, pendingAchievement, cancelledAddMoneyTrans, cancelledAchieveMoneyTrans, cancelled, unpaid, refunded, rejected, partialUnpaid, toValidate, registerCard]
P2Ps Liste des couples accountId / p2PId de ventilation [ { "p2PId": "100", "accountId": "merchant1" }, { "p2PId": "101", "accountId": "merchant2" } ]
OrderReference Référence de la commande Référence

Modification de l'état d'un échéancier prélèvement (directDebitStatusChanged)

Clé Description Valeur
NotifCategory Type de notification directDebitStatusChanged
NotifDate Date d'envoi de la notification 2024-01-01T12:00:00Z
RUM Référence Unique du Mandat EID12300000000012345678901234567890
DirectDebitId Identifiant de l'échéancier 42
Status Statut d'un échéancier prélèvement [enabled, suspended, closed]

Statuts et Types

Description des statuts envoyes par la plateforme Paysurf.

Statuts du compte marchand (Nouveau) (AccountStatus)

Statuts Description
5 Attente
6 Valide Seuil 1
7 Valide Seuil 2
12 Fermeture complete
13 En attente Validation Seuil 2
17 Refuse - dossier KYC non valide

Type d'erreurs

BadRequest (400)

Type Description
accountBalanceLow Le solde du compte {0} est insuffisant
accountPendingValidation Une nouvelle demande de modification ne sera disponible uniquement quand les anciennes demandes seront traitées.
amountLessThanOriginal Le montant saisi est inférieur du montant original
amountNotAllowed Montant non autorisé
cardDeleteFailed Impossible de désactiver la carte
cardPending Cette carte n'a pas été confirmée
chargebackAmountAccountFullyRecovered Le chargeback a totalement été recouvert pour ce compte
chargebackAmountRecovered Le montant renseigné ({0}{1}) est plus important que le montant à recouvrir restant ({2}{3})
chargebackFullyRecovered Le chargeback a totalement été recouvert
chargebackRecoverAccountP2PMismatch L'identifiant de compte marchand et l'identifiant de P2P ne correspondent pas
chargebackRecoverNotEnoughMoney Le compte n’a pas suffisant des fonds pour recouvrir ce chargeback
chargebackRecoverPendingP2P Un P2P lié à cette opération est en attente de validation
commissionAmount Le montant du remboursement doit correspondre au montant de la commission versée
commissionTransactionAlreadyRefunded Commission déjà remboursée sur cet ID de ventilation
createRICFailed Echec de création de l’image contrat : {0}
directDebitInvalidData Données invalides ou incompatibles avec l'existant
directDebitKeyInvalid Clef échéancier invalide
directDebitMandateInputError Le format du paramètre est invalide : {0}
directDebitMandateSessionProblem Problème de session
errorCommission La commission TTC est inférieure à 0
extensionFile Extension du fichier incorrecte
formatDocument Format du document incorrect
hostedFieldsInvalidConfiguration La configuration pour Hosted Fields est invalide. Veuillez vérifier le Code Société HF
insufficientBalanceMerchant Le marchand ne peut pas payer la commission
insufficientBalanceSociety Le montant de la commission est supérieur au solde du compte de la société
insufficientFunds Le compte du Marchand {0} et le compte du partenaire {1} ne sont pas suffisamment approvisionnés
invalidCart Les marchands {0} ne sont pas valides
invalidClient Le payeur ne peut pas être personne morale et physique
invalidCountryCodeIso Le code du pays saisi n'est pas conforme à la norme ISO 3166-1 alpha3
invalidDocumentationState L'opération demandée n'est pas autorisée en raison du statut de la documentation
invalidIban L'IBAN renseigné ne correspond pas à l'utilisateur ou n'est pas valide
invalidParameters Les paramètres d'entrée du modèle sont invalides
invalidPaymentMethod La méthode de paiement n'est pas valide
invalidPspParameters La configuration PSP est invalide. Vérifiez le numéro de TPE, la clef et les codes sociétés
invalidTpe Paiement non autorié - Type de paiement carte {0}
invalidTrans Transaction invalide
invalidTransactionIssuerInformations Les informations de l'emetteur de la transaction doivent contenir soit son nom et prénom soit la raison social d'entreprise
invalidTransactionStatusToRefund Statut invalide de la transaction à rembourser
invalidTransferStatusToRefund On ne peut pas rembourser un virement en attente ou annulé.
moneyInCancelAmount Impossible de rembourser plus que le montant d'origine
moneyInCancelBalanceLow Solde insuffisant pour le remboursement
moneyInCancelOriginTransactionInvalidStatus Le statut de la transaction d'origine ne permet pas d'effectuer un remboursement
moneyInCancelRefundedAmount Le montant à rembourser dépasse le montant total ayant déjà été remboursé
moneyInValidateCardExpired Validation du paiement impossible, la carte est expirée.
moneyInValidateInvalidCartAmount Le montant associé aux marchand {0} du nouveau panier est supérieur à l'original
moneyInValidateInvalidCartMerchants Le nombre de marchand est supérieur au panier d'origine
moneyInValidateInvalidMerchant Le marchand {0} n'est pas présent dans la transaction d'origine
monthlyMoneyInLimitReached Le compte {0} a atteint sa limite mensuelle de moneyIn
monthlyMoneyOutLimitReached Le compte {0} a atteint sa limite mensuelle de moneyOut
noActiveEpt Il n'y a pas de TPE actif pour ce mode de paiement
oneShotPaymentLimitReached Le compte {0} a un montant supérieur au plafond one shot
originP2PNotComplete Le P2P d'origine n'est pas en statut complete
p2PCommissionGreaterThanAmountToRecover Le montant saisi est supérieur au montant restant à recouvrir pour ce paiement de ventilation
p2PCommissionGreaterThanInitialAmount Le montant saisi est supérieur au montant de la transaction initiale
p2PDoesNotBelongToWallet Le walletId et le transactionId ne correspondent pas
p2PStatusAlreadyComplete Le P2P est déjà en statut "Complete"
p2PStatusComplete Impossible de modifier un P2P en statut "Complete"
refundAmount Le montant que vous souhaitez actuellement rembourser ({0}) est supérieur à la différence entre le montant de la transaction initiale ({1}) et des montants déjà remboursés ({2})
refundPendingP2P Vous ne pouvez pas faire de remboursement partiel sur un Paiement OnUs de ventilation toujours en attente
temporaryPasswordExpired Le mot de passe temporaire est expiré
thirdPartyInvalid Le numéro tiers est invalide
transactionAlreadyCanceled La transaction a déjà été annulée
transactionAmountThresholdReached Le somme des transactions dépasse le montant seuil
transactionNumberOrAmountThresholdReached Le nombre ou la somme des transactions dépassent les seuils
transactionNumberThresholdReached Le nombre de transactions dépasse le seul
unsupportedMerchantCountryCode '{0}' n'appartient ni à la France ni à l'EEE
uploadSamePendingDocType Vous avez déjà un document du même type en attente de traitement
wrongAccount L’ID marchand Emetteur et l’ID marchands Bénéficiaire ne correspondent pas à une transaction d’origine
yearlyMoneyInLimitReached Le compte {0} a atteint sa limite annuelle de moneyIn
yearlyMoneyOutLimitReached Le compte {0} a atteint sa limite annuelle de moneyOut

Unauthorized (401)

Type Description
clientCertificateInvalid Le certificat client du partenaire est invalide
clientCertificateNotEmitted Le certificat client du partenaire n'est pas émis
clientCertificateNotFound Le certificat client du partenaire n'existe pas
invalidApiKey La clé de l'api est invalide ({0})
unauthorizedAccess Accès refusé à l'api

Forbidden (403)

Type Description
accountBlocked Le compte {0} est bloqué
accountClosed L'état fermé du compte {0} ne lui permet pas d'effectuer/recevoir des opérations
accountFrozen L'état gelé du compte {0} ne lui permet pas d'effectuer/recevoir des opérations
accountUnspecifiedError Erreur non spécifiée - compte : {0}
blacklistEmail Le mail {0} n'est pas autorisé par le système
blacklistIban L'IBAN {0} n'est pas autorisé dans notre système
blacklistIp L'IP {0} n'est pas autorisée dans notre système
blacklistSiret Le SIRET {0} n'est pas autorisé dans notre système
blockedAccountStatus L'état bloqué du compte "{0}" ne lui permet pas d'effectuer ce type d'opération.
closedAccountModification Pas de modification possible sur un compte fermé
commissionCalculation Erreur lors du calcul de la commission
companyNameInvalid La raison social du marchand "{0}" n'est pas valide
companyNameInvalid La raison social du marchand "{0}" n'est pas valide
directDebitCannotBeClosed Le e-prélèvement ne peut être clôturé
directDebitClosed L'échéancier est clos
directDebitDisabledOrSuspended L'échéancier est désactivé ou suspendu
directDebitDueDatePostponementImpossible Report d'échéance impossible pour un prélèvement à durée illimitée ou à échéance unique
directDebitDueInOrLessFourDays La date de l'échéance est dans moins de quatre jours, modification impossible
directDebitIsNotReactivable L'échéancier n'est pas ré-activable
directDebitLinkedMandateInvalid Le mandat de prélèvement associé n'est pas ou plus valide
directDebitMandateAlreadyClosed Le mandat de prélèvement est déjà révoqué
directDebitMandateAlreadySigned Le mandat de prélèvement est déjà signé
directDebitMandateInternalError Erreur interne mandat de prélèvement lors de l'exécution de l'opération, veuillez réessayer ultérieurement
directDebitMandateNotSigned Le mandat de prélèvement n'est pas signé
directDebitMultipleUnpaidFoundAtTheseDates Plusieurs impayés peuvent être réémis pour les dates indiquées
directDebitNoDataToModify Aucune donnée à modifier
directDebitPlannedDueDatePassed La date de l'échéance planifiée est révolue ({0}), modification impossible
directDebitPlannedDueInOrLessFourDays La date de l'échéance planifiée est dans moins de quatre jours ({0}), modification impossible
directDebitsUnclosed Les échéanciers ne sont pas clos
directDebitTooManyDueDateToSuspend Le nombre échéances à suspendre est supérieur au nombre échéances restantes
directDebitUnauthorizedReconciliationRejectCode Le code de rejet n'est pas autorisé
directDebitUnpaidNotFoundAtTheseDates Pas d'impayés pouvant être réémis pour les dates indiquées
directDebitUnpaidResendTimeExceeded Délai de réémission impayé dépassé
featUnavailable Cette fonctionnalité est indisponible
headerIpInvalidFormat Format de l'adresse IP invalide
headerIpRequired Le header {0} doit être renseigné
hostedFieldsTransactionExpected La transaction n'utilise pas le mode Hosted Fields
ibanCountryMismatch Le pays de l'IBAN ne correspond pas au pays des autres IBAN de ce compte
internalError Erreur Interne à Paysurf, veuillez contacter le SAV Paysurf
invalidCompanyName Raison Sociale invalide
invalidCountryCode Code pays invalide pour cette opération
invalidPostCode Code postal invalide
invalidRegistrationNumber Numéro d'enregistrement invalide
maximumPageSizeReached Taille de la pagination maximal atteinte. Taille max : "{0}"
missingSqlParameter Paramètre manquant
onlyOneMerchantInCart Le panier ne peut contenir qu'un seul marchand
originP2PNotCompleteOrPartialRefund Le P2P d'origine n'est pas en statut complet ou partiellement remboursé
originP2PTypeNotManaged Le type de P2P d'origine n'est pas géré
originTransactionAccount Problème sur le compte de la transaction d'origine
p2PAlreadyFullyRefund Le P2P "{0}" est déjà entièrement remboursé
pendingTransferFailed Erreur lors de la création du virement en attente
pspInternal Erreur interne du PSP lors de l'exécution de l'opération, veuillez réessayer ultérieurement
pspRefused Opération refusée par la banque
pspTimeout Erreur de timeout PSP
pspUnknown PSP inconnu
pspUpAndNetUnknown Erreur de timeout PSP
sameAccount L’ID marchand Emetteur doit être différent de l’ID marchands Bénéficiaire
statusNotManaged Statut non géré
transactionAlreadyCompleted La transaction est déjà terminée
transactionMustBeTransfer La transaction "{0}" doit être un virement
transactionMustBeTransfer La transaction "{0}" doit être un virement
transactionNotFoundOrCannotBeConfirmed La transaction n'existe pas ou ne peut être confirmée par cette procédure
transactionTypeNotManaged Le type de transaction n'est pas géré
unauthorizedKycStatus Le statut KYC du compte {0} ne lui permet pas d'effectuer/recevoir des opérations
unauthorizedP2PRefundAmount Le montant à rembourser dépasse le montant saisi moins le total ayant déjà été remboursé
unauthorizedTransactionStatus Le statut de la transaction n'est pas supporté
unexpectedHostedFieldsStep L'étape Hosted Fields actuelle n'est pas valide
unknown Service momentanément indisponible. Veuillez réessayer ultérieurement
uploadFailed Erreur lors du téléchargement du document
uploadPreviousDocumentNotFound Impossible de trouver le document précédent

NotFound (404)

Type Description
accountNotFound Compte inexistant
accountSpecifiedNotFound Le compte {0} est inexistant
cardAlreadyDeleted Cette carte a déjà été désactivée
cardNotFound La carte n'est pas reconnue
chargebackNotFound Chargeback non trouvé
directDebitMandateNotFound Mandat de prélèvement non trouvé
directDebitNotFound L'échéancier est inexistant
documentNotFound Le document n'a pas été trouvé
invalidPayementField Les champs [{1}] et [{2}] ne peuvent pas être présent tous les deux
invalidTpeInstallmentPayement Paiement fractionné non autorisé, veuillez contacter le support
moneyInNotFound La transaction entrante n'a pas été trouvée
moneyOutNotFound La transaction sortante n'a pas été trouvée
notFound Élément non trouvé
p2PNotFound Le P2P n'existe pas
partnerNotFound Le partenaire "{0}" n'a pas pu être identifié
refundNotFound La transaction de remboursement n'a pas été trouvée
refundOmnicanalContractNotFound Numéro de contrat de remboursement omnicanal non trouvé
ribNotFound RIB introuvable
thirdPartyNotFound La reference tiers n'existe pas
transactionNotFound La transaction n'existe pas
undefinedUrlConfig URL de configuration non trouvée

Conflict (409)

Type Description
accountAlreadyExists Le compte marchand existe déjà
accountEmailAlreadyRegistered Votre adresse email correspond à un compte existant, veuillez utiliser un email différent
siretSirenAlreadyExists Le SIRET/SIREN existe déjà

Authentication

x-api-key

La clé API qui vous sera fournie devra être renseignée à chaque appel de l'API. Dans le cas où la clé n'est pas présente, cette erreur sera retournée par l'API :

{
    "code": "unauthorizedAccess",
    "message": "Unauthorized : accès refusé au site Web"
}

Si la clé est renseignée mais erronée, alors cette erreur sera retournée :

{
    "code": "invalidApiKey",
    "message": "La clé de l'api est invalide"
}
Security Scheme Type API Key
Header parameter name: x-api-key

Accounts

Liste les comptes marchands

Authorizations:
x-api-key
    path Parameters
    partner
    required
    string

    Code partenaire

    query Parameters
    sortBy
    string
    Enum: "accountId" "balance" "birthCity" "birthCountry" "birthDate" "birthName" "email" "extraPhone" "firstName" "internalId" "lastName" "mobilePhone" "nationality" "title"

    Tri

    orderBy
    string
    Enum: "asc" "desc"

    Direction du tri

    pageNumber
    integer <int32> [ 1 .. 2147483647 ]

    Numéro de page

    pageSize
    integer <int32> [ 1 .. 100 ]

    Taille de la page

    header Parameters
    ps-language
    string
    Default: fr

    Langue de retour API

    x-version
    string

    Version de l'API

    ps-ip-address
    required
    string

    Adresse IP du client final

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Crée un nouveau compte marchand

    Authorizations:
    x-api-key
      path Parameters
      partner
      required
      string

      Code partenaire

      header Parameters
      ps-language
      string
      Default: fr

      Langue de retour API

      x-version
      string

      Version de l'API

      ps-ip-address
      required
      string

      Adresse IP du client final

      Request Body schema: application/json

      Corps de méthode

      accountId
      required
      string non-empty ^[0-9a-zA-Z_.@-]*$

      Identifiant de compte marchand

      email
      required
      string <email> non-empty

      Adresse mail d'inscription

      title
      required
      string
      Enum: "M" "F" "U"

      Civilité

      firstName
      required
      string [ 2 .. 256 ] characters ^[\p{L} '-_]*$

      Prénom

      lastName
      required
      string [ 2 .. 256 ] characters ^[\p{L} '-_]*$

      Nom de famille

      birthName
      required
      string [ 2 .. 256 ] characters ^[\p{L} '-_]*$

      Nom de naissance

      mobilePhone
      required
      string <phone> non-empty

      Numéro de téléphone de contact principal

      street
      required
      string [ 2 .. 256 ] characters ^[\p{L}\p{N} ,.'-]*$

      Numéro et rue de l'adresse

      postCode
      string

      Code postal

      city
      required
      string [ 2 .. 140 ] characters ^[\p{L}|\p{N} '-]*$

      Ville

      country
      required
      string
      Enum: "AFG" "ALB" "ATA" "DZA" "ASM" "AND" "AGO" "ATG" "AZE" "ARG" "AUS" "AUT" "BHS" "BHR" "BGD" "ARM" "BRB" "BEL" "BMU" "BTN" "BOL" "BIH" "BWA" "BVT" "BRA" "BLZ" "IOT" "SLB" "VGB" "BRN" "BGR" "MMR" "BDI" "BLR" "KHM" "CMR" "CAN" "CPV" "CYM" "CAF" "LKA" "TCD" "CHL" "CHN" "TWN" "CXR" "CCK" "COL" "COM" "MYT" "COG" "COD" "COK" "CRI" "HRV" "CUB" "CYP" "CZE" "BEN" "DNK" "DMA" "DOM" "ECU" "SLV" "GNQ" "ETH" "ERI" "EST" "FRO" "FLK" "SGS" "FJI" "FIN" "ALA" "FRA" "GUF" "PYF" "ATF" "DJI" "GAB" "GEO" "GMB" "PSE" "DEU" "GHA" "GIB" "KIR" "GRC" "GRL" "GRD" "GLP" "GUM" "GTM" "GIN" "GUY" "HTI" "HMD" "VAT" "HND" "HKG" "HUN" "ISL" "IND" "IDN" "IRN" "IRQ" "IRL" "ISR" "ITA" "CIV" "JAM" "JPN" "KAZ" "JOR" "KEN" "PRK" "KOR" "KWT" "KGZ" "LAO" "LBN" "LSO" "LVA" "LBR" "LBY" "LIE" "LTU" "LUX" "MAC" "MDG" "MWI" "MYS" "MDV" "MLI" "MLT" "MTQ" "MRT" "MUS" "MEX" "MCO" "MNG" "MDA" "MNE" "MSR" "MAR" "MOZ" "OMN" "NAM" "NRU" "NPL" "NLD" "CUW" "ABW" "SXM" "BES" "NCL" "VUT" "NZL" "NIC" "NER" "NGA" "NIU" "NFK" "NOR" "MNP" "UMI" "FSM" "MHL" "PLW" "PAK" "PAN" "PNG" "PRY" "PER" "PHL" "PCN" "POL" "PRT" "GNB" "TLS" "PRI" "QAT" "REU" "ROU" "RUS" "RWA" "BLM" "SHN" "KNA" "AIA" "LCA" "MAF" "SPM" "VCT" "SMR" "STP" "SAU" "SEN" "SRB" "SYC" "SLE" "SGP" "SVK" "VNM" "SVN" "SOM" "ZAF" "ZWE" "ESP" "SSD" "SDN" "ESH" "SUR" "SJM" "SWZ" "SWE" "CHE" "SYR" "TJK" "THA" "TGO" "TKL" "TON" "TTO" "ARE" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "MKD" "EGY" "GBR" "GGY" "JEY" "IMN" "TZA" "USA" "VIR" "BFA" "URY" "UZB" "VEN" "WLF" "WSM" "YEM" "ZMB"

      Pays du marchand au format ISO 3166-1 alpha-3

      nationality
      required
      string non-empty ^[A-Z]{3}(,[A-Z]{3}){0,4}$

      Nationalité au format ISO-3

      birthDate
      required
      string <date-time> non-empty

      Date de naissance du marchand

      companyName
      required
      string [ 2 .. 256 ] characters ^[\p{L}|\p{N} '-]*$

      Raison sociale de l'entreprise

      companyDescription
      required
      string [ 0 .. 256 ] characters

      Description de l'activité

      registrationNumber
      required
      string non-empty

      Numéro d'identification de la personne morale (SIRET)

      legalForm
      required
      string
      Enum: "AUTRE" "AE" "EARL" "EI" "EIRL" "EURL" "GAEC" "GEIE" "GIE" "ME" "SARL" "SA" "SAS" "SASU" "SC" "SCA" "SCI" "SCIC" "SCICV" "SCM" "SCOP" "SCP" "SCS" "SEL" "SELAFA" "SELARL" "SELAS" "SELCA" "SEM" "SEML" "SEP" "SICA" "SMHF" "SNC" "SPFPL" "SUP" "ASSO"

      Forme juridique

      birthCity
      string [ 2 .. 140 ] characters ^[\p{L}|\p{N} '-]*$

      Ville de naissance

      extraPhone
      string <phone>

      Numéro de téléphone de contact secondaire

      companyWebsite
      string

      URL du site web

      birthCountry
      string^[A-Z]{3}$
      Enum: "AFG" "ALB" "ATA" "DZA" "ASM" "AND" "AGO" "ATG" "AZE" "ARG" "AUS" "AUT" "BHS" "BHR" "BGD" "ARM" "BRB" "BEL" "BMU" "BTN" "BOL" "BIH" "BWA" "BVT" "BRA" "BLZ" "IOT" "SLB" "VGB" "BRN" "BGR" "MMR" "BDI" "BLR" "KHM" "CMR" "CAN" "CPV" "CYM" "CAF" "LKA" "TCD" "CHL" "CHN" "TWN" "CXR" "CCK" "COL" "COM" "MYT" "COG" "COD" "COK" "CRI" "HRV" "CUB" "CYP" "CZE" "BEN" "DNK" "DMA" "DOM" "ECU" "SLV" "GNQ" "ETH" "ERI" "EST" "FRO" "FLK" "SGS" "FJI" "FIN" "ALA" "FRA" "GUF" "PYF" "ATF" "DJI" "GAB" "GEO" "GMB" "PSE" "DEU" "GHA" "GIB" "KIR" "GRC" "GRL" "GRD" "GLP" "GUM" "GTM" "GIN" "GUY" "HTI" "HMD" "VAT" "HND" "HKG" "HUN" "ISL" "IND" "IDN" "IRN" "IRQ" "IRL" "ISR" "ITA" "CIV" "JAM" "JPN" "KAZ" "JOR" "KEN" "PRK" "KOR" "KWT" "KGZ" "LAO" "LBN" "LSO" "LVA" "LBR" "LBY" "LIE" "LTU" "LUX" "MAC" "MDG" "MWI" "MYS" "MDV" "MLI" "MLT" "MTQ" "MRT" "MUS" "MEX" "MCO" "MNG" "MDA" "MNE" "MSR" "MAR" "MOZ" "OMN" "NAM" "NRU" "NPL" "NLD" "CUW" "ABW" "SXM" "BES" "NCL" "VUT" "NZL" "NIC" "NER" "NGA" "NIU" "NFK" "NOR" "MNP" "UMI" "FSM" "MHL" "PLW" "PAK" "PAN" "PNG" "PRY" "PER" "PHL" "PCN" "POL" "PRT" "GNB" "TLS" "PRI" "QAT" "REU" "ROU" "RUS" "RWA" "BLM" "SHN" "KNA" "AIA" "LCA" "MAF" "SPM" "VCT" "SMR" "STP" "SAU" "SEN" "SRB" "SYC" "SLE" "SGP" "SVK" "VNM" "SVN" "SOM" "ZAF" "ZWE" "ESP" "SSD" "SDN" "ESH" "SUR" "SJM" "SWZ" "SWE" "CHE" "SYR" "TJK" "THA" "TGO" "TKL" "TON" "TTO" "ARE" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "MKD" "EGY" "GBR" "GGY" "JEY" "IMN" "TZA" "USA" "VIR" "BFA" "URY" "UZB" "VEN" "WLF" "WSM" "YEM" "ZMB"

      Pays de naissance au format ISO-3

      registrationIp
      required
      string non-empty

      Adresse IP

      Responses

      Request samples

      Content type
      application/json
      {
      • "accountId": "string",
      • "email": "user@example.com",
      • "title": "M",
      • "firstName": "string",
      • "lastName": "string",
      • "birthName": "string",
      • "mobilePhone": "string",
      • "street": "string",
      • "postCode": "string",
      • "city": "string",
      • "country": "AFG",
      • "nationality": "string",
      • "birthDate": "2019-08-24T14:15:22Z",
      • "companyName": "string",
      • "companyDescription": "string",
      • "registrationNumber": "string",
      • "legalForm": "AUTRE",
      • "birthCity": "string",
      • "extraPhone": "string",
      • "companyWebsite": "string",
      • "birthCountry": "AFG",
      • "registrationIp": "string"
      }

      Response samples

      Content type
      application/json
      {
      • "accountId": "string",
      • "balance": 0,
      • "fullName": "string",
      • "email": "string",
      • "status": 0,
      • "isBlocked": true,
      • "internalId": 0,
      • "firstName": "string",
      • "lastName": "string",
      • "nationality": "string",
      • "title": "M",
      • "birthName": "string",
      • "birthDate": "2019-08-24T14:15:22Z",
      • "mobilePhone": "string",
      • "extraPhone": "string",
      • "birthCountry": "string",
      • "birthCity": "string",
      • "address": {
        },
      • "company": {
        },
      • "blocked": true,
      • "frozen": true,
      • "thirdPartyReference": "string"
      }

      Affiche un compte marchand

      Authorizations:
      x-api-key
        path Parameters
        partner
        required
        string

        Code partenaire

        accountId
        required
        string

        Identifiant de compte marchand

        header Parameters
        ps-language
        string
        Default: fr

        Langue de retour API

        x-version
        string

        Version de l'API

        ps-ip-address
        required
        string

        Adresse IP du client final

        Responses

        Response samples

        Content type
        application/json
        {
        • "accountId": "string",
        • "balance": 0,
        • "fullName": "string",
        • "email": "string",
        • "status": 0,
        • "isBlocked": true,
        • "internalId": 0,
        • "firstName": "string",
        • "lastName": "string",
        • "nationality": "string",
        • "title": "M",
        • "birthName": "string",
        • "birthDate": "2019-08-24T14:15:22Z",
        • "mobilePhone": "string",
        • "extraPhone": "string",
        • "birthCountry": "string",
        • "birthCity": "string",
        • "address": {
          },
        • "company": {
          },
        • "blocked": true,
        • "frozen": true,
        • "thirdPartyReference": "string"
        }

        Modifie un compte marchand

        Authorizations:
        x-api-key
          path Parameters
          partner
          required
          string

          Code partenaire

          accountId
          required
          string

          Identifiant de compte marchand

          header Parameters
          ps-language
          string
          Default: fr

          Langue de retour API

          x-version
          string

          Version de l'API

          ps-ip-address
          required
          string

          Adresse IP du client final

          Request Body schema: application/json

          Corps de méthode

          email
          string^[a-zA-Z0-9.!#$%&*+\/\\=?^_‘`{|}~-]+@[a-zA-Z0...

          Adresse mail d'inscription

          title
          string
          Enum: "M" "F" "U"

          Civilité

          firstName
          string [ 2 .. 256 ] characters ^[\p{L} '-_]*$

          Prénom

          lastName
          string [ 2 .. 256 ] characters ^[\p{L} '-_]*$

          Nom de famille

          birthName
          string [ 2 .. 256 ] characters ^[\p{L} '-_]*$

          Nom de naissance

          mobilePhone
          string <phone>

          Numéro de téléphone de contact principal

          street
          string [ 2 .. 256 ] characters ^[\p{L}\p{N} ,.'-]*$

          Numéro et rue de l'adresse

          postCode
          string

          Code postal

          city
          string [ 2 .. 140 ] characters ^[\p{L}|\p{N} '-]*$

          Ville

          country
          string
          Enum: "AFG" "ALB" "ATA" "DZA" "ASM" "AND" "AGO" "ATG" "AZE" "ARG" "AUS" "AUT" "BHS" "BHR" "BGD" "ARM" "BRB" "BEL" "BMU" "BTN" "BOL" "BIH" "BWA" "BVT" "BRA" "BLZ" "IOT" "SLB" "VGB" "BRN" "BGR" "MMR" "BDI" "BLR" "KHM" "CMR" "CAN" "CPV" "CYM" "CAF" "LKA" "TCD" "CHL" "CHN" "TWN" "CXR" "CCK" "COL" "COM" "MYT" "COG" "COD" "COK" "CRI" "HRV" "CUB" "CYP" "CZE" "BEN" "DNK" "DMA" "DOM" "ECU" "SLV" "GNQ" "ETH" "ERI" "EST" "FRO" "FLK" "SGS" "FJI" "FIN" "ALA" "FRA" "GUF" "PYF" "ATF" "DJI" "GAB" "GEO" "GMB" "PSE" "DEU" "GHA" "GIB" "KIR" "GRC" "GRL" "GRD" "GLP" "GUM" "GTM" "GIN" "GUY" "HTI" "HMD" "VAT" "HND" "HKG" "HUN" "ISL" "IND" "IDN" "IRN" "IRQ" "IRL" "ISR" "ITA" "CIV" "JAM" "JPN" "KAZ" "JOR" "KEN" "PRK" "KOR" "KWT" "KGZ" "LAO" "LBN" "LSO" "LVA" "LBR" "LBY" "LIE" "LTU" "LUX" "MAC" "MDG" "MWI" "MYS" "MDV" "MLI" "MLT" "MTQ" "MRT" "MUS" "MEX" "MCO" "MNG" "MDA" "MNE" "MSR" "MAR" "MOZ" "OMN" "NAM" "NRU" "NPL" "NLD" "CUW" "ABW" "SXM" "BES" "NCL" "VUT" "NZL" "NIC" "NER" "NGA" "NIU" "NFK" "NOR" "MNP" "UMI" "FSM" "MHL" "PLW" "PAK" "PAN" "PNG" "PRY" "PER" "PHL" "PCN" "POL" "PRT" "GNB" "TLS" "PRI" "QAT" "REU" "ROU" "RUS" "RWA" "BLM" "SHN" "KNA" "AIA" "LCA" "MAF" "SPM" "VCT" "SMR" "STP" "SAU" "SEN" "SRB" "SYC" "SLE" "SGP" "SVK" "VNM" "SVN" "SOM" "ZAF" "ZWE" "ESP" "SSD" "SDN" "ESH" "SUR" "SJM" "SWZ" "SWE" "CHE" "SYR" "TJK" "THA" "TGO" "TKL" "TON" "TTO" "ARE" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "MKD" "EGY" "GBR" "GGY" "JEY" "IMN" "TZA" "USA" "VIR" "BFA" "URY" "UZB" "VEN" "WLF" "WSM" "YEM" "ZMB"

          Pays du marchand au format ISO 3166-1 alpha-3

          nationality
          string^[A-Z]{3}(,[A-Z]{3}){0,4}$

          Nationalité au format ISO-3

          birthDate
          string <date-time>

          Date de naissance du marchand

          companyName
          string [ 2 .. 256 ] characters ^[\p{L}|\p{N} '-]*$

          Raison sociale de l'entreprise

          companyDescription
          string [ 0 .. 256 ] characters

          Description de l'activité

          registrationNumber
          string

          Numéro d'identification de la personne morale (SIRET)

          legalForm
          string
          Enum: "AUTRE" "AE" "EARL" "EI" "EIRL" "EURL" "GAEC" "GEIE" "GIE" "ME" "SARL" "SA" "SAS" "SASU" "SC" "SCA" "SCI" "SCIC" "SCICV" "SCM" "SCOP" "SCP" "SCS" "SEL" "SELAFA" "SELARL" "SELAS" "SELCA" "SEM" "SEML" "SEP" "SICA" "SMHF" "SNC" "SPFPL" "SUP" "ASSO"

          Forme juridique

          birthCity
          string [ 2 .. 140 ] characters ^[\p{L}|\p{N} '-]*$

          Ville de naissance

          extraPhone
          string <phone>

          Numéro de téléphone de contact secondaire

          companyWebsite
          string <uri>

          URL du site web

          birthCountry
          string^[A-Z]{3}$
          Enum: "AFG" "ALB" "ATA" "DZA" "ASM" "AND" "AGO" "ATG" "AZE" "ARG" "AUS" "AUT" "BHS" "BHR" "BGD" "ARM" "BRB" "BEL" "BMU" "BTN" "BOL" "BIH" "BWA" "BVT" "BRA" "BLZ" "IOT" "SLB" "VGB" "BRN" "BGR" "MMR" "BDI" "BLR" "KHM" "CMR" "CAN" "CPV" "CYM" "CAF" "LKA" "TCD" "CHL" "CHN" "TWN" "CXR" "CCK" "COL" "COM" "MYT" "COG" "COD" "COK" "CRI" "HRV" "CUB" "CYP" "CZE" "BEN" "DNK" "DMA" "DOM" "ECU" "SLV" "GNQ" "ETH" "ERI" "EST" "FRO" "FLK" "SGS" "FJI" "FIN" "ALA" "FRA" "GUF" "PYF" "ATF" "DJI" "GAB" "GEO" "GMB" "PSE" "DEU" "GHA" "GIB" "KIR" "GRC" "GRL" "GRD" "GLP" "GUM" "GTM" "GIN" "GUY" "HTI" "HMD" "VAT" "HND" "HKG" "HUN" "ISL" "IND" "IDN" "IRN" "IRQ" "IRL" "ISR" "ITA" "CIV" "JAM" "JPN" "KAZ" "JOR" "KEN" "PRK" "KOR" "KWT" "KGZ" "LAO" "LBN" "LSO" "LVA" "LBR" "LBY" "LIE" "LTU" "LUX" "MAC" "MDG" "MWI" "MYS" "MDV" "MLI" "MLT" "MTQ" "MRT" "MUS" "MEX" "MCO" "MNG" "MDA" "MNE" "MSR" "MAR" "MOZ" "OMN" "NAM" "NRU" "NPL" "NLD" "CUW" "ABW" "SXM" "BES" "NCL" "VUT" "NZL" "NIC" "NER" "NGA" "NIU" "NFK" "NOR" "MNP" "UMI" "FSM" "MHL" "PLW" "PAK" "PAN" "PNG" "PRY" "PER" "PHL" "PCN" "POL" "PRT" "GNB" "TLS" "PRI" "QAT" "REU" "ROU" "RUS" "RWA" "BLM" "SHN" "KNA" "AIA" "LCA" "MAF" "SPM" "VCT" "SMR" "STP" "SAU" "SEN" "SRB" "SYC" "SLE" "SGP" "SVK" "VNM" "SVN" "SOM" "ZAF" "ZWE" "ESP" "SSD" "SDN" "ESH" "SUR" "SJM" "SWZ" "SWE" "CHE" "SYR" "TJK" "THA" "TGO" "TKL" "TON" "TTO" "ARE" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "MKD" "EGY" "GBR" "GGY" "JEY" "IMN" "TZA" "USA" "VIR" "BFA" "URY" "UZB" "VEN" "WLF" "WSM" "YEM" "ZMB"

          Pays de naissance au format ISO-3

          Responses

          Request samples

          Content type
          application/json
          {
          • "email": "string",
          • "title": "M",
          • "firstName": "string",
          • "lastName": "string",
          • "birthName": "string",
          • "mobilePhone": "string",
          • "street": "string",
          • "postCode": "string",
          • "city": "string",
          • "country": "AFG",
          • "nationality": "string",
          • "birthDate": "2019-08-24T14:15:22Z",
          • "companyName": "string",
          • "companyDescription": "string",
          • "registrationNumber": "string",
          • "legalForm": "AUTRE",
          • "birthCity": "string",
          • "extraPhone": "string",
          • "companyWebsite": "http://example.com",
          • "birthCountry": "AFG"
          }

          Response samples

          Content type
          application/json
          {
          • "message": "string",
          • "code": "accountPendingValidation",
          • "errorToken": "string"
          }

          Liste des revues KYC

          Authorizations:
          x-api-key
            path Parameters
            partner
            required
            string

            Code partenaire

            query Parameters
            accountId
            string

            Id ext du compte

            sortBy
            string
            Enum: "accountId" "dateNextReview"

            Tri

            orderBy
            string
            Enum: "asc" "desc"

            Direction du tri

            pageNumber
            integer <int32> [ 1 .. 2147483647 ]

            Numéro de page

            pageSize
            integer <int32> [ 1 .. 100 ]

            Taille de la page

            header Parameters
            ps-language
            string
            Default: fr

            Langue de retour API

            x-version
            string

            Version de l'API

            ps-ip-address
            required
            string

            Adresse IP du client final

            Responses

            Response samples

            Content type
            application/json
            [
            • {
              }
            ]

            Recherche de comptes marchands

            Authorizations:
            x-api-key
              path Parameters
              partner
              required
              string

              Code partenaire

              query Parameters
              accountId
              string

              Identifiant de compte marchand

              status
              integer <int32>

              Statut de compte marchand

              email
              string

              Email rattaché au compte marchand

              sortBy
              string
              Enum: "accountId" "balance" "birthCity" "birthCountry" "birthDate" "birthName" "email" "extraPhone" "firstName" "internalId" "lastName" "mobilePhone" "nationality" "title"

              Tri

              orderBy
              string
              Enum: "asc" "desc"

              Direction du tri

              pageNumber
              integer <int32> [ 1 .. 2147483647 ]

              Numéro de page

              pageSize
              integer <int32> [ 1 .. 100 ]

              Taille de la page

              header Parameters
              ps-language
              string
              Default: fr

              Langue de retour API

              x-version
              string

              Version de l'API

              ps-ip-address
              required
              string

              Adresse IP du client final

              Responses

              Response samples

              Content type
              application/json
              [
              • {
                }
              ]

              Recherche l'historique d'un compte marchand à partir d'une date

              Authorizations:
              x-api-key
                path Parameters
                partner
                required
                string

                Code partenaire

                query Parameters
                updateDate
                required
                string <date-time>

                Date de mise à jour

                pageNumber
                integer <int32> [ 1 .. 2147483647 ]

                Numéro de page

                pageSize
                integer <int32> [ 1 .. 100 ]

                Taille de la page

                header Parameters
                ps-language
                string
                Default: fr

                Langue de retour API

                x-version
                string

                Version de l'API

                ps-ip-address
                required
                string

                Adresse IP du client final

                Responses

                Response samples

                Content type
                application/json
                [
                • {
                  }
                ]

                Recherche les moneysIns associés aux P2P d'un marchand.

                Fonctionnalité requise : PaymentCard, PaymentCardInStore, PaymentTransfer, PaymentDirectDebit, PaymentInitiation

                Authorizations:
                x-api-key
                  path Parameters
                  partner
                  required
                  string

                  Code partenaire

                  accountId
                  required
                  string

                  Identifiant de compte marchand

                  query Parameters
                  startDate
                  required
                  string <date-time>

                  Date de début

                  endDate
                  required
                  string <date-time>

                  Date de fin

                  sortBy
                  string
                  Enum: "id" "date"

                  Tri

                  orderBy
                  string
                  Enum: "asc" "desc"

                  Direction du tri

                  pageNumber
                  integer <int32> [ 1 .. 2147483647 ]

                  Numéro de page

                  pageSize
                  integer <int32> [ 1 .. 100 ]

                  Taille de la page

                  header Parameters
                  ps-language
                  string
                  Default: fr

                  Langue de retour API

                  x-version
                  string

                  Version de l'API

                  ps-ip-address
                  required
                  string

                  Adresse IP du client final

                  Responses

                  Response samples

                  Content type
                  application/json
                  [
                  • {
                    }
                  ]

                  Cards

                  Liste les cartes de paiement

                  Fonctionnalité requise : PaymentCard, PaymentCardInStore

                  Authorizations:
                  x-api-key
                    path Parameters
                    partner
                    required
                    string

                    Code partenaire

                    query Parameters
                    sortBy
                    string
                    Enum: "id" "cardNumber" "expirationDate" "activatedDate" "deactivatedDate"

                    Tri

                    orderBy
                    string
                    Enum: "asc" "desc"

                    Direction du tri

                    pageNumber
                    integer <int32> [ 1 .. 2147483647 ]

                    Numéro de page

                    pageSize
                    integer <int32> [ 1 .. 100 ]

                    Taille de la page

                    header Parameters
                    ps-language
                    string
                    Default: fr

                    Langue de retour API

                    x-version
                    string

                    Version de l'API

                    ps-ip-address
                    required
                    string

                    Adresse IP du client final

                    Responses

                    Response samples

                    Content type
                    application/json
                    [
                    • {
                      }
                    ]

                    Affiche une carte de paiement

                    Fonctionnalité requise : PaymentCard, PaymentCardInStore

                    Authorizations:
                    x-api-key
                      path Parameters
                      partner
                      required
                      string

                      Code partenaire

                      cardId
                      required
                      integer <int64>

                      Identifiant de carte de paiement

                      header Parameters
                      ps-language
                      string
                      Default: fr

                      Langue de retour API

                      x-version
                      string

                      Version de l'API

                      ps-ip-address
                      required
                      string

                      Adresse IP du client final

                      Responses

                      Response samples

                      Content type
                      application/json
                      {
                      • "id": 0,
                      • "status": "pending",
                      • "cardNumber": "string",
                      • "expirationDate": "string",
                      • "activatedDate": "2019-08-24T14:15:22Z",
                      • "deactivatedDate": "2019-08-24T14:15:22Z",
                      • "wallet": "string"
                      }

                      Désactive une carte de paiement

                      Fonctionnalité requise : PaymentCard, PaymentCardInStore

                      Authorizations:
                      x-api-key
                        path Parameters
                        partner
                        required
                        string

                        Code partenaire

                        cardId
                        required
                        integer <int64>

                        Identifiant de carte

                        header Parameters
                        ps-language
                        string
                        Default: fr

                        Langue de retour API

                        x-version
                        string

                        Version de l'API

                        ps-ip-address
                        required
                        string

                        Adresse IP du client final

                        Responses

                        Response samples

                        Content type
                        application/json
                        {
                        • "message": "string",
                        • "code": "cardDeleteFailed",
                        • "errorToken": "string"
                        }

                        Chargebacks

                        Liste les chargebacks

                        Fonctionnalité requise : PaymentCard, PaymentCardInStore

                        Authorizations:
                        x-api-key
                          path Parameters
                          partner
                          required
                          string

                          Code partenaire

                          query Parameters
                          sortBy
                          string
                          Enum: "id" "debit" "recovered" "senderAccountId" "comment" "originId" "originAmount"

                          Tri

                          orderBy
                          string
                          Enum: "asc" "desc"

                          Direction du tri

                          pageNumber
                          integer <int32> [ 1 .. 2147483647 ]

                          Numéro de page

                          pageSize
                          integer <int32> [ 1 .. 100 ]

                          Taille de la page

                          header Parameters
                          ps-language
                          string
                          Default: fr

                          Langue de retour API

                          x-version
                          string

                          Version de l'API

                          ps-ip-address
                          required
                          string

                          Adresse IP du client final

                          Responses

                          Response samples

                          Content type
                          application/json
                          [
                          • {
                            }
                          ]

                          Affiche un chargeback

                          Fonctionnalité requise : PaymentCard, PaymentCardInStore

                          Authorizations:
                          x-api-key
                            path Parameters
                            partner
                            required
                            string

                            Code partenaire

                            chargebackId
                            required
                            integer <int64>

                            Identifiant de chargeback

                            header Parameters
                            ps-language
                            string
                            Default: fr

                            Langue de retour API

                            x-version
                            string

                            Version de l'API

                            ps-ip-address
                            required
                            string

                            Adresse IP du client final

                            Responses

                            Response samples

                            Content type
                            application/json
                            {
                            • "id": 0,
                            • "date": "2019-08-24T14:15:22Z",
                            • "debit": 0,
                            • "credit": 0,
                            • "comment": "string",
                            • "senderAccountId": "string",
                            • "receiverAccountId": "string",
                            • "code": "string",
                            • "message": "string",
                            • "dueDate": "2019-08-24T14:15:22Z",
                            • "originAmount": 0,
                            • "originId": 0,
                            • "isRecoverable": true,
                            • "recovered": 0,
                            • "status": "fullyRecovered",
                            • "typeoperation": "moneyIn",
                            • "typePayment": "card",
                            • "typeEventPayment": "purchase"
                            }

                            Liste les chargebacks liées à un paiement par carte

                            Fonctionnalité requise : PaymentCard, PaymentCardInStore

                            Authorizations:
                            x-api-key
                              path Parameters
                              partner
                              required
                              string

                              Code partenaire

                              transactionId
                              required
                              integer <int64>

                              Identifiant de transaction

                              query Parameters
                              sortBy
                              string
                              Enum: "id" "debit" "recovered" "senderAccountId" "comment" "originId" "originAmount"

                              Tri

                              orderBy
                              string
                              Enum: "asc" "desc"

                              Direction du tri

                              pageNumber
                              integer <int32> [ 1 .. 2147483647 ]

                              Numéro de page

                              pageSize
                              integer <int32> [ 1 .. 100 ]

                              Taille de la page

                              header Parameters
                              ps-language
                              string
                              Default: fr

                              Langue de retour API

                              x-version
                              string

                              Version de l'API

                              ps-ip-address
                              required
                              string

                              Adresse IP du client final

                              Responses

                              Response samples

                              Content type
                              application/json
                              [
                              • {
                                }
                              ]

                              Recouvre un chargeback

                              Fonctionnalité requise : PaymentCard, PaymentCardInStore

                              Authorizations:
                              x-api-key
                                path Parameters
                                partner
                                required
                                string

                                Code partenaire

                                chargebackId
                                required
                                integer <int64>

                                Identifiant de chargeback

                                header Parameters
                                ps-language
                                string
                                Default: fr

                                Langue de retour API

                                x-version
                                string

                                Version de l'API

                                ps-ip-address
                                required
                                string

                                Adresse IP du client final

                                Request Body schema: application/json

                                Corps de méthode

                                accountId
                                required
                                string non-empty

                                Identifiant du compte de paiement

                                p2PId
                                required
                                integer <int64>

                                Identifiant de P2P de la transaction d'origine

                                amount
                                required
                                number <decimal>

                                Montant à recouvrir

                                comment
                                string [ 0 .. 256 ] characters

                                Commentaire de recouvrement

                                Responses

                                Request samples

                                Content type
                                application/json
                                {
                                • "accountId": "string",
                                • "p2PId": 0,
                                • "amount": 0,
                                • "comment": "string"
                                }

                                Response samples

                                Content type
                                application/json
                                {
                                • "id": 0,
                                • "date": "2019-08-24T14:15:22Z",
                                • "debit": 0,
                                • "credit": 0,
                                • "comment": "string",
                                • "senderAccountId": "string",
                                • "receiverAccountId": "string",
                                • "code": "string",
                                • "message": "string",
                                • "dueDate": "2019-08-24T14:15:22Z",
                                • "status": "expired",
                                • "originId": 0,
                                • "p2PType": "unknown",
                                • "date_finalized": "2019-08-24T14:15:22Z",
                                • "p2PParentId": 0
                                }

                                DirectDebitMandates

                                Crée une session de signature e-mandat.

                                Fonctionnalité requise : PaymentDirectDebit

                                Authorizations:
                                x-api-key
                                  path Parameters
                                  partner
                                  required
                                  string

                                  Code partenaire.

                                  header Parameters
                                  ps-language
                                  string
                                  Default: fr

                                  Langue de retour API

                                  x-version
                                  string

                                  Version de l'API

                                  ps-ip-address
                                  required
                                  string

                                  Adresse IP du client final

                                  Request Body schema: application/json

                                  Corps de méthode.

                                  mandateNatureType
                                  required
                                  string
                                  Enum: "core" "b2B"

                                  Nature du mandat.

                                  debtorMobilePhoneNumber
                                  required
                                  string [ 0 .. 20 ] characters ^\+((?:9[679]|8[035789]|6[789]|5[90]|42|3[578...

                                  Numéro de téléphone portable du débiteur au format internationnal.

                                  debtorIban
                                  string [ 15 .. 34 ] characters

                                  IBAN du débiteur.

                                  debtorType
                                  required
                                  string
                                  Enum: "individual" "professional"

                                  Type du débiteur.

                                  debtorName
                                  string [ 0 .. 70 ] characters ^[ a-zA-Z0-9\sáàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀ...

                                  Identité du Débiteur.

                                  debtorAddressLine1
                                  string [ 0 .. 38 ] characters ^[ a-zA-Z0-9\sáàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀ...

                                  Adresse postale du débiteur – Ligne 1.

                                  debtorAddressLine2
                                  string [ 0 .. 38 ] characters ^[ a-zA-Z0-9\sáàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀ...

                                  Adresse postale du débiteur – Ligne 2.

                                  debtorCity
                                  string [ 0 .. 32 ] characters ^[ a-zA-Z0-9\sáàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀ...

                                  Ville/Localité du débiteur.

                                  debtorZipCode
                                  string [ 0 .. 10 ] characters ^[ a-zA-Z0-9\sáàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀ...

                                  Code postal du débiteur.

                                  debtorCountry
                                  required
                                  string
                                  Enum: "AFG" "ALB" "ATA" "DZA" "ASM" "AND" "AGO" "ATG" "AZE" "ARG" "AUS" "AUT" "BHS" "BHR" "BGD" "ARM" "BRB" "BEL" "BMU" "BTN" "BOL" "BIH" "BWA" "BVT" "BRA" "BLZ" "IOT" "SLB" "VGB" "BRN" "BGR" "MMR" "BDI" "BLR" "KHM" "CMR" "CAN" "CPV" "CYM" "CAF" "LKA" "TCD" "CHL" "CHN" "TWN" "CXR" "CCK" "COL" "COM" "MYT" "COG" "COD" "COK" "CRI" "HRV" "CUB" "CYP" "CZE" "BEN" "DNK" "DMA" "DOM" "ECU" "SLV" "GNQ" "ETH" "ERI" "EST" "FRO" "FLK" "SGS" "FJI" "FIN" "ALA" "FRA" "GUF" "PYF" "ATF" "DJI" "GAB" "GEO" "GMB" "PSE" "DEU" "GHA" "GIB" "KIR" "GRC" "GRL" "GRD" "GLP" "GUM" "GTM" "GIN" "GUY" "HTI" "HMD" "VAT" "HND" "HKG" "HUN" "ISL" "IND" "IDN" "IRN" "IRQ" "IRL" "ISR" "ITA" "CIV" "JAM" "JPN" "KAZ" "JOR" "KEN" "PRK" "KOR" "KWT" "KGZ" "LAO" "LBN" "LSO" "LVA" "LBR" "LBY" "LIE" "LTU" "LUX" "MAC" "MDG" "MWI" "MYS" "MDV" "MLI" "MLT" "MTQ" "MRT" "MUS" "MEX" "MCO" "MNG" "MDA" "MNE" "MSR" "MAR" "MOZ" "OMN" "NAM" "NRU" "NPL" "NLD" "CUW" "ABW" "SXM" "BES" "NCL" "VUT" "NZL" "NIC" "NER" "NGA" "NIU" "NFK" "NOR" "MNP" "UMI" "FSM" "MHL" "PLW" "PAK" "PAN" "PNG" "PRY" "PER" "PHL" "PCN" "POL" "PRT" "GNB" "TLS" "PRI" "QAT" "REU" "ROU" "RUS" "RWA" "BLM" "SHN" "KNA" "AIA" "LCA" "MAF" "SPM" "VCT" "SMR" "STP" "SAU" "SEN" "SRB" "SYC" "SLE" "SGP" "SVK" "VNM" "SVN" "SOM" "ZAF" "ZWE" "ESP" "SSD" "SDN" "ESH" "SUR" "SJM" "SWZ" "SWE" "CHE" "SYR" "TJK" "THA" "TGO" "TKL" "TON" "TTO" "ARE" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "MKD" "EGY" "GBR" "GGY" "JEY" "IMN" "TZA" "USA" "VIR" "BFA" "URY" "UZB" "VEN" "WLF" "WSM" "YEM" "ZMB"

                                  Pays du débiteur (uniquement zone SEPA).

                                  debtorContractingName
                                  string [ 0 .. 70 ] characters ^[ a-zA-Z0-9\sáàâäãåçéèêëíìîïñóòôöõúùûüýÿæœÁÀ...

                                  Nom du signataire représentant le débiteur professionnel (si le type du débiteur est "Professional").

                                  returnUrl
                                  required
                                  string <uri> non-empty

                                  URL de retour de succès sur le site du partenaire.

                                  cancelUrl
                                  required
                                  string <uri> non-empty

                                  URL de retour d'annulation sur le site du partenaire.

                                  errorUrl
                                  required
                                  string <uri> non-empty

                                  URL de retour d'erreur sur le site du partenaire.

                                  Responses

                                  Request samples

                                  Content type
                                  application/json
                                  {
                                  • "mandateNatureType": "core",
                                  • "debtorMobilePhoneNumber": "string",
                                  • "debtorIban": "stringstringstr",
                                  • "debtorType": "individual",
                                  • "debtorName": "string",
                                  • "debtorAddressLine1": "string",
                                  • "debtorAddressLine2": "string",
                                  • "debtorCity": "string",
                                  • "debtorZipCode": "string",
                                  • "debtorCountry": "AFG",
                                  • "debtorContractingName": "string",
                                  • "returnUrl": "http://example.com",
                                  • "cancelUrl": "http://example.com",
                                  • "errorUrl": "http://example.com"
                                  }

                                  Response samples

                                  Content type
                                  application/json
                                  {
                                  • "sessionId": "string",
                                  • "creditorId": "string",
                                  • "callerId": "string",
                                  • "rum": "string"
                                  }

                                  Interroge les e-mandats.

                                  Fonctionnalité requise : PaymentDirectDebit

                                  Authorizations:
                                  x-api-key
                                    path Parameters
                                    partner
                                    required
                                    string

                                    Code partenaire.

                                    query Parameters
                                    status
                                    string
                                    Enum: "waiting" "notSigned" "signed" "cancelled" "closed" "error"

                                    Statut du mandat.

                                    startDate
                                    string <date-time>

                                    Date début (date création)

                                    endDate
                                    string <date-time>

                                    Date de fin (date création)

                                    pageNumber
                                    integer <int32> [ 1 .. 2147483647 ]

                                    Numéro de page

                                    pageSize
                                    integer <int32> [ 1 .. 100 ]

                                    Taille de la page

                                    header Parameters
                                    ps-language
                                    string
                                    Default: fr

                                    Langue de retour API

                                    x-version
                                    string

                                    Version de l'API

                                    ps-ip-address
                                    required
                                    string

                                    Adresse IP du client final

                                    Responses

                                    Response samples

                                    Content type
                                    application/json
                                    [
                                    • {
                                      }
                                    ]

                                    Interroge un e-mandat.

                                    Fonctionnalité requise : PaymentDirectDebit

                                    Authorizations:
                                    x-api-key
                                      path Parameters
                                      partner
                                      required
                                      string

                                      Code partenaire.

                                      rum
                                      required
                                      string

                                      Référence Unique du Mandat.

                                      header Parameters
                                      ps-language
                                      string
                                      Default: fr

                                      Langue de retour API

                                      x-version
                                      string

                                      Version de l'API

                                      ps-ip-address
                                      required
                                      string

                                      Adresse IP du client final

                                      Responses

                                      Response samples

                                      Content type
                                      application/json
                                      {
                                      • "id": 0,
                                      • "dateCreate": "2019-08-24T14:15:22Z",
                                      • "dateUpdate": "2019-08-24T14:15:22Z",
                                      • "rum": "string",
                                      • "mandateStatus": "waiting",
                                      • "mandateNature": "core",
                                      • "signSessionId": "string"
                                      }

                                      Interroge les échéanciers associés à un e-mandat.

                                      Fonctionnalité requise : PaymentDirectDebit

                                      Authorizations:
                                      x-api-key
                                        path Parameters
                                        partner
                                        required
                                        string

                                        Code partenaire.

                                        rum
                                        required
                                        string

                                        Référence Unique du Mandat.

                                        query Parameters
                                        startDate
                                        string <date-time>

                                        Date début (date création)

                                        endDate
                                        string <date-time>

                                        Date de fin (date création)

                                        pageNumber
                                        integer <int32> [ 1 .. 2147483647 ]

                                        Numéro de page

                                        pageSize
                                        integer <int32> [ 1 .. 100 ]

                                        Taille de la page

                                        header Parameters
                                        ps-language
                                        string
                                        Default: fr

                                        Langue de retour API

                                        x-version
                                        string

                                        Version de l'API

                                        ps-ip-address
                                        required
                                        string

                                        Adresse IP du client final

                                        Responses

                                        Response samples

                                        Content type
                                        application/json
                                        [
                                        • {
                                          }
                                        ]

                                        Retourne les informations basiques d'un échéancier.

                                        Fonctionnalité requise : PaymentDirectDebit

                                        Authorizations:
                                        x-api-key
                                          path Parameters
                                          partner
                                          required
                                          string

                                          Code partenaire.

                                          rum
                                          required
                                          string

                                          Référence Unique du Mandat.

                                          directDebitId
                                          required
                                          integer <int64>

                                          Identifiant de l'échéancier.

                                          header Parameters
                                          ps-language
                                          string
                                          Default: fr

                                          Langue de retour API

                                          x-version
                                          string

                                          Version de l'API

                                          ps-ip-address
                                          required
                                          string

                                          Adresse IP du client final

                                          Responses

                                          Response samples

                                          Content type
                                          application/json
                                          {
                                          • "id": 0,
                                          • "dateCreate": "2019-08-24T14:15:22Z",
                                          • "dateUpdate": "2019-08-24T14:15:22Z",
                                          • "orderReference": "string",
                                          • "periodicity": "unique",
                                          • "reason1": "string",
                                          • "reason2": "string",
                                          • "reason3": "string",
                                          • "rum": "string",
                                          • "status": "enabled"
                                          }

                                          Retourne les informations détaillées d'un échéancier.

                                          Fonctionnalité requise : PaymentDirectDebit

                                          Authorizations:
                                          x-api-key
                                            path Parameters
                                            partner
                                            required
                                            string

                                            Code partenaire.

                                            rum
                                            required
                                            string

                                            Référence Unique du Mandat.

                                            directDebitId
                                            required
                                            integer <int64>

                                            Identifiant de l'échéancier.

                                            header Parameters
                                            ps-language
                                            string
                                            Default: fr

                                            Langue de retour API

                                            x-version
                                            string

                                            Version de l'API

                                            ps-ip-address
                                            required
                                            string

                                            Adresse IP du client final

                                            Responses

                                            Response samples

                                            Content type
                                            application/json
                                            {
                                            • "id": 0,
                                            • "dateCreate": "2019-08-24T14:15:22Z",
                                            • "dateUpdate": "2019-08-24T14:15:22Z",
                                            • "orderReference": "string",
                                            • "periodicity": "unique",
                                            • "reason1": "string",
                                            • "reason2": "string",
                                            • "reason3": "string",
                                            • "rum": "string",
                                            • "status": "enabled",
                                            • "details": {
                                              }
                                            }

                                            Retourne les informations basiques d'un échéancier avec la liste des échéances planifiées (profondeur maximale de 5 ans).

                                            Fonctionnalité requise : PaymentDirectDebit

                                            Authorizations:
                                            x-api-key
                                              path Parameters
                                              partner
                                              required
                                              string

                                              Code partenaire.

                                              rum
                                              required
                                              string

                                              Référence Unique du Mandat.

                                              directDebitId
                                              required
                                              integer <int64>

                                              Identifiant de l'échéancier.

                                              header Parameters
                                              ps-language
                                              string
                                              Default: fr

                                              Langue de retour API

                                              x-version
                                              string

                                              Version de l'API

                                              ps-ip-address
                                              required
                                              string

                                              Adresse IP du client final

                                              Responses

                                              Response samples

                                              Content type
                                              application/json
                                              {
                                              • "id": 0,
                                              • "dateCreate": "2019-08-24T14:15:22Z",
                                              • "dateUpdate": "2019-08-24T14:15:22Z",
                                              • "orderReference": "string",
                                              • "periodicity": "unique",
                                              • "reason1": "string",
                                              • "reason2": "string",
                                              • "reason3": "string",
                                              • "rum": "string",
                                              • "status": "enabled",
                                              • "plannedDues": [
                                                ]
                                              }

                                              Clôture un e-mandat.

                                              Fonctionnalité requise : PaymentDirectDebit

                                              Authorizations:
                                              x-api-key
                                                path Parameters
                                                partner
                                                required
                                                string

                                                Code partenaire.

                                                rum
                                                required
                                                string

                                                Référence Unique du Mandat.

                                                header Parameters
                                                ps-language
                                                string
                                                Default: fr

                                                Langue de retour API

                                                x-version
                                                string

                                                Version de l'API

                                                ps-ip-address
                                                required
                                                string

                                                Adresse IP du client final

                                                Request Body schema: application/json

                                                Corps de méthode.

                                                reason
                                                string [ 0 .. 70 ] characters ^[ 0-9a-zA-Z,\/-]*$

                                                Motif clôture.

                                                Responses

                                                Request samples

                                                Content type
                                                application/json
                                                {
                                                • "reason": "string"
                                                }

                                                Response samples

                                                Content type
                                                application/json
                                                {
                                                • "message": "string",
                                                • "code": "directDebitMandateInputError",
                                                • "errorToken": "string"
                                                }

                                                Crée une session de visualisation e-mandat.

                                                Fonctionnalité requise : PaymentDirectDebit

                                                Authorizations:
                                                x-api-key
                                                  path Parameters
                                                  partner
                                                  required
                                                  string

                                                  Code partenaire.

                                                  rum
                                                  required
                                                  string

                                                  Référence Unique du Mandat.

                                                  header Parameters
                                                  ps-language
                                                  string
                                                  Default: fr

                                                  Langue de retour API

                                                  x-version
                                                  string

                                                  Version de l'API

                                                  ps-ip-address
                                                  required
                                                  string

                                                  Adresse IP du client final

                                                  Responses

                                                  Response samples

                                                  Content type
                                                  application/json
                                                  {
                                                  • "sessionId": "string",
                                                  • "creditorId": "string",
                                                  • "callerId": "string",
                                                  • "rum": "string"
                                                  }

                                                  Documents

                                                  Liste les documents d'un compte marchand

                                                  Authorizations:
                                                  x-api-key
                                                    path Parameters
                                                    partner
                                                    required
                                                    string

                                                    Code partenaire

                                                    accountId
                                                    required
                                                    string

                                                    Identifiant de compte marchand

                                                    query Parameters
                                                    sortBy
                                                    string
                                                    Enum: "id" "validationDate" "comment"

                                                    Tri

                                                    orderBy
                                                    string
                                                    Enum: "asc" "desc"

                                                    Direction du tri

                                                    pageNumber
                                                    integer <int32> [ 1 .. 2147483647 ]

                                                    Numéro de page

                                                    pageSize
                                                    integer <int32> [ 1 .. 100 ]

                                                    Taille de la page

                                                    header Parameters
                                                    ps-language
                                                    string
                                                    Default: fr

                                                    Langue de retour API

                                                    x-version
                                                    string

                                                    Version de l'API

                                                    ps-ip-address
                                                    required
                                                    string

                                                    Adresse IP du client final

                                                    Responses

                                                    Response samples

                                                    Content type
                                                    application/json
                                                    [
                                                    • {
                                                      }
                                                    ]

                                                    Affiche un document d'un compte marchand

                                                    Authorizations:
                                                    x-api-key
                                                      path Parameters
                                                      partner
                                                      required
                                                      string

                                                      Code partenaire

                                                      accountId
                                                      required
                                                      string

                                                      Identifiant de compte marchand

                                                      documentId
                                                      required
                                                      integer <int64>

                                                      Identifiant de document

                                                      header Parameters
                                                      ps-language
                                                      string
                                                      Default: fr

                                                      Langue de retour API

                                                      x-version
                                                      string

                                                      Version de l'API

                                                      ps-ip-address
                                                      required
                                                      string

                                                      Adresse IP du client final

                                                      Responses

                                                      Response samples

                                                      Content type
                                                      application/json
                                                      {
                                                      • "id": 0,
                                                      • "status": "standBy",
                                                      • "type": "carteIdentiteCe",
                                                      • "validationDate": "2019-08-24T14:15:22Z",
                                                      • "comment": "string"
                                                      }

                                                      Ancienne méthode d'Upload de documents pour les comptes de paiements

                                                      Les fichiers doivent avoir une taille inférieure à 6MB. Pour des raisons de sécurités seules les formats PDF, JPG, JPEG et PNG sont autorisés.

                                                      Authorizations:
                                                      x-api-key
                                                        path Parameters
                                                        partner
                                                        required
                                                        string
                                                        accountId
                                                        required
                                                        string
                                                        header Parameters
                                                        ps-language
                                                        string
                                                        Default: fr

                                                        Langue de retour API

                                                        x-version
                                                        string

                                                        Version de l'API

                                                        ps-ip-address
                                                        required
                                                        string

                                                        Adresse IP du client final

                                                        Request Body schema: application/json
                                                        fileName
                                                        required
                                                        string non-empty ^.+[\.].+$

                                                        Nom du fichier

                                                        documentType
                                                        required
                                                        string
                                                        Enum: "carteIdentiteCe" "justicatifDomicile" "rib" "passeportCe" "passeportNonCe" "carteSejour" "statut" "kbis" "doc1" "doc2" "doc3" "doc4" "doc5" "doc6" "doc7" "doc8" "doc9" "doc10"

                                                        Type du fichier

                                                        buffer
                                                        required
                                                        string <byte> [ 1 .. 6291456 ] characters

                                                        Tableau d'octets représentant le contenu du document

                                                        Responses

                                                        Request samples

                                                        Content type
                                                        application/json
                                                        {
                                                        • "fileName": "string",
                                                        • "documentType": "carteIdentiteCe",
                                                        • "buffer": "string"
                                                        }

                                                        Response samples

                                                        Content type
                                                        application/json
                                                        {
                                                        • "id": 0,
                                                        • "status": "standBy",
                                                        • "type": "carteIdentiteCe",
                                                        • "validationDate": "2019-08-24T14:15:22Z",
                                                        • "comment": "string"
                                                        }

                                                        Nouvelle méthode d'Upload de documents pour les comptes de paiements

                                                        Les fichiers doivent avoir une taille inférieure à 6MB. Pour des raisons de sécurités seules les formats PDF, JPG, JPEG et PNG sont autorisés. L'utilisation de l'encodage fichier multipart/form-data est néssesaire.

                                                        Authorizations:
                                                        x-api-key
                                                          path Parameters
                                                          partner
                                                          required
                                                          string
                                                          accountId
                                                          required
                                                          string
                                                          type
                                                          required
                                                          string
                                                          Enum: "carteIdentiteCe" "justicatifDomicile" "rib" "passeportCe" "passeportNonCe" "carteSejour" "statut" "kbis" "doc1" "doc2" "doc3" "doc4" "doc5" "doc6" "doc7" "doc8" "doc9" "doc10"
                                                          header Parameters
                                                          ps-language
                                                          string
                                                          Default: fr

                                                          Langue de retour API

                                                          x-version
                                                          string

                                                          Version de l'API

                                                          ps-ip-address
                                                          required
                                                          string

                                                          Adresse IP du client final

                                                          Responses

                                                          Response samples

                                                          Content type
                                                          application/json
                                                          {
                                                          • "id": 0,
                                                          • "status": "standBy",
                                                          • "type": "carteIdentiteCe",
                                                          • "validationDate": "2019-08-24T14:15:22Z",
                                                          • "comment": "string"
                                                          }

                                                          Ibans

                                                          Liste les IBAN

                                                          Authorizations:
                                                          x-api-key
                                                            path Parameters
                                                            partner
                                                            required
                                                            string

                                                            Code partenaire

                                                            accountId
                                                            required
                                                            string

                                                            Identifiant de compte marchand

                                                            query Parameters
                                                            sortBy
                                                            string
                                                            Enum: "id" "data" "swift" "holder"

                                                            Tri

                                                            orderBy
                                                            string
                                                            Enum: "asc" "desc"

                                                            Direction du tri

                                                            pageNumber
                                                            integer <int32> [ 1 .. 2147483647 ]

                                                            Numéro de page

                                                            pageSize
                                                            integer <int32> [ 1 .. 100 ]

                                                            Taille de la page

                                                            header Parameters
                                                            ps-language
                                                            string
                                                            Default: fr

                                                            Langue de retour API

                                                            x-version
                                                            string

                                                            Version de l'API

                                                            ps-ip-address
                                                            required
                                                            string

                                                            Adresse IP du client final

                                                            Responses

                                                            Response samples

                                                            Content type
                                                            application/json
                                                            [
                                                            • {
                                                              }
                                                            ]

                                                            Crée un nouvel IBAN

                                                            Authorizations:
                                                            x-api-key
                                                              path Parameters
                                                              partner
                                                              required
                                                              string

                                                              Code partenaire

                                                              accountId
                                                              required
                                                              string

                                                              Identifiant de compte marchand

                                                              header Parameters
                                                              ps-language
                                                              string
                                                              Default: fr

                                                              Langue de retour API

                                                              x-version
                                                              string

                                                              Version de l'API

                                                              ps-ip-address
                                                              required
                                                              string

                                                              Adresse IP du client final

                                                              Request Body schema: application/json

                                                              Corps de méthode

                                                              holder
                                                              required
                                                              string [ 0 .. 256 ] characters

                                                              Titulaire de l'IBAN

                                                              iban
                                                              required
                                                              string [ 15 .. 34 ] characters

                                                              IBAN

                                                              swift
                                                              required
                                                              string non-empty ^([a-zA-Z]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}([a-zA-...

                                                              Code BIC

                                                              dom1
                                                              required
                                                              string [ 0 .. 256 ] characters

                                                              Première ligne de domiciliation

                                                              dom2
                                                              required
                                                              string [ 0 .. 256 ] characters

                                                              Deuxième ligne de domiciliation

                                                              comment
                                                              string

                                                              Raison du changement d'IBAN

                                                              Responses

                                                              Request samples

                                                              Content type
                                                              application/json
                                                              {
                                                              • "holder": "string",
                                                              • "iban": "stringstringstr",
                                                              • "swift": "string",
                                                              • "dom1": "string",
                                                              • "dom2": "string",
                                                              • "comment": "string"
                                                              }

                                                              Response samples

                                                              Content type
                                                              application/json
                                                              {
                                                              • "id": 0,
                                                              • "status": "toCheck",
                                                              • "data": "string",
                                                              • "swift": "string",
                                                              • "holder": "string"
                                                              }

                                                              Affiche un IBAN

                                                              Authorizations:
                                                              x-api-key
                                                                path Parameters
                                                                partner
                                                                required
                                                                string

                                                                Code partenaire

                                                                accountId
                                                                required
                                                                string

                                                                Identifiant de compte marchand

                                                                ibanId
                                                                required
                                                                integer <int64>

                                                                Identifiant d'IBAN

                                                                header Parameters
                                                                ps-language
                                                                string
                                                                Default: fr

                                                                Langue de retour API

                                                                x-version
                                                                string

                                                                Version de l'API

                                                                ps-ip-address
                                                                required
                                                                string

                                                                Adresse IP du client final

                                                                Responses

                                                                Response samples

                                                                Content type
                                                                application/json
                                                                {
                                                                • "id": 0,
                                                                • "status": "toCheck",
                                                                • "data": "string",
                                                                • "swift": "string",
                                                                • "holder": "string"
                                                                }

                                                                IsAlive

                                                                Terminaison de test de vie mis à disposition des partenaires

                                                                Authorizations:
                                                                x-api-key
                                                                  path Parameters
                                                                  partner
                                                                  required
                                                                  string
                                                                  header Parameters
                                                                  ps-language
                                                                  string
                                                                  Default: fr

                                                                  Langue de retour API

                                                                  x-version
                                                                  string

                                                                  Version de l'API

                                                                  ps-ip-address
                                                                  required
                                                                  string

                                                                  Adresse IP du client final

                                                                  Responses

                                                                  MoneyIns

                                                                  Liste les transactions entrantes

                                                                  Fonctionnalité requise : PaymentCard, PaymentCardInStore, PaymentTransfer, PaymentDirectDebit, PaymentInitiation

                                                                  Authorizations:
                                                                  x-api-key
                                                                    path Parameters
                                                                    partner
                                                                    required
                                                                    string

                                                                    Code partenaire

                                                                    query Parameters
                                                                    sortBy
                                                                    string
                                                                    Enum: "id" "credit" "receiverAccountId" "comment" "link"

                                                                    Tri

                                                                    orderBy
                                                                    string
                                                                    Enum: "asc" "desc"

                                                                    Direction du tri

                                                                    pageNumber
                                                                    integer <int32> [ 1 .. 2147483647 ]

                                                                    Numéro de page

                                                                    pageSize
                                                                    integer <int32> [ 1 .. 100 ]

                                                                    Taille de la page

                                                                    header Parameters
                                                                    ps-language
                                                                    string
                                                                    Default: fr

                                                                    Langue de retour API

                                                                    x-version
                                                                    string

                                                                    Version de l'API

                                                                    ps-ip-address
                                                                    required
                                                                    string

                                                                    Adresse IP du client final

                                                                    Responses

                                                                    Response samples

                                                                    Content type
                                                                    application/json
                                                                    [
                                                                    • {
                                                                      }
                                                                    ]

                                                                    Affiche une transaction entrante

                                                                    Fonctionnalité requise : PaymentCard, PaymentCardInStore, PaymentTransfer, PaymentDirectDebit, PaymentInitiation

                                                                    Authorizations:
                                                                    x-api-key
                                                                      path Parameters
                                                                      partner
                                                                      required
                                                                      string

                                                                      Code partenaire

                                                                      transactionId
                                                                      required
                                                                      integer <int64>

                                                                      Identifiant de transaction entrante

                                                                      header Parameters
                                                                      ps-language
                                                                      string
                                                                      Default: fr

                                                                      Langue de retour API

                                                                      x-version
                                                                      string

                                                                      Version de l'API

                                                                      ps-ip-address
                                                                      required
                                                                      string

                                                                      Adresse IP du client final

                                                                      Responses

                                                                      Response samples

                                                                      Content type
                                                                      application/json
                                                                      {
                                                                      • "id": 0,
                                                                      • "date": "2019-08-24T14:15:22Z",
                                                                      • "debit": 0,
                                                                      • "credit": 0,
                                                                      • "comment": "string",
                                                                      • "senderAccountId": "string",
                                                                      • "receiverAccountId": "string",
                                                                      • "code": "string",
                                                                      • "message": "string",
                                                                      • "dueDate": "2019-08-24T14:15:22Z",
                                                                      • "status": "complete",
                                                                      • "card": {
                                                                        },
                                                                      • "errorMessage": "string",
                                                                      • "type": "moneyIn",
                                                                      • "method": "card",
                                                                      • "iban": {
                                                                        },
                                                                      • "pspToken": "string",
                                                                      • "transferReference": "string",
                                                                      • "link": 0,
                                                                      • "p2pIds": [
                                                                        ],
                                                                      • "archivingKey": "string",
                                                                      • "eventPaymentType": "purchase",
                                                                      • "authorizationCode": "string",
                                                                      • "clientFirstName": "string",
                                                                      • "clientLastName": "string",
                                                                      • "companyName": "string",
                                                                      • "date_finalized": "2019-08-24T14:15:22Z",
                                                                      • "creditorIBAN": "string",
                                                                      • "directDebit": {
                                                                        },
                                                                      • "paymentInitiation": {},
                                                                      • "hostedFieldsStatus": "started",
                                                                      • "hostedFieldsToken": "string",
                                                                      • "hostedFieldsTpe": "string",
                                                                      • "hostedFieldsLink": {
                                                                        },
                                                                      • "orderReference": "string"
                                                                      }

                                                                      Liste les transactions entrantes par carte

                                                                      Fonctionnalité requise : PaymentCard, PaymentCardInStore

                                                                      Authorizations:
                                                                      x-api-key
                                                                        path Parameters
                                                                        partner
                                                                        required
                                                                        string

                                                                        Code partenaire

                                                                        query Parameters
                                                                        sortBy
                                                                        string
                                                                        Enum: "id" "credit" "receiverAccountId" "comment" "link"

                                                                        Tri

                                                                        orderBy
                                                                        string
                                                                        Enum: "asc" "desc"

                                                                        Direction du tri

                                                                        pageNumber
                                                                        integer <int32> [ 1 .. 2147483647 ]

                                                                        Numéro de page

                                                                        pageSize
                                                                        integer <int32> [ 1 .. 100 ]

                                                                        Taille de la page

                                                                        header Parameters
                                                                        ps-language
                                                                        string
                                                                        Default: fr

                                                                        Langue de retour API

                                                                        x-version
                                                                        string

                                                                        Version de l'API

                                                                        ps-ip-address
                                                                        required
                                                                        string

                                                                        Adresse IP du client final

                                                                        Responses

                                                                        Response samples

                                                                        Content type
                                                                        application/json
                                                                        [
                                                                        • {
                                                                          }
                                                                        ]

                                                                        Liste les transactions entrantes par virement

                                                                        Fonctionnalité requise : PaymentTransfer

                                                                        Authorizations:
                                                                        x-api-key
                                                                          path Parameters
                                                                          partner
                                                                          required
                                                                          string

                                                                          Code partenaire

                                                                          query Parameters
                                                                          sortBy
                                                                          string
                                                                          Enum: "id" "credit" "receiverAccountId" "comment" "link"

                                                                          Tri

                                                                          orderBy
                                                                          string
                                                                          Enum: "asc" "desc"

                                                                          Direction du tri

                                                                          pageNumber
                                                                          integer <int32> [ 1 .. 2147483647 ]

                                                                          Numéro de page

                                                                          pageSize
                                                                          integer <int32> [ 1 .. 100 ]

                                                                          Taille de la page

                                                                          header Parameters
                                                                          ps-language
                                                                          string
                                                                          Default: fr

                                                                          Langue de retour API

                                                                          x-version
                                                                          string

                                                                          Version de l'API

                                                                          ps-ip-address
                                                                          required
                                                                          string

                                                                          Adresse IP du client final

                                                                          Responses

                                                                          Response samples

                                                                          Content type
                                                                          application/json
                                                                          [
                                                                          • {
                                                                            }
                                                                          ]

                                                                          Liste les transactions entrantes par prélèvement

                                                                          Fonctionnalité requise : PaymentDirectDebit

                                                                          Authorizations:
                                                                          x-api-key
                                                                            path Parameters
                                                                            partner
                                                                            required
                                                                            string

                                                                            Code partenaire

                                                                            query Parameters
                                                                            sortBy
                                                                            string
                                                                            Enum: "id" "credit" "receiverAccountId" "comment" "link"

                                                                            Tri

                                                                            orderBy
                                                                            string
                                                                            Enum: "asc" "desc"

                                                                            Direction du tri

                                                                            pageNumber
                                                                            integer <int32> [ 1 .. 2147483647 ]

                                                                            Numéro de page

                                                                            pageSize
                                                                            integer <int32> [ 1 .. 100 ]

                                                                            Taille de la page

                                                                            header Parameters
                                                                            ps-language
                                                                            string
                                                                            Default: fr

                                                                            Langue de retour API

                                                                            x-version
                                                                            string

                                                                            Version de l'API

                                                                            ps-ip-address
                                                                            required
                                                                            string

                                                                            Adresse IP du client final

                                                                            Responses

                                                                            Response samples

                                                                            Content type
                                                                            application/json
                                                                            [
                                                                            • {
                                                                              }
                                                                            ]

                                                                            Liste les transactions entrantes d'un compte marchand

                                                                            Authorizations:
                                                                            x-api-key
                                                                              path Parameters
                                                                              partner
                                                                              required
                                                                              string

                                                                              Code partenaire

                                                                              accountId
                                                                              required
                                                                              string

                                                                              Identifiant de compte marchand

                                                                              query Parameters
                                                                              sortBy
                                                                              string
                                                                              Enum: "id" "credit" "receiverAccountId" "comment" "link"

                                                                              Tri

                                                                              orderBy
                                                                              string
                                                                              Enum: "asc" "desc"

                                                                              Direction du tri

                                                                              pageNumber
                                                                              integer <int32> [ 1 .. 2147483647 ]

                                                                              Numéro de page

                                                                              pageSize
                                                                              integer <int32> [ 1 .. 100 ]

                                                                              Taille de la page

                                                                              header Parameters
                                                                              ps-language
                                                                              string
                                                                              Default: fr

                                                                              Langue de retour API

                                                                              x-version
                                                                              string

                                                                              Version de l'API

                                                                              ps-ip-address
                                                                              required
                                                                              string

                                                                              Adresse IP du client final

                                                                              Responses

                                                                              Response samples

                                                                              Content type
                                                                              application/json
                                                                              [
                                                                              • {
                                                                                }
                                                                              ]

                                                                              Recherche de transactions entrantes par carte

                                                                              Fonctionnalité requise : PaymentCard, PaymentCardInStore

                                                                              Authorizations:
                                                                              x-api-key
                                                                                path Parameters
                                                                                partner
                                                                                required
                                                                                string

                                                                                Code partenaire

                                                                                query Parameters
                                                                                orderReference
                                                                                string

                                                                                Référence partenaire de l'achat par carte

                                                                                comment
                                                                                string

                                                                                Commentaire

                                                                                startDate
                                                                                string <date-time>

                                                                                Date de début

                                                                                endDate
                                                                                string <date-time>

                                                                                Date de fin

                                                                                sortBy
                                                                                string
                                                                                Enum: "id" "credit" "receiverAccountId" "comment" "link"

                                                                                Tri

                                                                                orderBy
                                                                                string
                                                                                Enum: "asc" "desc"

                                                                                Direction du tri

                                                                                pageNumber
                                                                                integer <int32> [ 1 .. 2147483647 ]

                                                                                Numéro de page

                                                                                pageSize
                                                                                integer <int32> [ 1 .. 100 ]

                                                                                Taille de la page

                                                                                header Parameters
                                                                                ps-language
                                                                                string
                                                                                Default: fr

                                                                                Langue de retour API

                                                                                x-version
                                                                                string

                                                                                Version de l'API

                                                                                ps-ip-address
                                                                                required
                                                                                string

                                                                                Adresse IP du client final

                                                                                Responses

                                                                                Response samples

                                                                                Content type
                                                                                application/json
                                                                                [
                                                                                • {
                                                                                  }
                                                                                ]

                                                                                Recherche de transactions entrantes par virement

                                                                                Fonctionnalité requise : PaymentTransfer, PaymentInitiation

                                                                                Authorizations:
                                                                                x-api-key
                                                                                  path Parameters
                                                                                  partner
                                                                                  required
                                                                                  string

                                                                                  Code partenaire

                                                                                  query Parameters
                                                                                  comment
                                                                                  string

                                                                                  Commentaire

                                                                                  startDate
                                                                                  string <date-time>

                                                                                  Date de début

                                                                                  endDate
                                                                                  string <date-time>

                                                                                  Date de fin

                                                                                  sortBy
                                                                                  string
                                                                                  Enum: "id" "credit" "receiverAccountId" "comment" "link"

                                                                                  Tri

                                                                                  orderBy
                                                                                  string
                                                                                  Enum: "asc" "desc"

                                                                                  Direction du tri

                                                                                  pageNumber
                                                                                  integer <int32> [ 1 .. 2147483647 ]

                                                                                  Numéro de page

                                                                                  pageSize
                                                                                  integer <int32> [ 1 .. 100 ]

                                                                                  Taille de la page

                                                                                  header Parameters
                                                                                  ps-language
                                                                                  string
                                                                                  Default: fr

                                                                                  Langue de retour API

                                                                                  x-version
                                                                                  string

                                                                                  Version de l'API

                                                                                  ps-ip-address
                                                                                  required
                                                                                  string

                                                                                  Adresse IP du client final

                                                                                  Responses

                                                                                  Response samples

                                                                                  Content type
                                                                                  application/json
                                                                                  [
                                                                                  • {
                                                                                    }
                                                                                  ]

                                                                                  Recherche de transactions entrantes par prélèvement

                                                                                  Fonctionnalité requise : PaymentDirectDebit

                                                                                  Authorizations:
                                                                                  x-api-key
                                                                                    path Parameters
                                                                                    partner
                                                                                    required
                                                                                    string

                                                                                    Code partenaire

                                                                                    rum
                                                                                    required
                                                                                    string

                                                                                    Référence unique du Mandat.

                                                                                    query Parameters
                                                                                    comment
                                                                                    string

                                                                                    Commentaire

                                                                                    startDate
                                                                                    string <date-time>

                                                                                    Date de début

                                                                                    endDate
                                                                                    string <date-time>

                                                                                    Date de fin

                                                                                    directDebitId
                                                                                    integer <int64>

                                                                                    Identifiant de l'échéancier

                                                                                    sortBy
                                                                                    string
                                                                                    Enum: "id" "credit" "receiverAccountId" "comment" "link"

                                                                                    Tri

                                                                                    orderBy
                                                                                    string
                                                                                    Enum: "asc" "desc"

                                                                                    Direction du tri

                                                                                    pageNumber
                                                                                    integer <int32> [ 1 .. 2147483647 ]

                                                                                    Numéro de page

                                                                                    pageSize
                                                                                    integer <int32> [ 1 .. 100 ]

                                                                                    Taille de la page

                                                                                    header Parameters
                                                                                    ps-language
                                                                                    string
                                                                                    Default: fr

                                                                                    Langue de retour API

                                                                                    x-version
                                                                                    string

                                                                                    Version de l'API

                                                                                    ps-ip-address
                                                                                    required
                                                                                    string

                                                                                    Adresse IP du client final

                                                                                    Responses

                                                                                    Response samples

                                                                                    Content type
                                                                                    application/json
                                                                                    [
                                                                                    • {
                                                                                      }
                                                                                    ]

                                                                                    Liste les informations supplémentaires de la transaction entrante par carte

                                                                                    Fonctionnalité requise : PaymentCard, PaymentCardInStore

                                                                                    Authorizations:
                                                                                    x-api-key
                                                                                      path Parameters
                                                                                      partner
                                                                                      required
                                                                                      string

                                                                                      Code partenaire

                                                                                      transactionId
                                                                                      required
                                                                                      integer <int64>

                                                                                      Identifiant de la transaction entrante

                                                                                      header Parameters
                                                                                      ps-language
                                                                                      string
                                                                                      Default: fr

                                                                                      Langue de retour API

                                                                                      x-version
                                                                                      string

                                                                                      Version de l'API

                                                                                      ps-ip-address
                                                                                      required
                                                                                      string

                                                                                      Adresse IP du client final

                                                                                      Responses

                                                                                      Response samples

                                                                                      Content type
                                                                                      application/json
                                                                                      [
                                                                                      • {
                                                                                        }
                                                                                      ]

                                                                                      Crée un paiement par carte

                                                                                      Fonctionnalité requise : PaymentCard

                                                                                      Authorizations:
                                                                                      x-api-key
                                                                                        path Parameters
                                                                                        partner
                                                                                        required
                                                                                        string

                                                                                        Code partenaire

                                                                                        header Parameters
                                                                                        ps-language
                                                                                        string
                                                                                        Default: fr

                                                                                        Langue de retour API

                                                                                        x-version
                                                                                        string

                                                                                        Version de l'API

                                                                                        ps-ip-address
                                                                                        required
                                                                                        string

                                                                                        Adresse IP du client final

                                                                                        Request Body schema: application/json

                                                                                        Corps de méthode

                                                                                        required
                                                                                        object

                                                                                        Panier

                                                                                        orderReference
                                                                                        required
                                                                                        string [ 0 .. 50 ] characters ^[a-zA-Z0-9-_]*$

                                                                                        Référence unique du money-in

                                                                                        returnUrl
                                                                                        required
                                                                                        string <uri> non-empty

                                                                                        URL de retour de succès sur le site du partenaire

                                                                                        cancelUrl
                                                                                        required
                                                                                        string <uri> non-empty

                                                                                        URL de retour d'annulation sur le site du partenaire

                                                                                        errorUrl
                                                                                        required
                                                                                        string <uri> non-empty

                                                                                        URL de retour d'erreur sur le site du partenaire

                                                                                        required
                                                                                        object

                                                                                        Adresse de facturation

                                                                                        email
                                                                                        required
                                                                                        string <email> non-empty

                                                                                        Adresse client

                                                                                        registerCard
                                                                                        required
                                                                                        boolean

                                                                                        Enregistrement de la carte pour des paiements futurs

                                                                                        object

                                                                                        Paiement différé

                                                                                        isIFrame
                                                                                        required
                                                                                        boolean

                                                                                        Active l'appel au PSP dans une iFrame

                                                                                        comment
                                                                                        string [ 0 .. 256 ] characters

                                                                                        Commentaire concernant le money-in

                                                                                        bankingLabel
                                                                                        string [ 0 .. 16 ] characters ^[A-Za-z0-9]{0,16}$

                                                                                        Libellé Monétique

                                                                                        bankingLabelLocality
                                                                                        string [ 0 .. 32 ] characters ^([-A-Za-z0-9]+\\[-A-Z a-z0-9]*\\[A-Za-z]{3})...

                                                                                        Libellé monétique localité

                                                                                        isHostedFields
                                                                                        required
                                                                                        boolean

                                                                                        Indique une initialisation de paiement en mode Hosted Fields

                                                                                        challenge3DSecureMode
                                                                                        required
                                                                                        string
                                                                                        Enum: "noChoice" "challengePreferred" "challengeMandated" "noChallengeRequested"

                                                                                        Type du challenge 3DSecure (valeur par défaut = noChoice).

                                                                                        object

                                                                                        Informations client.

                                                                                        object

                                                                                        Adresse d'expédition.

                                                                                        Array of objects (CardInformationChallenge3DSecureCartItem) [ items ]

                                                                                        Panier du client.

                                                                                        Responses

                                                                                        Request samples

                                                                                        Content type
                                                                                        application/json
                                                                                        {
                                                                                        • "split": {
                                                                                          },
                                                                                        • "orderReference": "string",
                                                                                        • "returnUrl": "http://example.com",
                                                                                        • "cancelUrl": "http://example.com",
                                                                                        • "errorUrl": "http://example.com",
                                                                                        • "billingAddress": {
                                                                                          },
                                                                                        • "email": "user@example.com",
                                                                                        • "registerCard": true,
                                                                                        • "differedPayment": {
                                                                                          },
                                                                                        • "isIFrame": true,
                                                                                        • "comment": "string",
                                                                                        • "bankingLabel": "string",
                                                                                        • "bankingLabelLocality": "string",
                                                                                        • "isHostedFields": true,
                                                                                        • "challenge3DSecureMode": "noChoice",
                                                                                        • "client": {
                                                                                          },
                                                                                        • "shippingAddress": {
                                                                                          },
                                                                                        • "carts": [
                                                                                          ]
                                                                                        }

                                                                                        Response samples

                                                                                        Content type
                                                                                        application/json
                                                                                        {
                                                                                        • "id": 0,
                                                                                        • "date": "2019-08-24T14:15:22Z",
                                                                                        • "debit": 0,
                                                                                        • "credit": 0,
                                                                                        • "comment": "string",
                                                                                        • "senderAccountId": "string",
                                                                                        • "receiverAccountId": "string",
                                                                                        • "code": "string",
                                                                                        • "message": "string",
                                                                                        • "dueDate": "2019-08-24T14:15:22Z",
                                                                                        • "status": "complete",
                                                                                        • "card": {
                                                                                          },
                                                                                        • "errorMessage": "string",
                                                                                        • "type": "moneyIn",
                                                                                        • "method": "card",
                                                                                        • "iban": {
                                                                                          },
                                                                                        • "pspToken": "string",
                                                                                        • "transferReference": "string",
                                                                                        • "link": 0,
                                                                                        • "p2pIds": [
                                                                                          ],
                                                                                        • "archivingKey": "string",
                                                                                        • "eventPaymentType": "purchase",
                                                                                        • "authorizationCode": "string",
                                                                                        • "clientFirstName": "string",
                                                                                        • "clientLastName": "string",
                                                                                        • "companyName": "string",
                                                                                        • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                        • "creditorIBAN": "string",
                                                                                        • "directDebit": {
                                                                                          },
                                                                                        • "paymentInitiation": {},
                                                                                        • "hostedFieldsStatus": "started",
                                                                                        • "hostedFieldsToken": "string",
                                                                                        • "hostedFieldsTpe": "string",
                                                                                        • "hostedFieldsLink": {
                                                                                          },
                                                                                        • "orderReference": "string"
                                                                                        }

                                                                                        Crée un paiement par virement

                                                                                        Fonctionnalité requise : PaymentTransfer

                                                                                        Authorizations:
                                                                                        x-api-key
                                                                                          path Parameters
                                                                                          partner
                                                                                          required
                                                                                          string

                                                                                          Code partenaire

                                                                                          header Parameters
                                                                                          ps-language
                                                                                          string
                                                                                          Default: fr

                                                                                          Langue de retour API

                                                                                          x-version
                                                                                          string

                                                                                          Version de l'API

                                                                                          ps-ip-address
                                                                                          required
                                                                                          string

                                                                                          Adresse IP du client final

                                                                                          Request Body schema: application/json

                                                                                          Corps de méthode

                                                                                          required
                                                                                          object

                                                                                          Panier

                                                                                          clientFirstName
                                                                                          string^[\p{L} '-_]*$

                                                                                          Prénom de l'émetteur du virement

                                                                                          clientLastName
                                                                                          string^[\p{L} '-_]*$

                                                                                          Nom de l'émetteur du virement

                                                                                          companyName
                                                                                          string^[\p{L}|\p{N} '-]*$

                                                                                          Raison sociale du donneur d’ordre

                                                                                          comment
                                                                                          string [ 0 .. 256 ] characters

                                                                                          Libellé du virement

                                                                                          Responses

                                                                                          Request samples

                                                                                          Content type
                                                                                          application/json
                                                                                          {
                                                                                          • "split": {
                                                                                            },
                                                                                          • "clientFirstName": "string",
                                                                                          • "clientLastName": "string",
                                                                                          • "companyName": "string",
                                                                                          • "comment": "string"
                                                                                          }

                                                                                          Response samples

                                                                                          Content type
                                                                                          application/json
                                                                                          {
                                                                                          • "id": 0,
                                                                                          • "date": "2019-08-24T14:15:22Z",
                                                                                          • "debit": 0,
                                                                                          • "credit": 0,
                                                                                          • "comment": "string",
                                                                                          • "senderAccountId": "string",
                                                                                          • "receiverAccountId": "string",
                                                                                          • "code": "string",
                                                                                          • "message": "string",
                                                                                          • "dueDate": "2019-08-24T14:15:22Z",
                                                                                          • "status": "complete",
                                                                                          • "card": {
                                                                                            },
                                                                                          • "errorMessage": "string",
                                                                                          • "type": "moneyIn",
                                                                                          • "method": "card",
                                                                                          • "iban": {
                                                                                            },
                                                                                          • "pspToken": "string",
                                                                                          • "transferReference": "string",
                                                                                          • "link": 0,
                                                                                          • "p2pIds": [
                                                                                            ],
                                                                                          • "archivingKey": "string",
                                                                                          • "eventPaymentType": "purchase",
                                                                                          • "authorizationCode": "string",
                                                                                          • "clientFirstName": "string",
                                                                                          • "clientLastName": "string",
                                                                                          • "companyName": "string",
                                                                                          • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                          • "creditorIBAN": "string",
                                                                                          • "directDebit": {
                                                                                            },
                                                                                          • "paymentInitiation": {},
                                                                                          • "hostedFieldsStatus": "started",
                                                                                          • "hostedFieldsToken": "string",
                                                                                          • "hostedFieldsTpe": "string",
                                                                                          • "hostedFieldsLink": {
                                                                                            },
                                                                                          • "orderReference": "string"
                                                                                          }

                                                                                          Crée un paiement par carte préalablement enregistrée déclenché par le marchand en l’absence du payeur

                                                                                          Fonctionnalité requise : PaymentCard

                                                                                          Authorizations:
                                                                                          x-api-key
                                                                                            path Parameters
                                                                                            partner
                                                                                            required
                                                                                            string

                                                                                            Code partenaire

                                                                                            cardId
                                                                                            required
                                                                                            integer <int64>

                                                                                            Identifiant de carte de paiement

                                                                                            header Parameters
                                                                                            ps-language
                                                                                            string
                                                                                            Default: fr

                                                                                            Langue de retour API

                                                                                            x-version
                                                                                            string

                                                                                            Version de l'API

                                                                                            ps-ip-address
                                                                                            required
                                                                                            string

                                                                                            Adresse IP du client final

                                                                                            Request Body schema: application/json

                                                                                            Corps de méthode

                                                                                            required
                                                                                            object

                                                                                            Panier

                                                                                            comment
                                                                                            string [ 0 .. 256 ] characters

                                                                                            Commentaire du paiement

                                                                                            required
                                                                                            object

                                                                                            Adresse de facturation

                                                                                            email
                                                                                            required
                                                                                            string <email> non-empty

                                                                                            Adresse client

                                                                                            bankingLabel
                                                                                            string [ 0 .. 16 ] characters ^[A-Za-z0-9]{0,16}$

                                                                                            Libellé Monétique

                                                                                            bankingLabelLocality
                                                                                            string [ 0 .. 32 ] characters ^([-A-Za-z0-9]+\\[-A-Z a-z0-9]*\\[A-Za-z]{3})...

                                                                                            Libellé monétique localité

                                                                                            challenge3DSecureMode
                                                                                            required
                                                                                            string
                                                                                            Enum: "noChoice" "challengePreferred" "challengeMandated" "noChallengeRequested"

                                                                                            Type du challenge 3DSecure (valeur par défaut = noChoice).

                                                                                            object

                                                                                            Informations client.

                                                                                            object

                                                                                            Adresse d'expédition.

                                                                                            Array of objects (CardInformationChallenge3DSecureCartItem) [ items ]

                                                                                            Panier du client.

                                                                                            Responses

                                                                                            Request samples

                                                                                            Content type
                                                                                            application/json
                                                                                            {
                                                                                            • "split": {
                                                                                              },
                                                                                            • "comment": "string",
                                                                                            • "billingAddress": {
                                                                                              },
                                                                                            • "email": "user@example.com",
                                                                                            • "bankingLabel": "string",
                                                                                            • "bankingLabelLocality": "string",
                                                                                            • "challenge3DSecureMode": "noChoice",
                                                                                            • "client": {
                                                                                              },
                                                                                            • "shippingAddress": {
                                                                                              },
                                                                                            • "carts": [
                                                                                              ]
                                                                                            }

                                                                                            Response samples

                                                                                            Content type
                                                                                            application/json
                                                                                            {
                                                                                            • "id": 0,
                                                                                            • "date": "2019-08-24T14:15:22Z",
                                                                                            • "debit": 0,
                                                                                            • "credit": 0,
                                                                                            • "comment": "string",
                                                                                            • "senderAccountId": "string",
                                                                                            • "receiverAccountId": "string",
                                                                                            • "code": "string",
                                                                                            • "message": "string",
                                                                                            • "dueDate": "2019-08-24T14:15:22Z",
                                                                                            • "status": "complete",
                                                                                            • "card": {
                                                                                              },
                                                                                            • "errorMessage": "string",
                                                                                            • "type": "moneyIn",
                                                                                            • "method": "card",
                                                                                            • "iban": {
                                                                                              },
                                                                                            • "pspToken": "string",
                                                                                            • "transferReference": "string",
                                                                                            • "link": 0,
                                                                                            • "p2pIds": [
                                                                                              ],
                                                                                            • "archivingKey": "string",
                                                                                            • "eventPaymentType": "purchase",
                                                                                            • "authorizationCode": "string",
                                                                                            • "clientFirstName": "string",
                                                                                            • "clientLastName": "string",
                                                                                            • "companyName": "string",
                                                                                            • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                            • "creditorIBAN": "string",
                                                                                            • "directDebit": {
                                                                                              },
                                                                                            • "paymentInitiation": {},
                                                                                            • "hostedFieldsStatus": "started",
                                                                                            • "hostedFieldsToken": "string",
                                                                                            • "hostedFieldsTpe": "string",
                                                                                            • "hostedFieldsLink": {
                                                                                              },
                                                                                            • "orderReference": "string"
                                                                                            }

                                                                                            Crée un paiement par carte préalablement enregistrée déclenché par le payeur

                                                                                            Fonctionnalité requise : PaymentCard

                                                                                            Authorizations:
                                                                                            x-api-key
                                                                                              path Parameters
                                                                                              partner
                                                                                              required
                                                                                              string

                                                                                              Code partenaire

                                                                                              cardId
                                                                                              required
                                                                                              integer <int64>

                                                                                              Identifiant de carte de paiement

                                                                                              header Parameters
                                                                                              ps-language
                                                                                              string
                                                                                              Default: fr

                                                                                              Langue de retour API

                                                                                              x-version
                                                                                              string

                                                                                              Version de l'API

                                                                                              ps-ip-address
                                                                                              required
                                                                                              string

                                                                                              Adresse IP du client final

                                                                                              Request Body schema: application/json

                                                                                              Corps de méthode

                                                                                              required
                                                                                              object

                                                                                              Panier

                                                                                              comment
                                                                                              string [ 0 .. 256 ] characters

                                                                                              Commentaire du paiement

                                                                                              required
                                                                                              object

                                                                                              Adresse de facturation

                                                                                              email
                                                                                              required
                                                                                              string <email> non-empty

                                                                                              Adresse client

                                                                                              orderReference
                                                                                              required
                                                                                              string [ 0 .. 50 ] characters ^[a-zA-Z0-9-_]*$

                                                                                              Référence unique du money-in

                                                                                              returnUrl
                                                                                              required
                                                                                              string <uri> non-empty

                                                                                              URL de retour de succès sur le site du partenaire

                                                                                              cancelUrl
                                                                                              required
                                                                                              string <uri> non-empty

                                                                                              URL de retour d'annulation sur le site du partenaire

                                                                                              errorUrl
                                                                                              required
                                                                                              string <uri> non-empty

                                                                                              URL de retour d'erreur sur le site du partenaire

                                                                                              bankingLabel
                                                                                              string [ 0 .. 16 ] characters ^[A-Za-z0-9]{0,16}$

                                                                                              Libellé Monétique

                                                                                              bankingLabelLocality
                                                                                              string [ 0 .. 32 ] characters ^([-A-Za-z0-9]+\\[-A-Z a-z0-9]*\\[A-Za-z]{3})...

                                                                                              Libellé monétique localité

                                                                                              challenge3DSecureMode
                                                                                              required
                                                                                              string
                                                                                              Enum: "noChoice" "challengePreferred" "challengeMandated" "noChallengeRequested"

                                                                                              Type du challenge 3DSecure (valeur par défaut = noChoice).

                                                                                              object

                                                                                              Informations client.

                                                                                              object

                                                                                              Adresse d'expédition.

                                                                                              Array of objects (CardInformationChallenge3DSecureCartItem) [ items ]

                                                                                              Panier du client.

                                                                                              Responses

                                                                                              Request samples

                                                                                              Content type
                                                                                              application/json
                                                                                              {
                                                                                              • "split": {
                                                                                                },
                                                                                              • "comment": "string",
                                                                                              • "billingAddress": {
                                                                                                },
                                                                                              • "email": "user@example.com",
                                                                                              • "orderReference": "string",
                                                                                              • "returnUrl": "http://example.com",
                                                                                              • "cancelUrl": "http://example.com",
                                                                                              • "errorUrl": "http://example.com",
                                                                                              • "bankingLabel": "string",
                                                                                              • "bankingLabelLocality": "string",
                                                                                              • "challenge3DSecureMode": "noChoice",
                                                                                              • "client": {
                                                                                                },
                                                                                              • "shippingAddress": {
                                                                                                },
                                                                                              • "carts": [
                                                                                                ]
                                                                                              }

                                                                                              Response samples

                                                                                              Content type
                                                                                              application/json
                                                                                              {
                                                                                              • "id": 0,
                                                                                              • "date": "2019-08-24T14:15:22Z",
                                                                                              • "debit": 0,
                                                                                              • "credit": 0,
                                                                                              • "comment": "string",
                                                                                              • "senderAccountId": "string",
                                                                                              • "receiverAccountId": "string",
                                                                                              • "code": "string",
                                                                                              • "message": "string",
                                                                                              • "dueDate": "2019-08-24T14:15:22Z",
                                                                                              • "status": "complete",
                                                                                              • "card": {
                                                                                                },
                                                                                              • "errorMessage": "string",
                                                                                              • "type": "moneyIn",
                                                                                              • "method": "card",
                                                                                              • "iban": {
                                                                                                },
                                                                                              • "pspToken": "string",
                                                                                              • "transferReference": "string",
                                                                                              • "link": 0,
                                                                                              • "p2pIds": [
                                                                                                ],
                                                                                              • "archivingKey": "string",
                                                                                              • "eventPaymentType": "purchase",
                                                                                              • "authorizationCode": "string",
                                                                                              • "clientFirstName": "string",
                                                                                              • "clientLastName": "string",
                                                                                              • "companyName": "string",
                                                                                              • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                              • "creditorIBAN": "string",
                                                                                              • "directDebit": {
                                                                                                },
                                                                                              • "paymentInitiation": {},
                                                                                              • "hostedFieldsStatus": "started",
                                                                                              • "hostedFieldsToken": "string",
                                                                                              • "hostedFieldsTpe": "string",
                                                                                              • "hostedFieldsLink": {
                                                                                                },
                                                                                              • "orderReference": "string"
                                                                                              }

                                                                                              Crée un paiement fractionné par carte

                                                                                              Fonctionnalité requise : PaymentCard

                                                                                              Authorizations:
                                                                                              x-api-key
                                                                                                path Parameters
                                                                                                partner
                                                                                                required
                                                                                                string

                                                                                                Code partenaire

                                                                                                header Parameters
                                                                                                ps-language
                                                                                                string
                                                                                                Default: fr

                                                                                                Langue de retour API

                                                                                                x-version
                                                                                                string

                                                                                                Version de l'API

                                                                                                ps-ip-address
                                                                                                required
                                                                                                string

                                                                                                Adresse IP du client final

                                                                                                Request Body schema: application/json

                                                                                                Corps de méthode

                                                                                                required
                                                                                                object

                                                                                                Echéance

                                                                                                orderReference
                                                                                                required
                                                                                                string [ 0 .. 50 ] characters ^[a-zA-Z0-9-_]*$

                                                                                                Référence unique du money-in

                                                                                                returnUrl
                                                                                                required
                                                                                                string <uri> non-empty

                                                                                                URL de retour de succès sur le site du partenaire

                                                                                                cancelUrl
                                                                                                required
                                                                                                string <uri> non-empty

                                                                                                URL de retour d'annulation sur le site du partenaire

                                                                                                errorUrl
                                                                                                required
                                                                                                string <uri> non-empty

                                                                                                URL de retour d'erreur sur le site du partenaire

                                                                                                required
                                                                                                object

                                                                                                Adresse de facturation

                                                                                                email
                                                                                                required
                                                                                                string <email> non-empty

                                                                                                Adresse client

                                                                                                isIFrame
                                                                                                required
                                                                                                boolean

                                                                                                Active l'appel au PSP dans une iFrame

                                                                                                comment
                                                                                                string [ 0 .. 256 ] characters

                                                                                                Commentaire concernant le money-in

                                                                                                bankingLabel
                                                                                                string [ 0 .. 16 ] characters ^[A-Za-z0-9]{0,16}$

                                                                                                Libellé Monétique

                                                                                                bankingLabelLocality
                                                                                                string [ 0 .. 32 ] characters ^([-A-Za-z0-9]+\\[-A-Z a-z0-9]*\\[A-Za-z]{3})...

                                                                                                Libellé monétique localité

                                                                                                isHostedFields
                                                                                                required
                                                                                                boolean

                                                                                                Indique une initialisation de paiement en mode Hosted Fields

                                                                                                challenge3DSecureMode
                                                                                                required
                                                                                                string
                                                                                                Enum: "noChoice" "challengePreferred" "challengeMandated" "noChallengeRequested"

                                                                                                Type du challenge 3DSecure (valeur par défaut = noChoice).

                                                                                                object

                                                                                                Informations client.

                                                                                                object

                                                                                                Adresse d'expédition.

                                                                                                Array of objects (CardInformationChallenge3DSecureCartItem) [ items ]

                                                                                                Panier du client.

                                                                                                Responses

                                                                                                Request samples

                                                                                                Content type
                                                                                                application/json
                                                                                                {
                                                                                                • "payment": {
                                                                                                  },
                                                                                                • "orderReference": "string",
                                                                                                • "returnUrl": "http://example.com",
                                                                                                • "cancelUrl": "http://example.com",
                                                                                                • "errorUrl": "http://example.com",
                                                                                                • "billingAddress": {
                                                                                                  },
                                                                                                • "email": "user@example.com",
                                                                                                • "isIFrame": true,
                                                                                                • "comment": "string",
                                                                                                • "bankingLabel": "string",
                                                                                                • "bankingLabelLocality": "string",
                                                                                                • "isHostedFields": true,
                                                                                                • "challenge3DSecureMode": "noChoice",
                                                                                                • "client": {
                                                                                                  },
                                                                                                • "shippingAddress": {
                                                                                                  },
                                                                                                • "carts": [
                                                                                                  ]
                                                                                                }

                                                                                                Response samples

                                                                                                Content type
                                                                                                application/json
                                                                                                {
                                                                                                • "id": 0,
                                                                                                • "date": "2019-08-24T14:15:22Z",
                                                                                                • "debit": 0,
                                                                                                • "credit": 0,
                                                                                                • "comment": "string",
                                                                                                • "senderAccountId": "string",
                                                                                                • "receiverAccountId": "string",
                                                                                                • "code": "string",
                                                                                                • "message": "string",
                                                                                                • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                • "status": "complete",
                                                                                                • "card": {
                                                                                                  },
                                                                                                • "errorMessage": "string",
                                                                                                • "type": "moneyIn",
                                                                                                • "method": "card",
                                                                                                • "iban": {
                                                                                                  },
                                                                                                • "pspToken": "string",
                                                                                                • "transferReference": "string",
                                                                                                • "link": 0,
                                                                                                • "p2pIds": [
                                                                                                  ],
                                                                                                • "archivingKey": "string",
                                                                                                • "eventPaymentType": "purchase",
                                                                                                • "authorizationCode": "string",
                                                                                                • "clientFirstName": "string",
                                                                                                • "clientLastName": "string",
                                                                                                • "companyName": "string",
                                                                                                • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                • "creditorIBAN": "string",
                                                                                                • "directDebit": {
                                                                                                  },
                                                                                                • "paymentInitiation": {},
                                                                                                • "hostedFieldsStatus": "started",
                                                                                                • "hostedFieldsToken": "string",
                                                                                                • "hostedFieldsTpe": "string",
                                                                                                • "hostedFieldsLink": {
                                                                                                  },
                                                                                                • "orderReference": "string"
                                                                                                }

                                                                                                Valide un paiement différé par carte

                                                                                                Fonctionnalité requise : PaymentCard

                                                                                                Authorizations:
                                                                                                x-api-key
                                                                                                  path Parameters
                                                                                                  partner
                                                                                                  required
                                                                                                  string

                                                                                                  Code partenaire

                                                                                                  transactionId
                                                                                                  required
                                                                                                  integer <int64>

                                                                                                  Identifiant de transaction entrante

                                                                                                  header Parameters
                                                                                                  ps-language
                                                                                                  string
                                                                                                  Default: fr

                                                                                                  Langue de retour API

                                                                                                  x-version
                                                                                                  string

                                                                                                  Version de l'API

                                                                                                  ps-ip-address
                                                                                                  required
                                                                                                  string

                                                                                                  Adresse IP du client final

                                                                                                  Request Body schema: application/json

                                                                                                  Corps de méthode

                                                                                                  object

                                                                                                  Panier

                                                                                                  Responses

                                                                                                  Request samples

                                                                                                  Content type
                                                                                                  application/json
                                                                                                  {
                                                                                                  • "split": {
                                                                                                    }
                                                                                                  }

                                                                                                  Response samples

                                                                                                  Content type
                                                                                                  application/json
                                                                                                  {
                                                                                                  • "id": 0,
                                                                                                  • "date": "2019-08-24T14:15:22Z",
                                                                                                  • "debit": 0,
                                                                                                  • "credit": 0,
                                                                                                  • "comment": "string",
                                                                                                  • "senderAccountId": "string",
                                                                                                  • "receiverAccountId": "string",
                                                                                                  • "code": "string",
                                                                                                  • "message": "string",
                                                                                                  • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                  • "status": "complete",
                                                                                                  • "card": {
                                                                                                    },
                                                                                                  • "errorMessage": "string",
                                                                                                  • "type": "moneyIn",
                                                                                                  • "method": "card",
                                                                                                  • "iban": {
                                                                                                    },
                                                                                                  • "pspToken": "string",
                                                                                                  • "transferReference": "string",
                                                                                                  • "link": 0,
                                                                                                  • "p2pIds": [
                                                                                                    ],
                                                                                                  • "archivingKey": "string",
                                                                                                  • "eventPaymentType": "purchase",
                                                                                                  • "authorizationCode": "string",
                                                                                                  • "clientFirstName": "string",
                                                                                                  • "clientLastName": "string",
                                                                                                  • "companyName": "string",
                                                                                                  • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                  • "creditorIBAN": "string",
                                                                                                  • "directDebit": {
                                                                                                    },
                                                                                                  • "paymentInitiation": {},
                                                                                                  • "hostedFieldsStatus": "started",
                                                                                                  • "hostedFieldsToken": "string",
                                                                                                  • "hostedFieldsTpe": "string",
                                                                                                  • "hostedFieldsLink": {
                                                                                                    },
                                                                                                  • "orderReference": "string"
                                                                                                  }

                                                                                                  Annule un paiement par virement

                                                                                                  Fonctionnalité requise : PaymentTransfer

                                                                                                  Authorizations:
                                                                                                  x-api-key
                                                                                                    path Parameters
                                                                                                    partner
                                                                                                    required
                                                                                                    string

                                                                                                    Code partenaire

                                                                                                    transactionId
                                                                                                    required
                                                                                                    integer <int64>

                                                                                                    Identifiant de transaction entrante

                                                                                                    header Parameters
                                                                                                    ps-language
                                                                                                    string
                                                                                                    Default: fr

                                                                                                    Langue de retour API

                                                                                                    x-version
                                                                                                    string

                                                                                                    Version de l'API

                                                                                                    ps-ip-address
                                                                                                    required
                                                                                                    string

                                                                                                    Adresse IP du client final

                                                                                                    Responses

                                                                                                    Response samples

                                                                                                    Content type
                                                                                                    application/json
                                                                                                    {
                                                                                                    • "message": "string",
                                                                                                    • "code": "clientCertificateInvalid",
                                                                                                    • "errorToken": "string"
                                                                                                    }

                                                                                                    Crée un paiement par carte "InStore".

                                                                                                    Fonctionnalité requise : PaymentCardInStore

                                                                                                    Authorizations:
                                                                                                    x-api-key
                                                                                                      path Parameters
                                                                                                      partner
                                                                                                      required
                                                                                                      string

                                                                                                      Code partenaire

                                                                                                      header Parameters
                                                                                                      ps-language
                                                                                                      string
                                                                                                      Default: fr

                                                                                                      Langue de retour API

                                                                                                      x-version
                                                                                                      string

                                                                                                      Version de l'API

                                                                                                      ps-ip-address
                                                                                                      required
                                                                                                      string

                                                                                                      Adresse IP du client final

                                                                                                      Request Body schema: application/json

                                                                                                      Corps de méthode

                                                                                                      required
                                                                                                      object

                                                                                                      Panier

                                                                                                      orderReference
                                                                                                      required
                                                                                                      string [ 0 .. 50 ] characters ^[a-zA-Z0-9-_]*$

                                                                                                      Référence unique du money-in

                                                                                                      comment
                                                                                                      string [ 0 .. 256 ] characters

                                                                                                      Commentaire concernant le money-in

                                                                                                      Responses

                                                                                                      Request samples

                                                                                                      Content type
                                                                                                      application/json
                                                                                                      {
                                                                                                      • "split": {
                                                                                                        },
                                                                                                      • "orderReference": "string",
                                                                                                      • "comment": "string"
                                                                                                      }

                                                                                                      Response samples

                                                                                                      Content type
                                                                                                      application/json
                                                                                                      {
                                                                                                      • "id": 0,
                                                                                                      • "date": "2019-08-24T14:15:22Z",
                                                                                                      • "debit": 0,
                                                                                                      • "credit": 0,
                                                                                                      • "comment": "string",
                                                                                                      • "senderAccountId": "string",
                                                                                                      • "receiverAccountId": "string",
                                                                                                      • "code": "string",
                                                                                                      • "message": "string",
                                                                                                      • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                      • "status": "complete",
                                                                                                      • "card": {
                                                                                                        },
                                                                                                      • "errorMessage": "string",
                                                                                                      • "type": "moneyIn",
                                                                                                      • "method": "card",
                                                                                                      • "iban": {
                                                                                                        },
                                                                                                      • "pspToken": "string",
                                                                                                      • "transferReference": "string",
                                                                                                      • "link": 0,
                                                                                                      • "p2pIds": [
                                                                                                        ],
                                                                                                      • "archivingKey": "string",
                                                                                                      • "eventPaymentType": "purchase",
                                                                                                      • "authorizationCode": "string",
                                                                                                      • "clientFirstName": "string",
                                                                                                      • "clientLastName": "string",
                                                                                                      • "companyName": "string",
                                                                                                      • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                      • "creditorIBAN": "string",
                                                                                                      • "directDebit": {
                                                                                                        },
                                                                                                      • "paymentInitiation": {},
                                                                                                      • "hostedFieldsStatus": "started",
                                                                                                      • "hostedFieldsToken": "string",
                                                                                                      • "hostedFieldsTpe": "string",
                                                                                                      • "hostedFieldsLink": {
                                                                                                        },
                                                                                                      • "orderReference": "string"
                                                                                                      }

                                                                                                      Crée un transfert d'argent vers un marchand par virement

                                                                                                      Fonctionnalité requise : PaymentTransfer

                                                                                                      Authorizations:
                                                                                                      x-api-key
                                                                                                        path Parameters
                                                                                                        partner
                                                                                                        required
                                                                                                        string

                                                                                                        Code partenaire

                                                                                                        header Parameters
                                                                                                        ps-language
                                                                                                        string
                                                                                                        Default: fr

                                                                                                        Langue de retour API

                                                                                                        x-version
                                                                                                        string

                                                                                                        Version de l'API

                                                                                                        ps-ip-address
                                                                                                        required
                                                                                                        string

                                                                                                        Adresse IP du client final

                                                                                                        Request Body schema: application/json

                                                                                                        Corps de méthode

                                                                                                        totalAmount
                                                                                                        number <decimal>

                                                                                                        Le montant total du virement

                                                                                                        accountId
                                                                                                        string

                                                                                                        Le code marchand

                                                                                                        comment
                                                                                                        string

                                                                                                        Commentaire de la transaction

                                                                                                        Responses

                                                                                                        Request samples

                                                                                                        Content type
                                                                                                        application/json
                                                                                                        {
                                                                                                        • "totalAmount": 0,
                                                                                                        • "accountId": "string",
                                                                                                        • "comment": "string"
                                                                                                        }

                                                                                                        Response samples

                                                                                                        Content type
                                                                                                        application/json
                                                                                                        {
                                                                                                        • "id": 0,
                                                                                                        • "date": "2019-08-24T14:15:22Z",
                                                                                                        • "debit": 0,
                                                                                                        • "credit": 0,
                                                                                                        • "comment": "string",
                                                                                                        • "senderAccountId": "string",
                                                                                                        • "receiverAccountId": "string",
                                                                                                        • "code": "string",
                                                                                                        • "message": "string",
                                                                                                        • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                        • "status": "complete",
                                                                                                        • "card": {
                                                                                                          },
                                                                                                        • "errorMessage": "string",
                                                                                                        • "type": "moneyIn",
                                                                                                        • "method": "card",
                                                                                                        • "iban": {
                                                                                                          },
                                                                                                        • "pspToken": "string",
                                                                                                        • "transferReference": "string",
                                                                                                        • "link": 0,
                                                                                                        • "p2pIds": [
                                                                                                          ],
                                                                                                        • "archivingKey": "string",
                                                                                                        • "eventPaymentType": "purchase",
                                                                                                        • "authorizationCode": "string",
                                                                                                        • "clientFirstName": "string",
                                                                                                        • "clientLastName": "string",
                                                                                                        • "companyName": "string",
                                                                                                        • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                        • "creditorIBAN": "string",
                                                                                                        • "directDebit": {
                                                                                                          },
                                                                                                        • "paymentInitiation": {},
                                                                                                        • "hostedFieldsStatus": "started",
                                                                                                        • "hostedFieldsToken": "string",
                                                                                                        • "hostedFieldsTpe": "string",
                                                                                                        • "hostedFieldsLink": {
                                                                                                          },
                                                                                                        • "orderReference": "string"
                                                                                                        }

                                                                                                        Met en place un échéancier e-prélèvement.

                                                                                                        Fonctionnalité requise : PaymentDirectDebit

                                                                                                        Authorizations:
                                                                                                        x-api-key
                                                                                                          path Parameters
                                                                                                          partner
                                                                                                          required
                                                                                                          string

                                                                                                          Code partenaire.

                                                                                                          rum
                                                                                                          required
                                                                                                          string

                                                                                                          Référence unique du Mandat.

                                                                                                          header Parameters
                                                                                                          ps-language
                                                                                                          string
                                                                                                          Default: fr

                                                                                                          Langue de retour API

                                                                                                          x-version
                                                                                                          string

                                                                                                          Version de l'API

                                                                                                          ps-ip-address
                                                                                                          required
                                                                                                          string

                                                                                                          Adresse IP du client final

                                                                                                          Request Body schema: application/json

                                                                                                          Corps de méthode.

                                                                                                          required
                                                                                                          object

                                                                                                          Panier

                                                                                                          dueDay
                                                                                                          required
                                                                                                          integer <int32> [ 1 .. 31 ]

                                                                                                          Jour d'échéance du e-prélèvement.

                                                                                                          dueDateCount
                                                                                                          required
                                                                                                          integer <int32> [ 1 .. 999 ]

                                                                                                          Nombre d'échéance à émettre (999 = illimité).

                                                                                                          dueDate
                                                                                                          required
                                                                                                          string <date-time> non-empty

                                                                                                          Date de la première échéance ou date du e-prélèvement (minimum date du jour + 2 jours ouvrés).

                                                                                                          periodicity
                                                                                                          required
                                                                                                          string
                                                                                                          Enum: "unique" "monthly" "biMonthly" "threeMonthly" "fourMonthly" "biAnnual" "annual"

                                                                                                          Périodicité du e-prélèvement.

                                                                                                          reason1
                                                                                                          required
                                                                                                          string [ 0 .. 35 ] characters ^[ 0-9a-zA-Z,\/-]*$

                                                                                                          Motif du e-prélèvement.

                                                                                                          reason2
                                                                                                          string [ 0 .. 35 ] characters ^[ 0-9a-zA-Z,\/-]*$

                                                                                                          Motif du e-prélèvement - ligne complémentaire 2.

                                                                                                          reason3
                                                                                                          string [ 0 .. 35 ] characters ^[ 0-9a-zA-Z,\/-]*$

                                                                                                          Motif du e-prélèvement - ligne complémentaire 3.

                                                                                                          orderReference
                                                                                                          string [ 0 .. 35 ] characters ^[ 0-9a-zA-Z,\/-]*$

                                                                                                          Identifiant unique de paiement.

                                                                                                          Responses

                                                                                                          Request samples

                                                                                                          Content type
                                                                                                          application/json
                                                                                                          {
                                                                                                          • "split": {
                                                                                                            },
                                                                                                          • "dueDay": 1,
                                                                                                          • "dueDateCount": 1,
                                                                                                          • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                          • "periodicity": "unique",
                                                                                                          • "reason1": "string",
                                                                                                          • "reason2": "string",
                                                                                                          • "reason3": "string",
                                                                                                          • "orderReference": "string"
                                                                                                          }

                                                                                                          Response samples

                                                                                                          Content type
                                                                                                          application/json
                                                                                                          {
                                                                                                          • "id": 0,
                                                                                                          • "date": "2019-08-24T14:15:22Z",
                                                                                                          • "debit": 0,
                                                                                                          • "credit": 0,
                                                                                                          • "comment": "string",
                                                                                                          • "senderAccountId": "string",
                                                                                                          • "receiverAccountId": "string",
                                                                                                          • "code": "string",
                                                                                                          • "message": "string",
                                                                                                          • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                          • "status": "complete",
                                                                                                          • "card": {
                                                                                                            },
                                                                                                          • "errorMessage": "string",
                                                                                                          • "type": "moneyIn",
                                                                                                          • "method": "card",
                                                                                                          • "iban": {
                                                                                                            },
                                                                                                          • "pspToken": "string",
                                                                                                          • "transferReference": "string",
                                                                                                          • "link": 0,
                                                                                                          • "p2pIds": [
                                                                                                            ],
                                                                                                          • "archivingKey": "string",
                                                                                                          • "eventPaymentType": "purchase",
                                                                                                          • "authorizationCode": "string",
                                                                                                          • "clientFirstName": "string",
                                                                                                          • "clientLastName": "string",
                                                                                                          • "companyName": "string",
                                                                                                          • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                          • "creditorIBAN": "string",
                                                                                                          • "directDebit": {
                                                                                                            },
                                                                                                          • "paymentInitiation": {},
                                                                                                          • "hostedFieldsStatus": "started",
                                                                                                          • "hostedFieldsToken": "string",
                                                                                                          • "hostedFieldsTpe": "string",
                                                                                                          • "hostedFieldsLink": {
                                                                                                            },
                                                                                                          • "orderReference": "string"
                                                                                                          }

                                                                                                          Modifie un échéancier e-prélèvement.

                                                                                                          Fonctionnalité requise : PaymentDirectDebit

                                                                                                          Authorizations:
                                                                                                          x-api-key
                                                                                                            path Parameters
                                                                                                            partner
                                                                                                            required
                                                                                                            string

                                                                                                            Code partenaire.

                                                                                                            rum
                                                                                                            required
                                                                                                            string

                                                                                                            Référence unique du Mandat.

                                                                                                            directDebitId
                                                                                                            required
                                                                                                            integer <int64>

                                                                                                            Identifiant de l'échéancier.

                                                                                                            header Parameters
                                                                                                            ps-language
                                                                                                            string
                                                                                                            Default: fr

                                                                                                            Langue de retour API

                                                                                                            x-version
                                                                                                            string

                                                                                                            Version de l'API

                                                                                                            ps-ip-address
                                                                                                            required
                                                                                                            string

                                                                                                            Adresse IP du client final

                                                                                                            Request Body schema: application/json

                                                                                                            Corps de méthode.

                                                                                                            dueAmount
                                                                                                            required
                                                                                                            number <decimal>

                                                                                                            Montant de l'échéance

                                                                                                            nextDueSpecificAmount
                                                                                                            number <decimal>

                                                                                                            Montant de la prochaine échéance. Ne concerne que les e-prélèvements périodiques.

                                                                                                            nextDueDate
                                                                                                            string <date-time>

                                                                                                            Date de la prochaine échéance de e-prélèvement.

                                                                                                            periodicity
                                                                                                            string
                                                                                                            Enum: "monthly" "biMonthly" "threeMonthly" "fourMonthly" "biAnnual" "annual"

                                                                                                            Périodicité du e-prélèvement. Ne concerne que les e-prélèvements périodiques.

                                                                                                            dueDateCount
                                                                                                            integer <int32> [ 1 .. 999 ]

                                                                                                            Nombre d’échéances restantes (999 = illimité). Ne concerne que les e-prélèvements périodiques.

                                                                                                            dueDay
                                                                                                            integer <int32> [ 1 .. 31 ]

                                                                                                            Jour d'échéance du e-prélèvement. Ne concerne que les e-prélèvements périodiques.

                                                                                                            reason1
                                                                                                            string [ 0 .. 35 ] characters ^[ 0-9a-zA-Z,\/-]*$

                                                                                                            Motif du e-prélèvement.

                                                                                                            reason2
                                                                                                            string [ 0 .. 35 ] characters ^[ 0-9a-zA-Z,\/-]*$

                                                                                                            Motif du e-prélèvement - ligne complémentaire 2.

                                                                                                            reason3
                                                                                                            string [ 0 .. 35 ] characters ^[ 0-9a-zA-Z,\/-]*$

                                                                                                            Motif du e-prélèvement - ligne complémentaire 3.

                                                                                                            Responses

                                                                                                            Request samples

                                                                                                            Content type
                                                                                                            application/json
                                                                                                            {
                                                                                                            • "dueAmount": 0,
                                                                                                            • "nextDueSpecificAmount": 0,
                                                                                                            • "nextDueDate": "2019-08-24T14:15:22Z",
                                                                                                            • "periodicity": "monthly",
                                                                                                            • "dueDateCount": 1,
                                                                                                            • "dueDay": 1,
                                                                                                            • "reason1": "string",
                                                                                                            • "reason2": "string",
                                                                                                            • "reason3": "string"
                                                                                                            }

                                                                                                            Response samples

                                                                                                            Content type
                                                                                                            application/json
                                                                                                            {
                                                                                                            • "id": 0,
                                                                                                            • "date": "2019-08-24T14:15:22Z",
                                                                                                            • "debit": 0,
                                                                                                            • "credit": 0,
                                                                                                            • "comment": "string",
                                                                                                            • "senderAccountId": "string",
                                                                                                            • "receiverAccountId": "string",
                                                                                                            • "code": "string",
                                                                                                            • "message": "string",
                                                                                                            • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                            • "status": "complete",
                                                                                                            • "card": {
                                                                                                              },
                                                                                                            • "errorMessage": "string",
                                                                                                            • "type": "moneyIn",
                                                                                                            • "method": "card",
                                                                                                            • "iban": {
                                                                                                              },
                                                                                                            • "pspToken": "string",
                                                                                                            • "transferReference": "string",
                                                                                                            • "link": 0,
                                                                                                            • "p2pIds": [
                                                                                                              ],
                                                                                                            • "archivingKey": "string",
                                                                                                            • "eventPaymentType": "purchase",
                                                                                                            • "authorizationCode": "string",
                                                                                                            • "clientFirstName": "string",
                                                                                                            • "clientLastName": "string",
                                                                                                            • "companyName": "string",
                                                                                                            • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                            • "creditorIBAN": "string",
                                                                                                            • "directDebit": {
                                                                                                              },
                                                                                                            • "paymentInitiation": {},
                                                                                                            • "hostedFieldsStatus": "started",
                                                                                                            • "hostedFieldsToken": "string",
                                                                                                            • "hostedFieldsTpe": "string",
                                                                                                            • "hostedFieldsLink": {
                                                                                                              },
                                                                                                            • "orderReference": "string"
                                                                                                            }

                                                                                                            Suspend un échéancier e-prélèvement.

                                                                                                            Fonctionnalité requise : PaymentDirectDebit

                                                                                                            Authorizations:
                                                                                                            x-api-key
                                                                                                              path Parameters
                                                                                                              partner
                                                                                                              required
                                                                                                              string

                                                                                                              Code partenaire.

                                                                                                              rum
                                                                                                              required
                                                                                                              string

                                                                                                              Référence unique du Mandat.

                                                                                                              directDebitId
                                                                                                              required
                                                                                                              integer <int64>

                                                                                                              Identifiant de l'échéancier.

                                                                                                              header Parameters
                                                                                                              ps-language
                                                                                                              string
                                                                                                              Default: fr

                                                                                                              Langue de retour API

                                                                                                              x-version
                                                                                                              string

                                                                                                              Version de l'API

                                                                                                              ps-ip-address
                                                                                                              required
                                                                                                              string

                                                                                                              Adresse IP du client final

                                                                                                              Responses

                                                                                                              Response samples

                                                                                                              Content type
                                                                                                              application/json
                                                                                                              {
                                                                                                              • "message": "string",
                                                                                                              • "code": "directDebitIdInvalid",
                                                                                                              • "errorToken": "string"
                                                                                                              }

                                                                                                              Réactive un échéancier e-prélèvement suspendu.

                                                                                                              Fonctionnalité requise : PaymentDirectDebit

                                                                                                              Authorizations:
                                                                                                              x-api-key
                                                                                                                path Parameters
                                                                                                                partner
                                                                                                                required
                                                                                                                string

                                                                                                                Code partenaire.

                                                                                                                rum
                                                                                                                required
                                                                                                                string

                                                                                                                Référence unique du Mandat.

                                                                                                                directDebitId
                                                                                                                required
                                                                                                                integer <int64>

                                                                                                                Identifiant de l'échéancier.

                                                                                                                header Parameters
                                                                                                                ps-language
                                                                                                                string
                                                                                                                Default: fr

                                                                                                                Langue de retour API

                                                                                                                x-version
                                                                                                                string

                                                                                                                Version de l'API

                                                                                                                ps-ip-address
                                                                                                                required
                                                                                                                string

                                                                                                                Adresse IP du client final

                                                                                                                Responses

                                                                                                                Response samples

                                                                                                                Content type
                                                                                                                application/json
                                                                                                                {
                                                                                                                • "message": "string",
                                                                                                                • "code": "directDebitIdInvalid",
                                                                                                                • "errorToken": "string"
                                                                                                                }

                                                                                                                Clôture un échéancier e-prélèvement.

                                                                                                                Fonctionnalité requise : PaymentDirectDebit

                                                                                                                Authorizations:
                                                                                                                x-api-key
                                                                                                                  path Parameters
                                                                                                                  partner
                                                                                                                  required
                                                                                                                  string

                                                                                                                  Code partenaire.

                                                                                                                  rum
                                                                                                                  required
                                                                                                                  string

                                                                                                                  Référence unique du Mandat.

                                                                                                                  directDebitId
                                                                                                                  required
                                                                                                                  integer <int64>

                                                                                                                  Identifiant de l'échéancier.

                                                                                                                  header Parameters
                                                                                                                  ps-language
                                                                                                                  string
                                                                                                                  Default: fr

                                                                                                                  Langue de retour API

                                                                                                                  x-version
                                                                                                                  string

                                                                                                                  Version de l'API

                                                                                                                  ps-ip-address
                                                                                                                  required
                                                                                                                  string

                                                                                                                  Adresse IP du client final

                                                                                                                  Responses

                                                                                                                  Response samples

                                                                                                                  Content type
                                                                                                                  application/json
                                                                                                                  {
                                                                                                                  • "message": "string",
                                                                                                                  • "code": "directDebitIdInvalid",
                                                                                                                  • "errorToken": "string"
                                                                                                                  }

                                                                                                                  Etape d'entrée pour paiements utilisant Hosted Fields

                                                                                                                  Fonctionnalité requise : PaymentCard

                                                                                                                  Authorizations:
                                                                                                                  x-api-key
                                                                                                                    path Parameters
                                                                                                                    partner
                                                                                                                    required
                                                                                                                    string

                                                                                                                    Code partenaire

                                                                                                                    transactionId
                                                                                                                    required
                                                                                                                    integer <int64>

                                                                                                                    Identifiant de transaction

                                                                                                                    header Parameters
                                                                                                                    ps-language
                                                                                                                    string
                                                                                                                    Default: fr

                                                                                                                    Langue de retour API

                                                                                                                    x-version
                                                                                                                    string

                                                                                                                    Version de l'API

                                                                                                                    ps-ip-address
                                                                                                                    required
                                                                                                                    string

                                                                                                                    Adresse IP du client final

                                                                                                                    Request Body schema: application/json

                                                                                                                    Configuration du navigateur client

                                                                                                                    acceptHeader
                                                                                                                    required
                                                                                                                    string non-empty

                                                                                                                    Contenu du header HTTP « Accept » envoyé par le porteur au serveur du commerçant

                                                                                                                    javaEnabled
                                                                                                                    required
                                                                                                                    boolean

                                                                                                                    Résultat de l’exécution de la fonction JavaScript « navigator.javaEnabled() » par le navigateur du porteur

                                                                                                                    language
                                                                                                                    required
                                                                                                                    string non-empty

                                                                                                                    Propriété « navigator.language » du navigateur du porteur

                                                                                                                    timezoneOffset
                                                                                                                    required
                                                                                                                    integer <int64>

                                                                                                                    Valeur représentant la différence en minutes entre l’heure UTC et l’heure locale du porteur Résultat de l’exécution de la fonction JavaScript « new Date().getTimezoneOffset()» par le navigateur du porteur

                                                                                                                    userAgent
                                                                                                                    required
                                                                                                                    string non-empty

                                                                                                                    Valeur représentant le nombre de bits par pixel pour l’affichage d’images. Propriété « screen.colorDepth » du navigateur du porteur

                                                                                                                    colorDepth
                                                                                                                    required
                                                                                                                    integer <int64>

                                                                                                                    Valeur représentant le nombre de bits par pixel pour l’affichage d’images. Propriété « screen.colorDepth » du navigateur du porteur

                                                                                                                    screenHeight
                                                                                                                    required
                                                                                                                    integer <int64> [ 1 .. 9223372036854780000 ]

                                                                                                                    Valeur représentant la hauteur de l’écran du porteur en pixels. Propriété « screen.height » du navigateur du porteur

                                                                                                                    screenWidth
                                                                                                                    required
                                                                                                                    integer <int64> [ 1 .. 9223372036854780000 ]

                                                                                                                    Valeur représentant la largeur de l’écran du porteur en pixels. Propriété « screen.width » du navigateur du porteur

                                                                                                                    Responses

                                                                                                                    Request samples

                                                                                                                    Content type
                                                                                                                    application/json
                                                                                                                    {
                                                                                                                    • "acceptHeader": "string",
                                                                                                                    • "javaEnabled": true,
                                                                                                                    • "language": "string",
                                                                                                                    • "timezoneOffset": 0,
                                                                                                                    • "userAgent": "string",
                                                                                                                    • "colorDepth": 0,
                                                                                                                    • "screenHeight": 1,
                                                                                                                    • "screenWidth": 1
                                                                                                                    }

                                                                                                                    Response samples

                                                                                                                    Content type
                                                                                                                    application/json
                                                                                                                    {
                                                                                                                    • "id": 0,
                                                                                                                    • "date": "2019-08-24T14:15:22Z",
                                                                                                                    • "debit": 0,
                                                                                                                    • "credit": 0,
                                                                                                                    • "comment": "string",
                                                                                                                    • "senderAccountId": "string",
                                                                                                                    • "receiverAccountId": "string",
                                                                                                                    • "code": "string",
                                                                                                                    • "message": "string",
                                                                                                                    • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                    • "status": "complete",
                                                                                                                    • "card": {
                                                                                                                      },
                                                                                                                    • "errorMessage": "string",
                                                                                                                    • "type": "moneyIn",
                                                                                                                    • "method": "card",
                                                                                                                    • "iban": {
                                                                                                                      },
                                                                                                                    • "pspToken": "string",
                                                                                                                    • "transferReference": "string",
                                                                                                                    • "link": 0,
                                                                                                                    • "p2pIds": [
                                                                                                                      ],
                                                                                                                    • "archivingKey": "string",
                                                                                                                    • "eventPaymentType": "purchase",
                                                                                                                    • "authorizationCode": "string",
                                                                                                                    • "clientFirstName": "string",
                                                                                                                    • "clientLastName": "string",
                                                                                                                    • "companyName": "string",
                                                                                                                    • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                    • "creditorIBAN": "string",
                                                                                                                    • "directDebit": {
                                                                                                                      },
                                                                                                                    • "paymentInitiation": {},
                                                                                                                    • "hostedFieldsStatus": "started",
                                                                                                                    • "hostedFieldsToken": "string",
                                                                                                                    • "hostedFieldsTpe": "string",
                                                                                                                    • "hostedFieldsLink": {
                                                                                                                      },
                                                                                                                    • "orderReference": "string"
                                                                                                                    }

                                                                                                                    Etape de contact PSP après l'envoi des données techniques

                                                                                                                    Fonctionnalité requise : PaymentCard

                                                                                                                    Authorizations:
                                                                                                                    x-api-key
                                                                                                                      path Parameters
                                                                                                                      partner
                                                                                                                      required
                                                                                                                      string

                                                                                                                      Code partenaire

                                                                                                                      transactionId
                                                                                                                      required
                                                                                                                      integer <int64>

                                                                                                                      Identifiant de transaction

                                                                                                                      header Parameters
                                                                                                                      ps-language
                                                                                                                      string
                                                                                                                      Default: fr

                                                                                                                      Langue de retour API

                                                                                                                      x-version
                                                                                                                      string

                                                                                                                      Version de l'API

                                                                                                                      ps-ip-address
                                                                                                                      required
                                                                                                                      string

                                                                                                                      Adresse IP du client final

                                                                                                                      Responses

                                                                                                                      Response samples

                                                                                                                      Content type
                                                                                                                      application/json
                                                                                                                      {
                                                                                                                      • "id": 0,
                                                                                                                      • "date": "2019-08-24T14:15:22Z",
                                                                                                                      • "debit": 0,
                                                                                                                      • "credit": 0,
                                                                                                                      • "comment": "string",
                                                                                                                      • "senderAccountId": "string",
                                                                                                                      • "receiverAccountId": "string",
                                                                                                                      • "code": "string",
                                                                                                                      • "message": "string",
                                                                                                                      • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                      • "status": "complete",
                                                                                                                      • "card": {
                                                                                                                        },
                                                                                                                      • "errorMessage": "string",
                                                                                                                      • "type": "moneyIn",
                                                                                                                      • "method": "card",
                                                                                                                      • "iban": {
                                                                                                                        },
                                                                                                                      • "pspToken": "string",
                                                                                                                      • "transferReference": "string",
                                                                                                                      • "link": 0,
                                                                                                                      • "p2pIds": [
                                                                                                                        ],
                                                                                                                      • "archivingKey": "string",
                                                                                                                      • "eventPaymentType": "purchase",
                                                                                                                      • "authorizationCode": "string",
                                                                                                                      • "clientFirstName": "string",
                                                                                                                      • "clientLastName": "string",
                                                                                                                      • "companyName": "string",
                                                                                                                      • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                      • "creditorIBAN": "string",
                                                                                                                      • "directDebit": {
                                                                                                                        },
                                                                                                                      • "paymentInitiation": {},
                                                                                                                      • "hostedFieldsStatus": "started",
                                                                                                                      • "hostedFieldsToken": "string",
                                                                                                                      • "hostedFieldsTpe": "string",
                                                                                                                      • "hostedFieldsLink": {
                                                                                                                        },
                                                                                                                      • "orderReference": "string"
                                                                                                                      }

                                                                                                                      Etape de paiement après le challenge 3DS dans le flux Hosted Fields

                                                                                                                      Fonctionnalité requise : PaymentCard

                                                                                                                      Authorizations:
                                                                                                                      x-api-key
                                                                                                                        path Parameters
                                                                                                                        partner
                                                                                                                        required
                                                                                                                        string

                                                                                                                        Code partenaire

                                                                                                                        header Parameters
                                                                                                                        ps-language
                                                                                                                        string
                                                                                                                        Default: fr

                                                                                                                        Langue de retour API

                                                                                                                        x-version
                                                                                                                        string

                                                                                                                        Version de l'API

                                                                                                                        ps-ip-address
                                                                                                                        required
                                                                                                                        string

                                                                                                                        Adresse IP du client final

                                                                                                                        Request Body schema: application/json

                                                                                                                        Donnée de résultat du challenge 3DS

                                                                                                                        threeDSSessionData
                                                                                                                        string

                                                                                                                        Données de la session du challenge 3DSecure

                                                                                                                        cres
                                                                                                                        string

                                                                                                                        Réponse au challenge 3DSecure

                                                                                                                        Responses

                                                                                                                        Request samples

                                                                                                                        Content type
                                                                                                                        application/json
                                                                                                                        {
                                                                                                                        • "threeDSSessionData": "string",
                                                                                                                        • "cres": "string"
                                                                                                                        }

                                                                                                                        Response samples

                                                                                                                        Content type
                                                                                                                        application/json
                                                                                                                        {
                                                                                                                        • "id": 0,
                                                                                                                        • "date": "2019-08-24T14:15:22Z",
                                                                                                                        • "debit": 0,
                                                                                                                        • "credit": 0,
                                                                                                                        • "comment": "string",
                                                                                                                        • "senderAccountId": "string",
                                                                                                                        • "receiverAccountId": "string",
                                                                                                                        • "code": "string",
                                                                                                                        • "message": "string",
                                                                                                                        • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                        • "status": "complete",
                                                                                                                        • "card": {
                                                                                                                          },
                                                                                                                        • "errorMessage": "string",
                                                                                                                        • "type": "moneyIn",
                                                                                                                        • "method": "card",
                                                                                                                        • "iban": {
                                                                                                                          },
                                                                                                                        • "pspToken": "string",
                                                                                                                        • "transferReference": "string",
                                                                                                                        • "link": 0,
                                                                                                                        • "p2pIds": [
                                                                                                                          ],
                                                                                                                        • "archivingKey": "string",
                                                                                                                        • "eventPaymentType": "purchase",
                                                                                                                        • "authorizationCode": "string",
                                                                                                                        • "clientFirstName": "string",
                                                                                                                        • "clientLastName": "string",
                                                                                                                        • "companyName": "string",
                                                                                                                        • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                        • "creditorIBAN": "string",
                                                                                                                        • "directDebit": {
                                                                                                                          },
                                                                                                                        • "paymentInitiation": {},
                                                                                                                        • "hostedFieldsStatus": "started",
                                                                                                                        • "hostedFieldsToken": "string",
                                                                                                                        • "hostedFieldsTpe": "string",
                                                                                                                        • "hostedFieldsLink": {
                                                                                                                          },
                                                                                                                        • "orderReference": "string"
                                                                                                                        }

                                                                                                                        Initiation d'une demande de paiement par initiation de paiement.

                                                                                                                        Fonctionnalité requise : PaymentInitiation

                                                                                                                        Authorizations:
                                                                                                                        x-api-key
                                                                                                                          path Parameters
                                                                                                                          partner
                                                                                                                          required
                                                                                                                          string
                                                                                                                          header Parameters
                                                                                                                          ps-language
                                                                                                                          string
                                                                                                                          Default: fr

                                                                                                                          Langue de retour API

                                                                                                                          x-version
                                                                                                                          string

                                                                                                                          Version de l'API

                                                                                                                          ps-ip-address
                                                                                                                          required
                                                                                                                          string

                                                                                                                          Adresse IP du client final

                                                                                                                          Request Body schema: application/json
                                                                                                                          required
                                                                                                                          object

                                                                                                                          Division du panier par marchand

                                                                                                                          orderReference
                                                                                                                          string

                                                                                                                          Référence de la commande

                                                                                                                          returnUrl
                                                                                                                          required
                                                                                                                          string <uri> non-empty

                                                                                                                          URL de retour de succès sur le site du partenaire

                                                                                                                          cancelUrl
                                                                                                                          required
                                                                                                                          string <uri> non-empty

                                                                                                                          URL de retour d'annulation sur le site du partenaire

                                                                                                                          errorUrl
                                                                                                                          required
                                                                                                                          string <uri> non-empty

                                                                                                                          URL de retour d'erreur sur le site du partenaire

                                                                                                                          email
                                                                                                                          required
                                                                                                                          string <email> non-empty

                                                                                                                          Adresse email du client

                                                                                                                          comment
                                                                                                                          string

                                                                                                                          Commentaire sur la demande de paiement

                                                                                                                          object

                                                                                                                          Informations client pour personne physique

                                                                                                                          object

                                                                                                                          Informations client pour personne morale

                                                                                                                          Responses

                                                                                                                          Request samples

                                                                                                                          Content type
                                                                                                                          application/json
                                                                                                                          {
                                                                                                                          • "split": {
                                                                                                                            },
                                                                                                                          • "orderReference": "string",
                                                                                                                          • "returnUrl": "http://example.com",
                                                                                                                          • "cancelUrl": "http://example.com",
                                                                                                                          • "errorUrl": "http://example.com",
                                                                                                                          • "email": "user@example.com",
                                                                                                                          • "comment": "string",
                                                                                                                          • "clientIndividual": {
                                                                                                                            },
                                                                                                                          • "clientProfessional": {
                                                                                                                            }
                                                                                                                          }

                                                                                                                          Response samples

                                                                                                                          Content type
                                                                                                                          application/json
                                                                                                                          {
                                                                                                                          • "id": 0,
                                                                                                                          • "date": "2019-08-24T14:15:22Z",
                                                                                                                          • "debit": 0,
                                                                                                                          • "credit": 0,
                                                                                                                          • "comment": "string",
                                                                                                                          • "senderAccountId": "string",
                                                                                                                          • "receiverAccountId": "string",
                                                                                                                          • "code": "string",
                                                                                                                          • "message": "string",
                                                                                                                          • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                          • "status": "complete",
                                                                                                                          • "card": {
                                                                                                                            },
                                                                                                                          • "errorMessage": "string",
                                                                                                                          • "type": "moneyIn",
                                                                                                                          • "method": "card",
                                                                                                                          • "iban": {
                                                                                                                            },
                                                                                                                          • "pspToken": "string",
                                                                                                                          • "transferReference": "string",
                                                                                                                          • "link": 0,
                                                                                                                          • "p2pIds": [
                                                                                                                            ],
                                                                                                                          • "archivingKey": "string",
                                                                                                                          • "eventPaymentType": "purchase",
                                                                                                                          • "authorizationCode": "string",
                                                                                                                          • "clientFirstName": "string",
                                                                                                                          • "clientLastName": "string",
                                                                                                                          • "companyName": "string",
                                                                                                                          • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                          • "creditorIBAN": "string",
                                                                                                                          • "directDebit": {
                                                                                                                            },
                                                                                                                          • "paymentInitiation": {},
                                                                                                                          • "hostedFieldsStatus": "started",
                                                                                                                          • "hostedFieldsToken": "string",
                                                                                                                          • "hostedFieldsTpe": "string",
                                                                                                                          • "hostedFieldsLink": {
                                                                                                                            },
                                                                                                                          • "orderReference": "string"
                                                                                                                          }

                                                                                                                          MoneyOuts

                                                                                                                          Liste les transactions sortantes

                                                                                                                          Authorizations:
                                                                                                                          x-api-key
                                                                                                                            path Parameters
                                                                                                                            partner
                                                                                                                            required
                                                                                                                            string

                                                                                                                            Code partenaire

                                                                                                                            query Parameters
                                                                                                                            sortBy
                                                                                                                            string
                                                                                                                            Enum: "id" "debit" "senderAccountId" "comment" "link"

                                                                                                                            Tri

                                                                                                                            orderBy
                                                                                                                            string
                                                                                                                            Enum: "asc" "desc"

                                                                                                                            Direction du tri

                                                                                                                            pageNumber
                                                                                                                            integer <int32> [ 1 .. 2147483647 ]

                                                                                                                            Numéro de page

                                                                                                                            pageSize
                                                                                                                            integer <int32> [ 1 .. 100 ]

                                                                                                                            Taille de la page

                                                                                                                            header Parameters
                                                                                                                            ps-language
                                                                                                                            string
                                                                                                                            Default: fr

                                                                                                                            Langue de retour API

                                                                                                                            x-version
                                                                                                                            string

                                                                                                                            Version de l'API

                                                                                                                            ps-ip-address
                                                                                                                            required
                                                                                                                            string

                                                                                                                            Adresse IP du client final

                                                                                                                            Responses

                                                                                                                            Response samples

                                                                                                                            Content type
                                                                                                                            application/json
                                                                                                                            [
                                                                                                                            • {
                                                                                                                              }
                                                                                                                            ]

                                                                                                                            Affiche une transaction sortante

                                                                                                                            Authorizations:
                                                                                                                            x-api-key
                                                                                                                              path Parameters
                                                                                                                              partner
                                                                                                                              required
                                                                                                                              string

                                                                                                                              Code partenaire

                                                                                                                              transactionId
                                                                                                                              required
                                                                                                                              integer <int64>

                                                                                                                              Identifiant de transaction sortante

                                                                                                                              header Parameters
                                                                                                                              ps-language
                                                                                                                              string
                                                                                                                              Default: fr

                                                                                                                              Langue de retour API

                                                                                                                              x-version
                                                                                                                              string

                                                                                                                              Version de l'API

                                                                                                                              ps-ip-address
                                                                                                                              required
                                                                                                                              string

                                                                                                                              Adresse IP du client final

                                                                                                                              Responses

                                                                                                                              Response samples

                                                                                                                              Content type
                                                                                                                              application/json
                                                                                                                              {
                                                                                                                              • "id": 0,
                                                                                                                              • "date": "2019-08-24T14:15:22Z",
                                                                                                                              • "debit": 0,
                                                                                                                              • "credit": 0,
                                                                                                                              • "comment": "string",
                                                                                                                              • "senderAccountId": "string",
                                                                                                                              • "receiverAccountId": "string",
                                                                                                                              • "code": "string",
                                                                                                                              • "message": "string",
                                                                                                                              • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                              • "status": "complete",
                                                                                                                              • "card": {
                                                                                                                                },
                                                                                                                              • "errorMessage": "string",
                                                                                                                              • "type": "moneyIn",
                                                                                                                              • "method": "card",
                                                                                                                              • "iban": {
                                                                                                                                },
                                                                                                                              • "pspToken": "string",
                                                                                                                              • "transferReference": "string",
                                                                                                                              • "link": 0,
                                                                                                                              • "p2pIds": [
                                                                                                                                ],
                                                                                                                              • "archivingKey": "string",
                                                                                                                              • "eventPaymentType": "purchase",
                                                                                                                              • "authorizationCode": "string",
                                                                                                                              • "clientFirstName": "string",
                                                                                                                              • "clientLastName": "string",
                                                                                                                              • "companyName": "string",
                                                                                                                              • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                              • "creditorIBAN": "string",
                                                                                                                              • "directDebit": {
                                                                                                                                },
                                                                                                                              • "paymentInitiation": {},
                                                                                                                              • "hostedFieldsStatus": "started",
                                                                                                                              • "hostedFieldsToken": "string",
                                                                                                                              • "hostedFieldsTpe": "string",
                                                                                                                              • "hostedFieldsLink": {
                                                                                                                                },
                                                                                                                              • "orderReference": "string"
                                                                                                                              }

                                                                                                                              Liste les transactions sortantes d'un compte marchand

                                                                                                                              Authorizations:
                                                                                                                              x-api-key
                                                                                                                                path Parameters
                                                                                                                                partner
                                                                                                                                required
                                                                                                                                string

                                                                                                                                Code partenaire

                                                                                                                                accountId
                                                                                                                                required
                                                                                                                                string

                                                                                                                                Identifiant de compte marchand

                                                                                                                                query Parameters
                                                                                                                                sortBy
                                                                                                                                string
                                                                                                                                Enum: "id" "debit" "senderAccountId" "comment" "link"

                                                                                                                                Tri

                                                                                                                                orderBy
                                                                                                                                string
                                                                                                                                Enum: "asc" "desc"

                                                                                                                                Direction du tri

                                                                                                                                pageNumber
                                                                                                                                integer <int32> [ 1 .. 2147483647 ]

                                                                                                                                Numéro de page

                                                                                                                                pageSize
                                                                                                                                integer <int32> [ 1 .. 100 ]

                                                                                                                                Taille de la page

                                                                                                                                header Parameters
                                                                                                                                ps-language
                                                                                                                                string
                                                                                                                                Default: fr

                                                                                                                                Langue de retour API

                                                                                                                                x-version
                                                                                                                                string

                                                                                                                                Version de l'API

                                                                                                                                ps-ip-address
                                                                                                                                required
                                                                                                                                string

                                                                                                                                Adresse IP du client final

                                                                                                                                Responses

                                                                                                                                Response samples

                                                                                                                                Content type
                                                                                                                                application/json
                                                                                                                                [
                                                                                                                                • {
                                                                                                                                  }
                                                                                                                                ]

                                                                                                                                Recherche de transactions sortantes

                                                                                                                                Authorizations:
                                                                                                                                x-api-key
                                                                                                                                  path Parameters
                                                                                                                                  partner
                                                                                                                                  required
                                                                                                                                  string

                                                                                                                                  Code partenaire

                                                                                                                                  query Parameters
                                                                                                                                  comment
                                                                                                                                  string

                                                                                                                                  Commentaire de transaction sortante.

                                                                                                                                  sortBy
                                                                                                                                  string
                                                                                                                                  Enum: "id" "debit" "senderAccountId" "comment" "link"

                                                                                                                                  Tri

                                                                                                                                  orderBy
                                                                                                                                  string
                                                                                                                                  Enum: "asc" "desc"

                                                                                                                                  Direction du tri

                                                                                                                                  pageNumber
                                                                                                                                  integer <int32> [ 1 .. 2147483647 ]

                                                                                                                                  Numéro de page

                                                                                                                                  pageSize
                                                                                                                                  integer <int32> [ 1 .. 100 ]

                                                                                                                                  Taille de la page

                                                                                                                                  header Parameters
                                                                                                                                  ps-language
                                                                                                                                  string
                                                                                                                                  Default: fr

                                                                                                                                  Langue de retour API

                                                                                                                                  x-version
                                                                                                                                  string

                                                                                                                                  Version de l'API

                                                                                                                                  ps-ip-address
                                                                                                                                  required
                                                                                                                                  string

                                                                                                                                  Adresse IP du client final

                                                                                                                                  Responses

                                                                                                                                  Response samples

                                                                                                                                  Content type
                                                                                                                                  application/json
                                                                                                                                  [
                                                                                                                                  • {
                                                                                                                                    }
                                                                                                                                  ]

                                                                                                                                  Effectue un virement sortant

                                                                                                                                  Authorizations:
                                                                                                                                  x-api-key
                                                                                                                                    path Parameters
                                                                                                                                    partner
                                                                                                                                    required
                                                                                                                                    string

                                                                                                                                    Code partenaire

                                                                                                                                    accountId
                                                                                                                                    required
                                                                                                                                    string

                                                                                                                                    Identifiant de compte marchand

                                                                                                                                    ibanId
                                                                                                                                    required
                                                                                                                                    integer <int64>

                                                                                                                                    Identifiant d'IBAN

                                                                                                                                    header Parameters
                                                                                                                                    ps-language
                                                                                                                                    string
                                                                                                                                    Default: fr

                                                                                                                                    Langue de retour API

                                                                                                                                    x-version
                                                                                                                                    string

                                                                                                                                    Version de l'API

                                                                                                                                    ps-ip-address
                                                                                                                                    required
                                                                                                                                    string

                                                                                                                                    Adresse IP du client final

                                                                                                                                    Request Body schema: application/json

                                                                                                                                    Corps de méthode

                                                                                                                                    amount
                                                                                                                                    required
                                                                                                                                    number <decimal>

                                                                                                                                    Montant

                                                                                                                                    comment
                                                                                                                                    string [ 0 .. 256 ] characters

                                                                                                                                    Commentaire associé au money-out

                                                                                                                                    Responses

                                                                                                                                    Request samples

                                                                                                                                    Content type
                                                                                                                                    application/json
                                                                                                                                    {
                                                                                                                                    • "amount": 0,
                                                                                                                                    • "comment": "string"
                                                                                                                                    }

                                                                                                                                    Response samples

                                                                                                                                    Content type
                                                                                                                                    application/json
                                                                                                                                    {
                                                                                                                                    • "id": 0,
                                                                                                                                    • "date": "2019-08-24T14:15:22Z",
                                                                                                                                    • "debit": 0,
                                                                                                                                    • "credit": 0,
                                                                                                                                    • "comment": "string",
                                                                                                                                    • "senderAccountId": "string",
                                                                                                                                    • "receiverAccountId": "string",
                                                                                                                                    • "code": "string",
                                                                                                                                    • "message": "string",
                                                                                                                                    • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                    • "status": "complete",
                                                                                                                                    • "card": {
                                                                                                                                      },
                                                                                                                                    • "errorMessage": "string",
                                                                                                                                    • "type": "moneyIn",
                                                                                                                                    • "method": "card",
                                                                                                                                    • "iban": {
                                                                                                                                      },
                                                                                                                                    • "pspToken": "string",
                                                                                                                                    • "transferReference": "string",
                                                                                                                                    • "link": 0,
                                                                                                                                    • "p2pIds": [
                                                                                                                                      ],
                                                                                                                                    • "archivingKey": "string",
                                                                                                                                    • "eventPaymentType": "purchase",
                                                                                                                                    • "authorizationCode": "string",
                                                                                                                                    • "clientFirstName": "string",
                                                                                                                                    • "clientLastName": "string",
                                                                                                                                    • "companyName": "string",
                                                                                                                                    • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                    • "creditorIBAN": "string",
                                                                                                                                    • "directDebit": {
                                                                                                                                      },
                                                                                                                                    • "paymentInitiation": {},
                                                                                                                                    • "hostedFieldsStatus": "started",
                                                                                                                                    • "hostedFieldsToken": "string",
                                                                                                                                    • "hostedFieldsTpe": "string",
                                                                                                                                    • "hostedFieldsLink": {
                                                                                                                                      },
                                                                                                                                    • "orderReference": "string"
                                                                                                                                    }

                                                                                                                                    P2Ps

                                                                                                                                    Liste les P2P

                                                                                                                                    Authorizations:
                                                                                                                                    x-api-key
                                                                                                                                      path Parameters
                                                                                                                                      partner
                                                                                                                                      required
                                                                                                                                      string

                                                                                                                                      Code partenaire

                                                                                                                                      query Parameters
                                                                                                                                      datedeb
                                                                                                                                      string <date-time>

                                                                                                                                      Date de début (P2P)

                                                                                                                                      datefin
                                                                                                                                      string <date-time>

                                                                                                                                      Date de fin (P2P)

                                                                                                                                      sortBy
                                                                                                                                      string
                                                                                                                                      Enum: "id" "date" "originId" "debit" "credit" "comment" "senderAccountId" "receiverAccountId"

                                                                                                                                      Tri

                                                                                                                                      orderBy
                                                                                                                                      string
                                                                                                                                      Enum: "asc" "desc"

                                                                                                                                      Direction du tri

                                                                                                                                      pageNumber
                                                                                                                                      integer <int32> [ 1 .. 2147483647 ]

                                                                                                                                      Numéro de page

                                                                                                                                      pageSize
                                                                                                                                      integer <int32> [ 1 .. 100 ]

                                                                                                                                      Taille de la page

                                                                                                                                      header Parameters
                                                                                                                                      ps-language
                                                                                                                                      string
                                                                                                                                      Default: fr

                                                                                                                                      Langue de retour API

                                                                                                                                      x-version
                                                                                                                                      string

                                                                                                                                      Version de l'API

                                                                                                                                      ps-ip-address
                                                                                                                                      required
                                                                                                                                      string

                                                                                                                                      Adresse IP du client final

                                                                                                                                      Responses

                                                                                                                                      Response samples

                                                                                                                                      Content type
                                                                                                                                      application/json
                                                                                                                                      [
                                                                                                                                      • {
                                                                                                                                        }
                                                                                                                                      ]

                                                                                                                                      Affiche un P2P

                                                                                                                                      Authorizations:
                                                                                                                                      x-api-key
                                                                                                                                        path Parameters
                                                                                                                                        partner
                                                                                                                                        required
                                                                                                                                        string

                                                                                                                                        Code partenaire

                                                                                                                                        p2PId
                                                                                                                                        required
                                                                                                                                        integer <int64>

                                                                                                                                        Identifiant de P2P

                                                                                                                                        header Parameters
                                                                                                                                        ps-language
                                                                                                                                        string
                                                                                                                                        Default: fr

                                                                                                                                        Langue de retour API

                                                                                                                                        x-version
                                                                                                                                        string

                                                                                                                                        Version de l'API

                                                                                                                                        ps-ip-address
                                                                                                                                        required
                                                                                                                                        string

                                                                                                                                        Adresse IP du client final

                                                                                                                                        Responses

                                                                                                                                        Response samples

                                                                                                                                        Content type
                                                                                                                                        application/json
                                                                                                                                        {
                                                                                                                                        • "id": 0,
                                                                                                                                        • "date": "2019-08-24T14:15:22Z",
                                                                                                                                        • "debit": 0,
                                                                                                                                        • "credit": 0,
                                                                                                                                        • "comment": "string",
                                                                                                                                        • "senderAccountId": "string",
                                                                                                                                        • "receiverAccountId": "string",
                                                                                                                                        • "code": "string",
                                                                                                                                        • "message": "string",
                                                                                                                                        • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                        • "status": "expired",
                                                                                                                                        • "originId": 0,
                                                                                                                                        • "p2PType": "unknown",
                                                                                                                                        • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                        • "p2PParentId": 0
                                                                                                                                        }

                                                                                                                                        Liste les P2P d'une transaction entrante

                                                                                                                                        Authorizations:
                                                                                                                                        x-api-key
                                                                                                                                          path Parameters
                                                                                                                                          partner
                                                                                                                                          required
                                                                                                                                          string

                                                                                                                                          Code partenaire

                                                                                                                                          transactionId
                                                                                                                                          required
                                                                                                                                          integer <int64>

                                                                                                                                          Identifiant de transaction entrante

                                                                                                                                          query Parameters
                                                                                                                                          datedeb
                                                                                                                                          string <date-time>

                                                                                                                                          Date de début (P2P)

                                                                                                                                          datefin
                                                                                                                                          string <date-time>

                                                                                                                                          Date de fin (P2P)

                                                                                                                                          sortBy
                                                                                                                                          string
                                                                                                                                          Enum: "id" "date" "originId" "debit" "credit" "comment" "senderAccountId" "receiverAccountId"

                                                                                                                                          Tri

                                                                                                                                          orderBy
                                                                                                                                          string
                                                                                                                                          Enum: "asc" "desc"

                                                                                                                                          Direction du tri

                                                                                                                                          pageNumber
                                                                                                                                          integer <int32> [ 1 .. 2147483647 ]

                                                                                                                                          Numéro de page

                                                                                                                                          pageSize
                                                                                                                                          integer <int32> [ 1 .. 100 ]

                                                                                                                                          Taille de la page

                                                                                                                                          header Parameters
                                                                                                                                          ps-language
                                                                                                                                          string
                                                                                                                                          Default: fr

                                                                                                                                          Langue de retour API

                                                                                                                                          x-version
                                                                                                                                          string

                                                                                                                                          Version de l'API

                                                                                                                                          ps-ip-address
                                                                                                                                          required
                                                                                                                                          string

                                                                                                                                          Adresse IP du client final

                                                                                                                                          Responses

                                                                                                                                          Response samples

                                                                                                                                          Content type
                                                                                                                                          application/json
                                                                                                                                          [
                                                                                                                                          • {
                                                                                                                                            }
                                                                                                                                          ]

                                                                                                                                          Affiche un P2P d'une transaction entrante

                                                                                                                                          Authorizations:
                                                                                                                                          x-api-key
                                                                                                                                            path Parameters
                                                                                                                                            partner
                                                                                                                                            required
                                                                                                                                            string

                                                                                                                                            Code partenaire

                                                                                                                                            transactionId
                                                                                                                                            required
                                                                                                                                            integer <int64>

                                                                                                                                            Identifiant de transaction entrante

                                                                                                                                            p2PId
                                                                                                                                            required
                                                                                                                                            integer <int64>

                                                                                                                                            Identifiant de P2P

                                                                                                                                            header Parameters
                                                                                                                                            ps-language
                                                                                                                                            string
                                                                                                                                            Default: fr

                                                                                                                                            Langue de retour API

                                                                                                                                            x-version
                                                                                                                                            string

                                                                                                                                            Version de l'API

                                                                                                                                            ps-ip-address
                                                                                                                                            required
                                                                                                                                            string

                                                                                                                                            Adresse IP du client final

                                                                                                                                            Responses

                                                                                                                                            Response samples

                                                                                                                                            Content type
                                                                                                                                            application/json
                                                                                                                                            {
                                                                                                                                            • "id": 0,
                                                                                                                                            • "date": "2019-08-24T14:15:22Z",
                                                                                                                                            • "debit": 0,
                                                                                                                                            • "credit": 0,
                                                                                                                                            • "comment": "string",
                                                                                                                                            • "senderAccountId": "string",
                                                                                                                                            • "receiverAccountId": "string",
                                                                                                                                            • "code": "string",
                                                                                                                                            • "message": "string",
                                                                                                                                            • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                            • "status": "expired",
                                                                                                                                            • "originId": 0,
                                                                                                                                            • "p2PType": "unknown",
                                                                                                                                            • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                            • "p2PParentId": 0
                                                                                                                                            }

                                                                                                                                            Liste les P2P d'un remboursement

                                                                                                                                            Authorizations:
                                                                                                                                            x-api-key
                                                                                                                                              path Parameters
                                                                                                                                              partner
                                                                                                                                              required
                                                                                                                                              string

                                                                                                                                              Code partenaire

                                                                                                                                              transactionId
                                                                                                                                              required
                                                                                                                                              integer <int64>

                                                                                                                                              Identifiant de remboursement

                                                                                                                                              query Parameters
                                                                                                                                              datedeb
                                                                                                                                              string <date-time>

                                                                                                                                              Date de début (P2P)

                                                                                                                                              datefin
                                                                                                                                              string <date-time>

                                                                                                                                              Date de fin (P2P)

                                                                                                                                              sortBy
                                                                                                                                              string
                                                                                                                                              Enum: "id" "date" "originId" "debit" "credit" "comment" "senderAccountId" "receiverAccountId"

                                                                                                                                              Tri

                                                                                                                                              orderBy
                                                                                                                                              string
                                                                                                                                              Enum: "asc" "desc"

                                                                                                                                              Direction du tri

                                                                                                                                              pageNumber
                                                                                                                                              integer <int32> [ 1 .. 2147483647 ]

                                                                                                                                              Numéro de page

                                                                                                                                              pageSize
                                                                                                                                              integer <int32> [ 1 .. 100 ]

                                                                                                                                              Taille de la page

                                                                                                                                              header Parameters
                                                                                                                                              ps-language
                                                                                                                                              string
                                                                                                                                              Default: fr

                                                                                                                                              Langue de retour API

                                                                                                                                              x-version
                                                                                                                                              string

                                                                                                                                              Version de l'API

                                                                                                                                              ps-ip-address
                                                                                                                                              required
                                                                                                                                              string

                                                                                                                                              Adresse IP du client final

                                                                                                                                              Responses

                                                                                                                                              Response samples

                                                                                                                                              Content type
                                                                                                                                              application/json
                                                                                                                                              [
                                                                                                                                              • {
                                                                                                                                                }
                                                                                                                                              ]

                                                                                                                                              Affiche un P2P d'un remboursement

                                                                                                                                              Authorizations:
                                                                                                                                              x-api-key
                                                                                                                                                path Parameters
                                                                                                                                                partner
                                                                                                                                                required
                                                                                                                                                string

                                                                                                                                                Code partenaire

                                                                                                                                                transactionId
                                                                                                                                                required
                                                                                                                                                integer <int64>

                                                                                                                                                Identifiant de transaction entrante

                                                                                                                                                p2PId
                                                                                                                                                required
                                                                                                                                                integer <int64>

                                                                                                                                                Identifiant de P2P

                                                                                                                                                header Parameters
                                                                                                                                                ps-language
                                                                                                                                                string
                                                                                                                                                Default: fr

                                                                                                                                                Langue de retour API

                                                                                                                                                x-version
                                                                                                                                                string

                                                                                                                                                Version de l'API

                                                                                                                                                ps-ip-address
                                                                                                                                                required
                                                                                                                                                string

                                                                                                                                                Adresse IP du client final

                                                                                                                                                Responses

                                                                                                                                                Response samples

                                                                                                                                                Content type
                                                                                                                                                application/json
                                                                                                                                                {
                                                                                                                                                • "id": 0,
                                                                                                                                                • "date": "2019-08-24T14:15:22Z",
                                                                                                                                                • "debit": 0,
                                                                                                                                                • "credit": 0,
                                                                                                                                                • "comment": "string",
                                                                                                                                                • "senderAccountId": "string",
                                                                                                                                                • "receiverAccountId": "string",
                                                                                                                                                • "code": "string",
                                                                                                                                                • "message": "string",
                                                                                                                                                • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                                • "status": "expired",
                                                                                                                                                • "originId": 0,
                                                                                                                                                • "p2PType": "unknown",
                                                                                                                                                • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                                • "p2PParentId": 0
                                                                                                                                                }

                                                                                                                                                Liste les P2P d'un chargeback

                                                                                                                                                Fonctionnalité requise : PaymentCard, PaymentCardInStore

                                                                                                                                                Authorizations:
                                                                                                                                                x-api-key
                                                                                                                                                  path Parameters
                                                                                                                                                  partner
                                                                                                                                                  required
                                                                                                                                                  string

                                                                                                                                                  Code partenaire

                                                                                                                                                  chargebackId
                                                                                                                                                  required
                                                                                                                                                  integer <int64>

                                                                                                                                                  Identifiant de chargeback

                                                                                                                                                  query Parameters
                                                                                                                                                  datedeb
                                                                                                                                                  string <date-time>

                                                                                                                                                  Date de début (P2P)

                                                                                                                                                  datefin
                                                                                                                                                  string <date-time>

                                                                                                                                                  Date de fin (P2P)

                                                                                                                                                  sortBy
                                                                                                                                                  string
                                                                                                                                                  Enum: "id" "date" "originId" "debit" "credit" "comment" "senderAccountId" "receiverAccountId"

                                                                                                                                                  Tri

                                                                                                                                                  orderBy
                                                                                                                                                  string
                                                                                                                                                  Enum: "asc" "desc"

                                                                                                                                                  Direction du tri

                                                                                                                                                  pageNumber
                                                                                                                                                  integer <int32> [ 1 .. 2147483647 ]

                                                                                                                                                  Numéro de page

                                                                                                                                                  pageSize
                                                                                                                                                  integer <int32> [ 1 .. 100 ]

                                                                                                                                                  Taille de la page

                                                                                                                                                  header Parameters
                                                                                                                                                  ps-language
                                                                                                                                                  string
                                                                                                                                                  Default: fr

                                                                                                                                                  Langue de retour API

                                                                                                                                                  x-version
                                                                                                                                                  string

                                                                                                                                                  Version de l'API

                                                                                                                                                  ps-ip-address
                                                                                                                                                  required
                                                                                                                                                  string

                                                                                                                                                  Adresse IP du client final

                                                                                                                                                  Responses

                                                                                                                                                  Response samples

                                                                                                                                                  Content type
                                                                                                                                                  application/json
                                                                                                                                                  [
                                                                                                                                                  • {
                                                                                                                                                    }
                                                                                                                                                  ]

                                                                                                                                                  Affiche un P2P d'un chargeback

                                                                                                                                                  Fonctionnalité requise : PaymentCard, PaymentCardInStore

                                                                                                                                                  Authorizations:
                                                                                                                                                  x-api-key
                                                                                                                                                    path Parameters
                                                                                                                                                    partner
                                                                                                                                                    required
                                                                                                                                                    string

                                                                                                                                                    Code partenaire

                                                                                                                                                    transactionId
                                                                                                                                                    required
                                                                                                                                                    integer <int64>

                                                                                                                                                    Identifiant de transaction entrante

                                                                                                                                                    p2PId
                                                                                                                                                    required
                                                                                                                                                    integer <int64>

                                                                                                                                                    Identifiant de P2P

                                                                                                                                                    header Parameters
                                                                                                                                                    ps-language
                                                                                                                                                    string
                                                                                                                                                    Default: fr

                                                                                                                                                    Langue de retour API

                                                                                                                                                    x-version
                                                                                                                                                    string

                                                                                                                                                    Version de l'API

                                                                                                                                                    ps-ip-address
                                                                                                                                                    required
                                                                                                                                                    string

                                                                                                                                                    Adresse IP du client final

                                                                                                                                                    Responses

                                                                                                                                                    Response samples

                                                                                                                                                    Content type
                                                                                                                                                    application/json
                                                                                                                                                    {
                                                                                                                                                    • "id": 0,
                                                                                                                                                    • "date": "2019-08-24T14:15:22Z",
                                                                                                                                                    • "debit": 0,
                                                                                                                                                    • "credit": 0,
                                                                                                                                                    • "comment": "string",
                                                                                                                                                    • "senderAccountId": "string",
                                                                                                                                                    • "receiverAccountId": "string",
                                                                                                                                                    • "code": "string",
                                                                                                                                                    • "message": "string",
                                                                                                                                                    • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                                    • "status": "expired",
                                                                                                                                                    • "originId": 0,
                                                                                                                                                    • "p2PType": "unknown",
                                                                                                                                                    • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                                    • "p2PParentId": 0
                                                                                                                                                    }

                                                                                                                                                    Liste les transactions internes d'un compte marchand

                                                                                                                                                    Authorizations:
                                                                                                                                                    x-api-key
                                                                                                                                                      path Parameters
                                                                                                                                                      partner
                                                                                                                                                      required
                                                                                                                                                      string

                                                                                                                                                      Code partenaire

                                                                                                                                                      accountId
                                                                                                                                                      required
                                                                                                                                                      string

                                                                                                                                                      Identifiant de compte marchand

                                                                                                                                                      query Parameters
                                                                                                                                                      datedeb
                                                                                                                                                      string <date-time>

                                                                                                                                                      Date de début (P2P)

                                                                                                                                                      datefin
                                                                                                                                                      string <date-time>

                                                                                                                                                      Date de fin (P2P)

                                                                                                                                                      sortBy
                                                                                                                                                      string
                                                                                                                                                      Enum: "id" "date" "originId" "debit" "credit" "comment" "senderAccountId" "receiverAccountId"

                                                                                                                                                      Tri

                                                                                                                                                      orderBy
                                                                                                                                                      string
                                                                                                                                                      Enum: "asc" "desc"

                                                                                                                                                      Direction du tri

                                                                                                                                                      pageNumber
                                                                                                                                                      integer <int32> [ 1 .. 2147483647 ]

                                                                                                                                                      Numéro de page

                                                                                                                                                      pageSize
                                                                                                                                                      integer <int32> [ 1 .. 100 ]

                                                                                                                                                      Taille de la page

                                                                                                                                                      header Parameters
                                                                                                                                                      ps-language
                                                                                                                                                      string
                                                                                                                                                      Default: fr

                                                                                                                                                      Langue de retour API

                                                                                                                                                      x-version
                                                                                                                                                      string

                                                                                                                                                      Version de l'API

                                                                                                                                                      ps-ip-address
                                                                                                                                                      required
                                                                                                                                                      string

                                                                                                                                                      Adresse IP du client final

                                                                                                                                                      Responses

                                                                                                                                                      Response samples

                                                                                                                                                      Content type
                                                                                                                                                      application/json
                                                                                                                                                      [
                                                                                                                                                      • {
                                                                                                                                                        }
                                                                                                                                                      ]

                                                                                                                                                      Affiche une transaction interne d'un compte marchand

                                                                                                                                                      Authorizations:
                                                                                                                                                      x-api-key
                                                                                                                                                        path Parameters
                                                                                                                                                        partner
                                                                                                                                                        required
                                                                                                                                                        string

                                                                                                                                                        Code partenaire

                                                                                                                                                        accountId
                                                                                                                                                        required
                                                                                                                                                        string

                                                                                                                                                        Identifiant de compte marchand

                                                                                                                                                        p2PId
                                                                                                                                                        required
                                                                                                                                                        integer <int64>

                                                                                                                                                        Identifiant de P2P

                                                                                                                                                        header Parameters
                                                                                                                                                        ps-language
                                                                                                                                                        string
                                                                                                                                                        Default: fr

                                                                                                                                                        Langue de retour API

                                                                                                                                                        x-version
                                                                                                                                                        string

                                                                                                                                                        Version de l'API

                                                                                                                                                        ps-ip-address
                                                                                                                                                        required
                                                                                                                                                        string

                                                                                                                                                        Adresse IP du client final

                                                                                                                                                        Responses

                                                                                                                                                        Response samples

                                                                                                                                                        Content type
                                                                                                                                                        application/json
                                                                                                                                                        [
                                                                                                                                                        • {
                                                                                                                                                          }
                                                                                                                                                        ]

                                                                                                                                                        Crée une commission sur un compte marchand

                                                                                                                                                        Authorizations:
                                                                                                                                                        x-api-key
                                                                                                                                                          path Parameters
                                                                                                                                                          partner
                                                                                                                                                          required
                                                                                                                                                          string

                                                                                                                                                          Code partenaire

                                                                                                                                                          transactionId
                                                                                                                                                          required
                                                                                                                                                          integer <int64>

                                                                                                                                                          Identifiant de transaction entrante

                                                                                                                                                          p2PId
                                                                                                                                                          required
                                                                                                                                                          integer <int64>

                                                                                                                                                          Identifiant du p2p rattaché à la transaction entrante

                                                                                                                                                          header Parameters
                                                                                                                                                          ps-language
                                                                                                                                                          string
                                                                                                                                                          Default: fr

                                                                                                                                                          Langue de retour API

                                                                                                                                                          x-version
                                                                                                                                                          string

                                                                                                                                                          Version de l'API

                                                                                                                                                          ps-ip-address
                                                                                                                                                          required
                                                                                                                                                          string

                                                                                                                                                          Adresse IP du client final

                                                                                                                                                          Request Body schema: application/json

                                                                                                                                                          Corps de méthode

                                                                                                                                                          accountId
                                                                                                                                                          required
                                                                                                                                                          string non-empty

                                                                                                                                                          Identifiant du compte de paiement à débiter

                                                                                                                                                          amount
                                                                                                                                                          required
                                                                                                                                                          number <decimal>

                                                                                                                                                          Montant à recouvrer

                                                                                                                                                          Responses

                                                                                                                                                          Request samples

                                                                                                                                                          Content type
                                                                                                                                                          application/json
                                                                                                                                                          {
                                                                                                                                                          • "accountId": "string",
                                                                                                                                                          • "amount": 0
                                                                                                                                                          }

                                                                                                                                                          Response samples

                                                                                                                                                          Content type
                                                                                                                                                          application/json
                                                                                                                                                          {
                                                                                                                                                          • "id": 0,
                                                                                                                                                          • "date": "2019-08-24T14:15:22Z",
                                                                                                                                                          • "debit": 0,
                                                                                                                                                          • "credit": 0,
                                                                                                                                                          • "comment": "string",
                                                                                                                                                          • "senderAccountId": "string",
                                                                                                                                                          • "receiverAccountId": "string",
                                                                                                                                                          • "code": "string",
                                                                                                                                                          • "message": "string",
                                                                                                                                                          • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                                          • "status": "expired",
                                                                                                                                                          • "originId": 0,
                                                                                                                                                          • "p2PType": "unknown",
                                                                                                                                                          • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                                          • "p2PParentId": 0
                                                                                                                                                          }

                                                                                                                                                          Crée une commission entre comptes marchands

                                                                                                                                                          Fonctionnalité requise : PaymentCard, PaymentCardInStore, PaymentTransfer, PaymentDirectDebit, PaymentInitiation

                                                                                                                                                          Authorizations:
                                                                                                                                                          x-api-key
                                                                                                                                                            path Parameters
                                                                                                                                                            partner
                                                                                                                                                            required
                                                                                                                                                            string

                                                                                                                                                            Code partenaire

                                                                                                                                                            transactionId
                                                                                                                                                            required
                                                                                                                                                            integer <int64>

                                                                                                                                                            Identifiant de transaction entrante

                                                                                                                                                            header Parameters
                                                                                                                                                            ps-language
                                                                                                                                                            string
                                                                                                                                                            Default: fr

                                                                                                                                                            Langue de retour API

                                                                                                                                                            x-version
                                                                                                                                                            string

                                                                                                                                                            Version de l'API

                                                                                                                                                            ps-ip-address
                                                                                                                                                            required
                                                                                                                                                            string

                                                                                                                                                            Adresse IP du client final

                                                                                                                                                            Request Body schema: application/json

                                                                                                                                                            Corps de méthode

                                                                                                                                                            debtorAccountId
                                                                                                                                                            required
                                                                                                                                                            string non-empty

                                                                                                                                                            Identifiant du compte de paiement à débiter

                                                                                                                                                            creditorAccountId
                                                                                                                                                            required
                                                                                                                                                            string non-empty

                                                                                                                                                            Identifiant du compte de paiement à créditer

                                                                                                                                                            ventilationId
                                                                                                                                                            required
                                                                                                                                                            integer <int64>

                                                                                                                                                            Identifiant du P2P de ventilation (spécifique dans le cas d'une commission inter marchand)

                                                                                                                                                            amount
                                                                                                                                                            required
                                                                                                                                                            number <decimal>

                                                                                                                                                            Montant à recouvrer

                                                                                                                                                            Responses

                                                                                                                                                            Request samples

                                                                                                                                                            Content type
                                                                                                                                                            application/json
                                                                                                                                                            {
                                                                                                                                                            • "debtorAccountId": "string",
                                                                                                                                                            • "creditorAccountId": "string",
                                                                                                                                                            • "ventilationId": 0,
                                                                                                                                                            • "amount": 0
                                                                                                                                                            }

                                                                                                                                                            Response samples

                                                                                                                                                            Content type
                                                                                                                                                            application/json
                                                                                                                                                            {
                                                                                                                                                            • "id": 0,
                                                                                                                                                            • "date": "2019-08-24T14:15:22Z",
                                                                                                                                                            • "debit": 0,
                                                                                                                                                            • "credit": 0,
                                                                                                                                                            • "comment": "string",
                                                                                                                                                            • "senderAccountId": "string",
                                                                                                                                                            • "receiverAccountId": "string",
                                                                                                                                                            • "code": "string",
                                                                                                                                                            • "message": "string",
                                                                                                                                                            • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                                            • "status": "expired",
                                                                                                                                                            • "originId": 0,
                                                                                                                                                            • "p2PType": "unknown",
                                                                                                                                                            • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                                            • "p2PParentId": 0
                                                                                                                                                            }

                                                                                                                                                            Crée un abondement du partenaire vers le marchand

                                                                                                                                                            Fonctionnalité requise : Contribution

                                                                                                                                                            Authorizations:
                                                                                                                                                            x-api-key
                                                                                                                                                              path Parameters
                                                                                                                                                              partner
                                                                                                                                                              required
                                                                                                                                                              string

                                                                                                                                                              Le code partenaire

                                                                                                                                                              header Parameters
                                                                                                                                                              ps-language
                                                                                                                                                              string
                                                                                                                                                              Default: fr

                                                                                                                                                              Langue de retour API

                                                                                                                                                              x-version
                                                                                                                                                              string

                                                                                                                                                              Version de l'API

                                                                                                                                                              ps-ip-address
                                                                                                                                                              required
                                                                                                                                                              string

                                                                                                                                                              Adresse IP du client final

                                                                                                                                                              Request Body schema: application/json

                                                                                                                                                              Corps de la méthode

                                                                                                                                                              transactionId
                                                                                                                                                              integer <int64>

                                                                                                                                                              L'id du moneyIn liée à l'abondement

                                                                                                                                                              accountId
                                                                                                                                                              required
                                                                                                                                                              string non-empty

                                                                                                                                                              L'id du marchand destinataire de l'abondement

                                                                                                                                                              amount
                                                                                                                                                              required
                                                                                                                                                              number <decimal>

                                                                                                                                                              Le montant de l'abondement

                                                                                                                                                              comment
                                                                                                                                                              string

                                                                                                                                                              Le commentaire du P2P

                                                                                                                                                              Responses

                                                                                                                                                              Request samples

                                                                                                                                                              Content type
                                                                                                                                                              application/json
                                                                                                                                                              {
                                                                                                                                                              • "transactionId": 0,
                                                                                                                                                              • "accountId": "string",
                                                                                                                                                              • "amount": 0,
                                                                                                                                                              • "comment": "string"
                                                                                                                                                              }

                                                                                                                                                              Response samples

                                                                                                                                                              Content type
                                                                                                                                                              application/json
                                                                                                                                                              {
                                                                                                                                                              • "id": 0,
                                                                                                                                                              • "date": "2019-08-24T14:15:22Z",
                                                                                                                                                              • "debit": 0,
                                                                                                                                                              • "credit": 0,
                                                                                                                                                              • "comment": "string",
                                                                                                                                                              • "senderAccountId": "string",
                                                                                                                                                              • "receiverAccountId": "string",
                                                                                                                                                              • "code": "string",
                                                                                                                                                              • "message": "string",
                                                                                                                                                              • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                                              • "status": "expired",
                                                                                                                                                              • "originId": 0,
                                                                                                                                                              • "p2PType": "unknown",
                                                                                                                                                              • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                                              • "p2PParentId": 0
                                                                                                                                                              }

                                                                                                                                                              Crée un remboursement d’abondement du marchand vers le partenaire

                                                                                                                                                              Fonctionnalité requise : Contribution

                                                                                                                                                              Authorizations:
                                                                                                                                                              x-api-key
                                                                                                                                                                path Parameters
                                                                                                                                                                partner
                                                                                                                                                                required
                                                                                                                                                                string

                                                                                                                                                                Le code partenaire

                                                                                                                                                                p2pId
                                                                                                                                                                required
                                                                                                                                                                integer <int64>

                                                                                                                                                                L'identifiant du P2P ciblant l'abondement à rembourser

                                                                                                                                                                header Parameters
                                                                                                                                                                ps-language
                                                                                                                                                                string
                                                                                                                                                                Default: fr

                                                                                                                                                                Langue de retour API

                                                                                                                                                                x-version
                                                                                                                                                                string

                                                                                                                                                                Version de l'API

                                                                                                                                                                ps-ip-address
                                                                                                                                                                required
                                                                                                                                                                string

                                                                                                                                                                Adresse IP du client final

                                                                                                                                                                Request Body schema: application/json

                                                                                                                                                                Corps de la méthode

                                                                                                                                                                amount
                                                                                                                                                                required
                                                                                                                                                                number <decimal>

                                                                                                                                                                Le montant de l'abondement

                                                                                                                                                                comment
                                                                                                                                                                string

                                                                                                                                                                Le commentaire du remboursement du P2P

                                                                                                                                                                Responses

                                                                                                                                                                Request samples

                                                                                                                                                                Content type
                                                                                                                                                                application/json
                                                                                                                                                                {
                                                                                                                                                                • "amount": 0,
                                                                                                                                                                • "comment": "string"
                                                                                                                                                                }

                                                                                                                                                                Response samples

                                                                                                                                                                Content type
                                                                                                                                                                application/json
                                                                                                                                                                {
                                                                                                                                                                • "id": 0,
                                                                                                                                                                • "date": "2019-08-24T14:15:22Z",
                                                                                                                                                                • "debit": 0,
                                                                                                                                                                • "credit": 0,
                                                                                                                                                                • "comment": "string",
                                                                                                                                                                • "senderAccountId": "string",
                                                                                                                                                                • "receiverAccountId": "string",
                                                                                                                                                                • "code": "string",
                                                                                                                                                                • "message": "string",
                                                                                                                                                                • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                                                • "status": "expired",
                                                                                                                                                                • "originId": 0,
                                                                                                                                                                • "p2PType": "unknown",
                                                                                                                                                                • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                                                • "p2PParentId": 0
                                                                                                                                                                }

                                                                                                                                                                Valide un P2P en attente rattaché à une transaction entrante

                                                                                                                                                                Authorizations:
                                                                                                                                                                x-api-key
                                                                                                                                                                  path Parameters
                                                                                                                                                                  partner
                                                                                                                                                                  required
                                                                                                                                                                  string

                                                                                                                                                                  Code partenaire

                                                                                                                                                                  transactionId
                                                                                                                                                                  required
                                                                                                                                                                  integer <int64>

                                                                                                                                                                  Identifiant de transaction entrante

                                                                                                                                                                  p2PId
                                                                                                                                                                  required
                                                                                                                                                                  integer <int64>

                                                                                                                                                                  Identifiant de P2P

                                                                                                                                                                  header Parameters
                                                                                                                                                                  ps-language
                                                                                                                                                                  string
                                                                                                                                                                  Default: fr

                                                                                                                                                                  Langue de retour API

                                                                                                                                                                  x-version
                                                                                                                                                                  string

                                                                                                                                                                  Version de l'API

                                                                                                                                                                  ps-ip-address
                                                                                                                                                                  required
                                                                                                                                                                  string

                                                                                                                                                                  Adresse IP du client final

                                                                                                                                                                  Request Body schema: application/json

                                                                                                                                                                  Corps de méthode

                                                                                                                                                                  comment
                                                                                                                                                                  string [ 0 .. 256 ] characters

                                                                                                                                                                  Commentaire associé à la transaction interne

                                                                                                                                                                  Responses

                                                                                                                                                                  Request samples

                                                                                                                                                                  Content type
                                                                                                                                                                  application/json
                                                                                                                                                                  {
                                                                                                                                                                  • "comment": "string"
                                                                                                                                                                  }

                                                                                                                                                                  Response samples

                                                                                                                                                                  Content type
                                                                                                                                                                  application/json
                                                                                                                                                                  {
                                                                                                                                                                  • "message": "string",
                                                                                                                                                                  • "code": "p2PStatusAlreadyComplete",
                                                                                                                                                                  • "errorToken": "string"
                                                                                                                                                                  }

                                                                                                                                                                  Valide un P2P en attente rattaché à un remboursement

                                                                                                                                                                  Authorizations:
                                                                                                                                                                  x-api-key
                                                                                                                                                                    path Parameters
                                                                                                                                                                    partner
                                                                                                                                                                    required
                                                                                                                                                                    string

                                                                                                                                                                    Code partenaire

                                                                                                                                                                    transactionId
                                                                                                                                                                    required
                                                                                                                                                                    integer <int64>

                                                                                                                                                                    Identifiant de remboursement

                                                                                                                                                                    p2PId
                                                                                                                                                                    required
                                                                                                                                                                    integer <int64>

                                                                                                                                                                    Identifiant de P2P

                                                                                                                                                                    header Parameters
                                                                                                                                                                    ps-language
                                                                                                                                                                    string
                                                                                                                                                                    Default: fr

                                                                                                                                                                    Langue de retour API

                                                                                                                                                                    x-version
                                                                                                                                                                    string

                                                                                                                                                                    Version de l'API

                                                                                                                                                                    ps-ip-address
                                                                                                                                                                    required
                                                                                                                                                                    string

                                                                                                                                                                    Adresse IP du client final

                                                                                                                                                                    Request Body schema: application/json

                                                                                                                                                                    Corps de méthode

                                                                                                                                                                    comment
                                                                                                                                                                    string [ 0 .. 256 ] characters

                                                                                                                                                                    Commentaire associé à la transaction interne

                                                                                                                                                                    Responses

                                                                                                                                                                    Request samples

                                                                                                                                                                    Content type
                                                                                                                                                                    application/json
                                                                                                                                                                    {
                                                                                                                                                                    • "comment": "string"
                                                                                                                                                                    }

                                                                                                                                                                    Response samples

                                                                                                                                                                    Content type
                                                                                                                                                                    application/json
                                                                                                                                                                    {
                                                                                                                                                                    • "message": "string",
                                                                                                                                                                    • "code": "p2PStatusAlreadyComplete",
                                                                                                                                                                    • "errorToken": "string"
                                                                                                                                                                    }

                                                                                                                                                                    Crée un remboursement d'une commission sur un compte marchand.

                                                                                                                                                                    Authorizations:
                                                                                                                                                                    x-api-key
                                                                                                                                                                      path Parameters
                                                                                                                                                                      partner
                                                                                                                                                                      required
                                                                                                                                                                      string

                                                                                                                                                                      Code partenaire

                                                                                                                                                                      p2PId
                                                                                                                                                                      required
                                                                                                                                                                      integer <int64>

                                                                                                                                                                      Identifiant de la commission à rembourser

                                                                                                                                                                      header Parameters
                                                                                                                                                                      ps-language
                                                                                                                                                                      string
                                                                                                                                                                      Default: fr

                                                                                                                                                                      Langue de retour API

                                                                                                                                                                      x-version
                                                                                                                                                                      string

                                                                                                                                                                      Version de l'API

                                                                                                                                                                      ps-ip-address
                                                                                                                                                                      required
                                                                                                                                                                      string

                                                                                                                                                                      Adresse IP du client final

                                                                                                                                                                      Request Body schema: application/json

                                                                                                                                                                      Détails du remboursement demandé

                                                                                                                                                                      amount
                                                                                                                                                                      required
                                                                                                                                                                      number <decimal>

                                                                                                                                                                      Montant du remboursement à effectuer. Ce montant doit être inférieur au total restant à rembourser. (montant de la commission moins montant des remboursements déjà effectués) Ce montant doit êter inférieur au solde du compte

                                                                                                                                                                      comment
                                                                                                                                                                      string

                                                                                                                                                                      Commentaire optionnel pour le remboursement de la commission.

                                                                                                                                                                      Responses

                                                                                                                                                                      Request samples

                                                                                                                                                                      Content type
                                                                                                                                                                      application/json
                                                                                                                                                                      {
                                                                                                                                                                      • "amount": 0,
                                                                                                                                                                      • "comment": "string"
                                                                                                                                                                      }

                                                                                                                                                                      Response samples

                                                                                                                                                                      Content type
                                                                                                                                                                      application/json
                                                                                                                                                                      {
                                                                                                                                                                      • "id": 0,
                                                                                                                                                                      • "date": "2019-08-24T14:15:22Z",
                                                                                                                                                                      • "debit": 0,
                                                                                                                                                                      • "credit": 0,
                                                                                                                                                                      • "comment": "string",
                                                                                                                                                                      • "senderAccountId": "string",
                                                                                                                                                                      • "receiverAccountId": "string",
                                                                                                                                                                      • "code": "string",
                                                                                                                                                                      • "message": "string",
                                                                                                                                                                      • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                                                      • "status": "expired",
                                                                                                                                                                      • "originId": 0,
                                                                                                                                                                      • "p2PType": "unknown",
                                                                                                                                                                      • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                                                      • "p2PParentId": 0
                                                                                                                                                                      }

                                                                                                                                                                      Refunds

                                                                                                                                                                      Liste les remboursements

                                                                                                                                                                      Authorizations:
                                                                                                                                                                      x-api-key
                                                                                                                                                                        path Parameters
                                                                                                                                                                        partner
                                                                                                                                                                        required
                                                                                                                                                                        string

                                                                                                                                                                        Code partenaire

                                                                                                                                                                        query Parameters
                                                                                                                                                                        sortBy
                                                                                                                                                                        string
                                                                                                                                                                        Enum: "id" "debit" "senderAccountId" "comment" "link"

                                                                                                                                                                        Tri

                                                                                                                                                                        orderBy
                                                                                                                                                                        string
                                                                                                                                                                        Enum: "asc" "desc"

                                                                                                                                                                        Direction du tri

                                                                                                                                                                        pageNumber
                                                                                                                                                                        integer <int32> [ 1 .. 2147483647 ]

                                                                                                                                                                        Numéro de page

                                                                                                                                                                        pageSize
                                                                                                                                                                        integer <int32> [ 1 .. 100 ]

                                                                                                                                                                        Taille de la page

                                                                                                                                                                        header Parameters
                                                                                                                                                                        ps-language
                                                                                                                                                                        string
                                                                                                                                                                        Default: fr

                                                                                                                                                                        Langue de retour API

                                                                                                                                                                        x-version
                                                                                                                                                                        string

                                                                                                                                                                        Version de l'API

                                                                                                                                                                        ps-ip-address
                                                                                                                                                                        required
                                                                                                                                                                        string

                                                                                                                                                                        Adresse IP du client final

                                                                                                                                                                        Responses

                                                                                                                                                                        Response samples

                                                                                                                                                                        Content type
                                                                                                                                                                        application/json
                                                                                                                                                                        [
                                                                                                                                                                        • {
                                                                                                                                                                          }
                                                                                                                                                                        ]

                                                                                                                                                                        Liste les remboursements liés à une transaction entrante d'achat

                                                                                                                                                                        Authorizations:
                                                                                                                                                                        x-api-key
                                                                                                                                                                          path Parameters
                                                                                                                                                                          partner
                                                                                                                                                                          required
                                                                                                                                                                          string

                                                                                                                                                                          Code partenaire

                                                                                                                                                                          transactionId
                                                                                                                                                                          required
                                                                                                                                                                          integer <int64>

                                                                                                                                                                          Identifiant de la transaction

                                                                                                                                                                          query Parameters
                                                                                                                                                                          sortBy
                                                                                                                                                                          string
                                                                                                                                                                          Enum: "id" "debit" "senderAccountId" "comment" "link"

                                                                                                                                                                          Tri

                                                                                                                                                                          orderBy
                                                                                                                                                                          string
                                                                                                                                                                          Enum: "asc" "desc"

                                                                                                                                                                          Direction du tri

                                                                                                                                                                          pageNumber
                                                                                                                                                                          integer <int32> [ 1 .. 2147483647 ]

                                                                                                                                                                          Numéro de page

                                                                                                                                                                          pageSize
                                                                                                                                                                          integer <int32> [ 1 .. 100 ]

                                                                                                                                                                          Taille de la page

                                                                                                                                                                          header Parameters
                                                                                                                                                                          ps-language
                                                                                                                                                                          string
                                                                                                                                                                          Default: fr

                                                                                                                                                                          Langue de retour API

                                                                                                                                                                          x-version
                                                                                                                                                                          string

                                                                                                                                                                          Version de l'API

                                                                                                                                                                          ps-ip-address
                                                                                                                                                                          required
                                                                                                                                                                          string

                                                                                                                                                                          Adresse IP du client final

                                                                                                                                                                          Responses

                                                                                                                                                                          Response samples

                                                                                                                                                                          Content type
                                                                                                                                                                          application/json
                                                                                                                                                                          [
                                                                                                                                                                          • {
                                                                                                                                                                            }
                                                                                                                                                                          ]

                                                                                                                                                                          Affiche un remboursement

                                                                                                                                                                          Authorizations:
                                                                                                                                                                          x-api-key
                                                                                                                                                                            path Parameters
                                                                                                                                                                            partner
                                                                                                                                                                            required
                                                                                                                                                                            string

                                                                                                                                                                            Code partenaire

                                                                                                                                                                            transactionId
                                                                                                                                                                            required
                                                                                                                                                                            integer <int64>

                                                                                                                                                                            Identifiant de remboursement

                                                                                                                                                                            header Parameters
                                                                                                                                                                            ps-language
                                                                                                                                                                            string
                                                                                                                                                                            Default: fr

                                                                                                                                                                            Langue de retour API

                                                                                                                                                                            x-version
                                                                                                                                                                            string

                                                                                                                                                                            Version de l'API

                                                                                                                                                                            ps-ip-address
                                                                                                                                                                            required
                                                                                                                                                                            string

                                                                                                                                                                            Adresse IP du client final

                                                                                                                                                                            Responses

                                                                                                                                                                            Response samples

                                                                                                                                                                            Content type
                                                                                                                                                                            application/json
                                                                                                                                                                            {
                                                                                                                                                                            • "id": 0,
                                                                                                                                                                            • "date": "2019-08-24T14:15:22Z",
                                                                                                                                                                            • "debit": 0,
                                                                                                                                                                            • "credit": 0,
                                                                                                                                                                            • "comment": "string",
                                                                                                                                                                            • "senderAccountId": "string",
                                                                                                                                                                            • "receiverAccountId": "string",
                                                                                                                                                                            • "code": "string",
                                                                                                                                                                            • "message": "string",
                                                                                                                                                                            • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                                                            • "status": "complete",
                                                                                                                                                                            • "card": {
                                                                                                                                                                              },
                                                                                                                                                                            • "errorMessage": "string",
                                                                                                                                                                            • "type": "moneyIn",
                                                                                                                                                                            • "method": "card",
                                                                                                                                                                            • "iban": {
                                                                                                                                                                              },
                                                                                                                                                                            • "pspToken": "string",
                                                                                                                                                                            • "transferReference": "string",
                                                                                                                                                                            • "link": 0,
                                                                                                                                                                            • "p2pIds": [
                                                                                                                                                                              ],
                                                                                                                                                                            • "archivingKey": "string",
                                                                                                                                                                            • "eventPaymentType": "purchase",
                                                                                                                                                                            • "authorizationCode": "string",
                                                                                                                                                                            • "clientFirstName": "string",
                                                                                                                                                                            • "clientLastName": "string",
                                                                                                                                                                            • "companyName": "string",
                                                                                                                                                                            • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                                                            • "creditorIBAN": "string",
                                                                                                                                                                            • "directDebit": {
                                                                                                                                                                              },
                                                                                                                                                                            • "paymentInitiation": {},
                                                                                                                                                                            • "hostedFieldsStatus": "started",
                                                                                                                                                                            • "hostedFieldsToken": "string",
                                                                                                                                                                            • "hostedFieldsTpe": "string",
                                                                                                                                                                            • "hostedFieldsLink": {
                                                                                                                                                                              },
                                                                                                                                                                            • "orderReference": "string"
                                                                                                                                                                            }

                                                                                                                                                                            Rembourse un paiement

                                                                                                                                                                            Authorizations:
                                                                                                                                                                            x-api-key
                                                                                                                                                                              path Parameters
                                                                                                                                                                              partner
                                                                                                                                                                              required
                                                                                                                                                                              string

                                                                                                                                                                              Code partenaire

                                                                                                                                                                              transactionId
                                                                                                                                                                              required
                                                                                                                                                                              integer <int64>

                                                                                                                                                                              Identifiant de transaction entrante

                                                                                                                                                                              p2PId
                                                                                                                                                                              required
                                                                                                                                                                              integer <int64>

                                                                                                                                                                              Identifiant du P2P à rembourser

                                                                                                                                                                              header Parameters
                                                                                                                                                                              ps-language
                                                                                                                                                                              string
                                                                                                                                                                              Default: fr

                                                                                                                                                                              Langue de retour API

                                                                                                                                                                              x-version
                                                                                                                                                                              string

                                                                                                                                                                              Version de l'API

                                                                                                                                                                              ps-ip-address
                                                                                                                                                                              required
                                                                                                                                                                              string

                                                                                                                                                                              Adresse IP du client final

                                                                                                                                                                              Request Body schema: application/json

                                                                                                                                                                              Corps de méthode

                                                                                                                                                                              debtorAccountId
                                                                                                                                                                              required
                                                                                                                                                                              string non-empty

                                                                                                                                                                              Nom du compte de paiement de la transaction à rembourser

                                                                                                                                                                              amountToRefund
                                                                                                                                                                              number <decimal>

                                                                                                                                                                              Montant à rembourser (si vide, le montant total sera remboursé)

                                                                                                                                                                              comment
                                                                                                                                                                              string [ 0 .. 256 ] characters

                                                                                                                                                                              Commentaire sur le remboursement

                                                                                                                                                                              Responses

                                                                                                                                                                              Request samples

                                                                                                                                                                              Content type
                                                                                                                                                                              application/json
                                                                                                                                                                              {
                                                                                                                                                                              • "debtorAccountId": "string",
                                                                                                                                                                              • "amountToRefund": 0,
                                                                                                                                                                              • "comment": "string"
                                                                                                                                                                              }

                                                                                                                                                                              Response samples

                                                                                                                                                                              Content type
                                                                                                                                                                              application/json
                                                                                                                                                                              {
                                                                                                                                                                              • "id": 0,
                                                                                                                                                                              • "date": "2019-08-24T14:15:22Z",
                                                                                                                                                                              • "debit": 0,
                                                                                                                                                                              • "credit": 0,
                                                                                                                                                                              • "comment": "string",
                                                                                                                                                                              • "senderAccountId": "string",
                                                                                                                                                                              • "receiverAccountId": "string",
                                                                                                                                                                              • "code": "string",
                                                                                                                                                                              • "message": "string",
                                                                                                                                                                              • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                                                              • "status": "complete",
                                                                                                                                                                              • "card": {
                                                                                                                                                                                },
                                                                                                                                                                              • "errorMessage": "string",
                                                                                                                                                                              • "type": "moneyIn",
                                                                                                                                                                              • "method": "card",
                                                                                                                                                                              • "iban": {
                                                                                                                                                                                },
                                                                                                                                                                              • "pspToken": "string",
                                                                                                                                                                              • "transferReference": "string",
                                                                                                                                                                              • "link": 0,
                                                                                                                                                                              • "p2pIds": [
                                                                                                                                                                                ],
                                                                                                                                                                              • "archivingKey": "string",
                                                                                                                                                                              • "eventPaymentType": "purchase",
                                                                                                                                                                              • "authorizationCode": "string",
                                                                                                                                                                              • "clientFirstName": "string",
                                                                                                                                                                              • "clientLastName": "string",
                                                                                                                                                                              • "companyName": "string",
                                                                                                                                                                              • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                                                              • "creditorIBAN": "string",
                                                                                                                                                                              • "directDebit": {
                                                                                                                                                                                },
                                                                                                                                                                              • "paymentInitiation": {},
                                                                                                                                                                              • "hostedFieldsStatus": "started",
                                                                                                                                                                              • "hostedFieldsToken": "string",
                                                                                                                                                                              • "hostedFieldsTpe": "string",
                                                                                                                                                                              • "hostedFieldsLink": {
                                                                                                                                                                                },
                                                                                                                                                                              • "orderReference": "string"
                                                                                                                                                                              }

                                                                                                                                                                              Rembourse un paiement à proximité

                                                                                                                                                                              Fonctionnalité requise : PaymentCardInStore

                                                                                                                                                                              Authorizations:
                                                                                                                                                                              x-api-key
                                                                                                                                                                                path Parameters
                                                                                                                                                                                partner
                                                                                                                                                                                required
                                                                                                                                                                                string

                                                                                                                                                                                Code partenaire

                                                                                                                                                                                archivingKey
                                                                                                                                                                                required
                                                                                                                                                                                string

                                                                                                                                                                                Référence d'archivage de la transaction d'achat InStore

                                                                                                                                                                                p2PId
                                                                                                                                                                                required
                                                                                                                                                                                integer <int64>

                                                                                                                                                                                Identifiant du P2P à rembourser

                                                                                                                                                                                header Parameters
                                                                                                                                                                                ps-language
                                                                                                                                                                                string
                                                                                                                                                                                Default: fr

                                                                                                                                                                                Langue de retour API

                                                                                                                                                                                x-version
                                                                                                                                                                                string

                                                                                                                                                                                Version de l'API

                                                                                                                                                                                ps-ip-address
                                                                                                                                                                                required
                                                                                                                                                                                string

                                                                                                                                                                                Adresse IP du client final

                                                                                                                                                                                Request Body schema: application/json

                                                                                                                                                                                Corps de méthode

                                                                                                                                                                                debtorAccountId
                                                                                                                                                                                required
                                                                                                                                                                                string non-empty

                                                                                                                                                                                Nom du compte de paiement de la transaction à rembourser

                                                                                                                                                                                amountToRefund
                                                                                                                                                                                number <decimal>

                                                                                                                                                                                Montant à rembourser (si vide, le montant total sera remboursé)

                                                                                                                                                                                comment
                                                                                                                                                                                string [ 0 .. 256 ] characters

                                                                                                                                                                                Commentaire sur le remboursement

                                                                                                                                                                                Responses

                                                                                                                                                                                Request samples

                                                                                                                                                                                Content type
                                                                                                                                                                                application/json
                                                                                                                                                                                {
                                                                                                                                                                                • "debtorAccountId": "string",
                                                                                                                                                                                • "amountToRefund": 0,
                                                                                                                                                                                • "comment": "string"
                                                                                                                                                                                }

                                                                                                                                                                                Response samples

                                                                                                                                                                                Content type
                                                                                                                                                                                application/json
                                                                                                                                                                                {
                                                                                                                                                                                • "id": 0,
                                                                                                                                                                                • "date": "2019-08-24T14:15:22Z",
                                                                                                                                                                                • "debit": 0,
                                                                                                                                                                                • "credit": 0,
                                                                                                                                                                                • "comment": "string",
                                                                                                                                                                                • "senderAccountId": "string",
                                                                                                                                                                                • "receiverAccountId": "string",
                                                                                                                                                                                • "code": "string",
                                                                                                                                                                                • "message": "string",
                                                                                                                                                                                • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                                                                • "status": "complete",
                                                                                                                                                                                • "card": {
                                                                                                                                                                                  },
                                                                                                                                                                                • "errorMessage": "string",
                                                                                                                                                                                • "type": "moneyIn",
                                                                                                                                                                                • "method": "card",
                                                                                                                                                                                • "iban": {
                                                                                                                                                                                  },
                                                                                                                                                                                • "pspToken": "string",
                                                                                                                                                                                • "transferReference": "string",
                                                                                                                                                                                • "link": 0,
                                                                                                                                                                                • "p2pIds": [
                                                                                                                                                                                  ],
                                                                                                                                                                                • "archivingKey": "string",
                                                                                                                                                                                • "eventPaymentType": "purchase",
                                                                                                                                                                                • "authorizationCode": "string",
                                                                                                                                                                                • "clientFirstName": "string",
                                                                                                                                                                                • "clientLastName": "string",
                                                                                                                                                                                • "companyName": "string",
                                                                                                                                                                                • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                                                                • "creditorIBAN": "string",
                                                                                                                                                                                • "directDebit": {
                                                                                                                                                                                  },
                                                                                                                                                                                • "paymentInitiation": {},
                                                                                                                                                                                • "hostedFieldsStatus": "started",
                                                                                                                                                                                • "hostedFieldsToken": "string",
                                                                                                                                                                                • "hostedFieldsTpe": "string",
                                                                                                                                                                                • "hostedFieldsLink": {
                                                                                                                                                                                  },
                                                                                                                                                                                • "orderReference": "string"
                                                                                                                                                                                }

                                                                                                                                                                                Rembourse un paiement Omnicanal

                                                                                                                                                                                Fonctionnalité requise : PaymentCardInStore

                                                                                                                                                                                Authorizations:
                                                                                                                                                                                x-api-key
                                                                                                                                                                                  path Parameters
                                                                                                                                                                                  partner
                                                                                                                                                                                  required
                                                                                                                                                                                  string
                                                                                                                                                                                  archivingKey
                                                                                                                                                                                  required
                                                                                                                                                                                  string
                                                                                                                                                                                  p2PId
                                                                                                                                                                                  required
                                                                                                                                                                                  integer <int64>
                                                                                                                                                                                  header Parameters
                                                                                                                                                                                  ps-language
                                                                                                                                                                                  string
                                                                                                                                                                                  Default: fr

                                                                                                                                                                                  Langue de retour API

                                                                                                                                                                                  x-version
                                                                                                                                                                                  string

                                                                                                                                                                                  Version de l'API

                                                                                                                                                                                  ps-ip-address
                                                                                                                                                                                  required
                                                                                                                                                                                  string

                                                                                                                                                                                  Adresse IP du client final

                                                                                                                                                                                  Request Body schema: application/json
                                                                                                                                                                                  debtorAccountId
                                                                                                                                                                                  required
                                                                                                                                                                                  string non-empty

                                                                                                                                                                                  Nom du compte de paiement de la transaction à rembourser

                                                                                                                                                                                  amountToRefund
                                                                                                                                                                                  number <decimal>

                                                                                                                                                                                  Montant à rembourser (si vide, le montant total sera remboursé)

                                                                                                                                                                                  comment
                                                                                                                                                                                  string [ 0 .. 256 ] characters

                                                                                                                                                                                  Commentaire sur le remboursement

                                                                                                                                                                                  Responses

                                                                                                                                                                                  Request samples

                                                                                                                                                                                  Content type
                                                                                                                                                                                  application/json
                                                                                                                                                                                  {
                                                                                                                                                                                  • "debtorAccountId": "string",
                                                                                                                                                                                  • "amountToRefund": 0,
                                                                                                                                                                                  • "comment": "string"
                                                                                                                                                                                  }

                                                                                                                                                                                  Response samples

                                                                                                                                                                                  Content type
                                                                                                                                                                                  application/json
                                                                                                                                                                                  {
                                                                                                                                                                                  • "id": 0,
                                                                                                                                                                                  • "date": "2019-08-24T14:15:22Z",
                                                                                                                                                                                  • "debit": 0,
                                                                                                                                                                                  • "credit": 0,
                                                                                                                                                                                  • "comment": "string",
                                                                                                                                                                                  • "senderAccountId": "string",
                                                                                                                                                                                  • "receiverAccountId": "string",
                                                                                                                                                                                  • "code": "string",
                                                                                                                                                                                  • "message": "string",
                                                                                                                                                                                  • "dueDate": "2019-08-24T14:15:22Z",
                                                                                                                                                                                  • "status": "complete",
                                                                                                                                                                                  • "card": {
                                                                                                                                                                                    },
                                                                                                                                                                                  • "errorMessage": "string",
                                                                                                                                                                                  • "type": "moneyIn",
                                                                                                                                                                                  • "method": "card",
                                                                                                                                                                                  • "iban": {
                                                                                                                                                                                    },
                                                                                                                                                                                  • "pspToken": "string",
                                                                                                                                                                                  • "transferReference": "string",
                                                                                                                                                                                  • "link": 0,
                                                                                                                                                                                  • "p2pIds": [
                                                                                                                                                                                    ],
                                                                                                                                                                                  • "archivingKey": "string",
                                                                                                                                                                                  • "eventPaymentType": "purchase",
                                                                                                                                                                                  • "authorizationCode": "string",
                                                                                                                                                                                  • "clientFirstName": "string",
                                                                                                                                                                                  • "clientLastName": "string",
                                                                                                                                                                                  • "companyName": "string",
                                                                                                                                                                                  • "date_finalized": "2019-08-24T14:15:22Z",
                                                                                                                                                                                  • "creditorIBAN": "string",
                                                                                                                                                                                  • "directDebit": {
                                                                                                                                                                                    },
                                                                                                                                                                                  • "paymentInitiation": {},
                                                                                                                                                                                  • "hostedFieldsStatus": "started",
                                                                                                                                                                                  • "hostedFieldsToken": "string",
                                                                                                                                                                                  • "hostedFieldsTpe": "string",
                                                                                                                                                                                  • "hostedFieldsLink": {
                                                                                                                                                                                    },
                                                                                                                                                                                  • "orderReference": "string"
                                                                                                                                                                                  }

                                                                                                                                                                                  Crée un remboursement de commission entre comptes marchands

                                                                                                                                                                                  Fonctionnalité requise : PaymentCard, PaymentCardInStore, PaymentTransfer, PaymentDirectDebit, PaymentInitiation

                                                                                                                                                                                  Authorizations:
                                                                                                                                                                                  x-api-key
                                                                                                                                                                                    path Parameters
                                                                                                                                                                                    partner
                                                                                                                                                                                    required
                                                                                                                                                                                    string

                                                                                                                                                                                    Code partenaire

                                                                                                                                                                                    transactionId
                                                                                                                                                                                    required
                                                                                                                                                                                    integer <int64>

                                                                                                                                                                                    Identifiant de transaction entrante

                                                                                                                                                                                    header Parameters
                                                                                                                                                                                    ps-language
                                                                                                                                                                                    string
                                                                                                                                                                                    Default: fr

                                                                                                                                                                                    Langue de retour API

                                                                                                                                                                                    x-version
                                                                                                                                                                                    string

                                                                                                                                                                                    Version de l'API

                                                                                                                                                                                    ps-ip-address
                                                                                                                                                                                    required
                                                                                                                                                                                    string

                                                                                                                                                                                    Adresse IP du client final

                                                                                                                                                                                    Request Body schema: application/json

                                                                                                                                                                                    Corps de méthode

                                                                                                                                                                                    debtorAccountId
                                                                                                                                                                                    required
                                                                                                                                                                                    string non-empty

                                                                                                                                                                                    Identifiant du compte de paiement à débiter

                                                                                                                                                                                    creditorAccountId
                                                                                                                                                                                    required
                                                                                                                                                                                    string non-empty

                                                                                                                                                                                    Identifiant du compte de paiement à créditer

                                                                                                                                                                                    p2PId
                                                                                                                                                                                    required
                                                                                                                                                                                    integer <int64>

                                                                                                                                                                                    Identifiant du P2P de commission intermarchand

                                                                                                                                                                                    amount
                                                                                                                                                                                    required
                                                                                                                                                                                    number <decimal>

                                                                                                                                                                                    Montant à recouvrer

                                                                                                                                                                                    Responses

                                                                                                                                                                                    Request samples

                                                                                                                                                                                    Content type
                                                                                                                                                                                    application/json
                                                                                                                                                                                    {
                                                                                                                                                                                    • "debtorAccountId": "string",
                                                                                                                                                                                    • "creditorAccountId": "string",
                                                                                                                                                                                    • "p2PId": 0,
                                                                                                                                                                                    • "amount": 0
                                                                                                                                                                                    }

                                                                                                                                                                                    Response samples

                                                                                                                                                                                    Content type
                                                                                                                                                                                    application/json
                                                                                                                                                                                    {
                                                                                                                                                                                    • "message": "string",
                                                                                                                                                                                    • "code": "p2PStatusAlreadyComplete",
                                                                                                                                                                                    • "errorToken": "string"
                                                                                                                                                                                    }