Documentation Powered by ReDoc

Paysurf API (v1.1)

Download OpenAPI specification:Download

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 status 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 Status du compte marchand [ incompleteFile, rejectedDocuments, kyc1, kyc2, kyc3, expiredDocuments, blocked, closed, pendingKyc3]

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 Status 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 Status 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 Status 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 Status 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 Status 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 Status 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

Chargeback pris en charge par Paysurf (chargebackSupportedByPaysurf)

Clé Description Valeur
NotifCategory Type de notification chargebackSupportedByPaysurf
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
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

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
errorCommission La commission TTC est inférieure à 0
formatDocument Format du document incorrect
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é
invalidCart Les marchands {0} ne sont pas valides
invalidCountryCodeIso Le code du pays saisi n'est pas conforme à la norme ISO 3166-1 alpha3
invalidIban L'IBAN renseigné ne correspond pas à l'utilisateur ou n'est pas valide
invalidPaymentMethod La méthode de paiement n'est pas valide
invalidTrans Transaction invalide
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é
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 saisie est supérieur au montant restant à recouvrir pour ce paiement de ventilation
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})
refundBalance Les soldes du compte de paiement du marchand et du compte de commission sont inférieurs au montant de la demande de remboursement
refundPendingP2P Vous ne pouvez pas faire de remboursement partiel sur un Paiement OnUs de ventilation toujours en attente
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
uploadSamePendingDocType Vous avez déjà un document du même type en attente de traitement
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é
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
commissionCalculation Erreur lors du calcul de la commission
featUnavailable Cette fonctionnalité est indisponible
headerIpInvalidFormat Format de l'adresse IP invalide
headerIpRequired Le header {0} doit être renseigné
internalError Erreur Interne à Paysurf, veuillez contacter le SAV Paysurf
missingSqlParameter Paramètre manquant
originTransactionAccount Problème sur le compte de la transaction d'origine
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
selfPayment Vous ne pouvez pas vous envoyer de l'argent
statusNotManaged Statut non géré
transactionAlreadyCompleted La transaction est déjà terminée
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
unauthorizedTransactionStatus Le statut de la transaction n'est pas supportée
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é
documentNotFound Le document n'a pas été trouvé
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
ribNotFound RIB introuvable
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
required
string [ 2 .. 10 ] characters ^[0-9]{2,10}$

Code postal

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

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" "MSR" "MAR" "MOZ" "OMN" "NAM" "NRU" "NPL" "NLD" "ANT" "ABW" "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" "SHN" "KNA" "AIA" "LCA" "SPM" "VCT" "SMR" "STP" "SAU" "SEN" "SYC" "SLE" "SGP" "SVK" "VNM" "SVN" "SOM" "ZAF" "ZWE" "ESP" "ESH" "SDN" "SUR" "SJM" "SWZ" "SWE" "CHE" "SYR" "TJK" "THA" "TGO" "TKL" "TON" "TTO" "ARE" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "MKD" "EGY" "GBR" "IMN" "TZA" "USA" "VIR" "BFA" "URY" "UZB" "VEN" "WLF" "WSM" "YEM" "SCG" "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 (SIREN, RNA, immatriculation RCS/RN)

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"

Forme juridique

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

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" "MSR" "MAR" "MOZ" "OMN" "NAM" "NRU" "NPL" "NLD" "ANT" "ABW" "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" "SHN" "KNA" "AIA" "LCA" "SPM" "VCT" "SMR" "STP" "SAU" "SEN" "SYC" "SLE" "SGP" "SVK" "VNM" "SVN" "SOM" "ZAF" "ZWE" "ESP" "ESH" "SDN" "SUR" "SJM" "SWZ" "SWE" "CHE" "SYR" "TJK" "THA" "TGO" "TKL" "TON" "TTO" "ARE" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "MKD" "EGY" "GBR" "IMN" "TZA" "USA" "VIR" "BFA" "URY" "UZB" "VEN" "WLF" "WSM" "YEM" "SCG" "ZMB"

Pays de naissance au format ISO-3

registrationIp
string

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": "http://example.com",
  • "birthCountry": "AFG",
  • "registrationIp": "string"
}

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "balance": 0,
  • "fullName": "string",
  • "email": "string",
  • "status": "incompleteFile",
  • "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": {
    }
}

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": "incompleteFile",
  • "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": {
    }
}

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 <email>

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 [ 2 .. 10 ] characters ^[0-9]{2,10}$

Code postal

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

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" "MSR" "MAR" "MOZ" "OMN" "NAM" "NRU" "NPL" "NLD" "ANT" "ABW" "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" "SHN" "KNA" "AIA" "LCA" "SPM" "VCT" "SMR" "STP" "SAU" "SEN" "SYC" "SLE" "SGP" "SVK" "VNM" "SVN" "SOM" "ZAF" "ZWE" "ESP" "ESH" "SDN" "SUR" "SJM" "SWZ" "SWE" "CHE" "SYR" "TJK" "THA" "TGO" "TKL" "TON" "TTO" "ARE" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "MKD" "EGY" "GBR" "IMN" "TZA" "USA" "VIR" "BFA" "URY" "UZB" "VEN" "WLF" "WSM" "YEM" "SCG" "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 (SIREN, RNA, immatriculation RCS/RN)

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"

Forme juridique

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

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" "MSR" "MAR" "MOZ" "OMN" "NAM" "NRU" "NPL" "NLD" "ANT" "ABW" "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" "SHN" "KNA" "AIA" "LCA" "SPM" "VCT" "SMR" "STP" "SAU" "SEN" "SYC" "SLE" "SGP" "SVK" "VNM" "SVN" "SOM" "ZAF" "ZWE" "ESP" "ESH" "SDN" "SUR" "SJM" "SWZ" "SWE" "CHE" "SYR" "TJK" "THA" "TGO" "TKL" "TON" "TTO" "ARE" "TUN" "TUR" "TKM" "TCA" "TUV" "UGA" "UKR" "MKD" "EGY" "GBR" "IMN" "TZA" "USA" "VIR" "BFA" "URY" "UZB" "VEN" "WLF" "WSM" "YEM" "SCG" "ZMB"

Pays de naissance au format ISO-3

Responses

Request samples

Content type
application/json
{
  • "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": "http://example.com",
  • "birthCountry": "AFG"
}

Response samples

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

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
[
  • {
    }
]

Cards

Liste les cartes de paiement

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

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"
}

Désactive une carte de paiement

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

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

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",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "originAmount": 0,
  • "originId": 0,
  • "isRecoverable": true,
  • "recovered": 0,
  • "status": "fullyRecovered"
}

Liste les chargebacks liées à un paiement par carte

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

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",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "expired",
  • "originId": 0
}

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" "mandatSdd" "factureComm" "factureAnnex" "factureDiv"

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.

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" "mandatSdd" "factureComm" "factureAnnex" "factureDiv"
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 non-empty ^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[0-9]{7}([a...

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": "string",
  • "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"
}

MoneyIns

Liste les transactions entrantes

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

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",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "complete",
  • "card": {
    },
  • "errorMessage": "string",
  • "type": "moneyIn",
  • "method": "card",
  • "iban": {
    },
  • "pspToken": "string",
  • "transferReference": "string",
  • "link": 0,
  • "p2pIds": [
    ]
}

Liste les transactions entrantes par carte

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

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

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

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
[
  • {
    }
]

Crée un paiement par carte

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é

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"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "debit": 0,
  • "credit": 0,
  • "comment": "string",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "complete",
  • "card": {
    },
  • "errorMessage": "string",
  • "type": "moneyIn",
  • "method": "card",
  • "iban": {
    },
  • "pspToken": "string",
  • "transferReference": "string",
  • "link": 0,
  • "p2pIds": [
    ]
}

Crée un paiement par virement

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
required
string non-empty ^[\p{L} '-]*$

Prénom de l'émetteur du virement

clientLastName
required
string non-empty ^[\p{L} '-]*$

Nom de l'émetteur du virement

comment
string [ 0 .. 256 ] characters

Libellé du virement

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "debit": 0,
  • "credit": 0,
  • "comment": "string",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "complete",
  • "card": {
    },
  • "errorMessage": "string",
  • "type": "moneyIn",
  • "method": "card",
  • "iban": {
    },
  • "pspToken": "string",
  • "transferReference": "string",
  • "link": 0,
  • "p2pIds": [
    ]
}

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

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é

Responses

Request samples

Content type
application/json
{
  • "split": {
    },
  • "comment": "string",
  • "billingAddress": {
    },
  • "email": "user@example.com",
  • "bankingLabel": "string",
  • "bankingLabelLocality": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "debit": 0,
  • "credit": 0,
  • "comment": "string",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "complete",
  • "card": {
    },
  • "errorMessage": "string",
  • "type": "moneyIn",
  • "method": "card",
  • "iban": {
    },
  • "pspToken": "string",
  • "transferReference": "string",
  • "link": 0,
  • "p2pIds": [
    ]
}

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

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é

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"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "debit": 0,
  • "credit": 0,
  • "comment": "string",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "complete",
  • "card": {
    },
  • "errorMessage": "string",
  • "type": "moneyIn",
  • "method": "card",
  • "iban": {
    },
  • "pspToken": "string",
  • "transferReference": "string",
  • "link": 0,
  • "p2pIds": [
    ]
}

Valide un paiement différé par carte

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",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "complete",
  • "card": {
    },
  • "errorMessage": "string",
  • "type": "moneyIn",
  • "method": "card",
  • "iban": {
    },
  • "pspToken": "string",
  • "transferReference": "string",
  • "link": 0,
  • "p2pIds": [
    ]
}

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",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "complete",
  • "card": {
    },
  • "errorMessage": "string",
  • "type": "moneyIn",
  • "method": "card",
  • "iban": {
    },
  • "pspToken": "string",
  • "transferReference": "string",
  • "link": 0,
  • "p2pIds": [
    ]
}

Annule un paiement par virement

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"
}

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",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "complete",
  • "card": {
    },
  • "errorMessage": "string",
  • "type": "moneyIn",
  • "method": "card",
  • "iban": {
    },
  • "pspToken": "string",
  • "transferReference": "string",
  • "link": 0,
  • "p2pIds": [
    ]
}

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",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "complete",
  • "card": {
    },
  • "errorMessage": "string",
  • "type": "moneyIn",
  • "method": "card",
  • "iban": {
    },
  • "pspToken": "string",
  • "transferReference": "string",
  • "link": 0,
  • "p2pIds": [
    ]
}

P2Ps

Liste les P2P

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

Code partenaire

query Parameters
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",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "expired",
  • "originId": 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
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",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "expired",
  • "originId": 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
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",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "expired",
  • "originId": 0
}

Liste les P2P d'un chargeback

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

Code partenaire

chargebackId
required
integer <int64>

Identifiant de chargeback

query Parameters
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

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",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "expired",
  • "originId": 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
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",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "expired",
  • "originId": 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"
}

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>

Statut de chargeback

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",
  • "receiverAccountId": "string",
  • "senderAccountId": "string",
  • "status": "complete",
  • "card": {
    },
  • "errorMessage": "string",
  • "type": "moneyIn",
  • "method": "card",
  • "iban": {
    },
  • "pspToken": "string",
  • "transferReference": "string",
  • "link": 0,
  • "p2pIds": [
    ]
}