Champs d’intégration
Le tableau suivant donne un aperçu des champs obligatoires et facultatifs qui sont requis pour chaque appel à l’API Gestion des comptes. Vous trouverez des informations détaillées sur chaque champ dans la rubrique API. Vous devez effectuer tous les appels avant que le marchand puisse être soumis à l’activation.
Les champs obligatoires sont indiqués par région dans les colonnes CA, EU et US, selon la clé suivante :
- M = Mandatory (obligatoire)
- O = Optional (facultatif)
- C = Conditional – Le champ n’est requis que si, par exemple, un autre champ facultatif est inclus et requiert alors ce champ.
- NA = Not Applicable – Le champ est obligatoire, par exemple pour certaines juridictions seulement, et n’est pas applicable à cette juridiction.
Nom | Point de terminaison | Champ | CA | UE | US | Remarques |
---|---|---|---|---|---|---|
Créer un marchand | /merchants | name | M | M | M | |
Créer un compte marchand | /merchants/merchant_id/accounts | name | M | M | M | |
processingCurrency | C | C | C | Le champ processingCurrency est requis si vous êtes configuré par Paysafe pour créer des comptes marchands multidevises. Il ne peut pas être inclus si vous n’êtes pas configuré pour créer des comptes marchands multidevises. | ||
devise | M | M | M | Si Paysafe vous configure pour créer des comptes multidevises, le champ de devise spécifie la devise de règlement du compte marchand. Si Paysafe ne vous a pas configuré pour créer des comptes multidevises, le champ de devise indique la devise de traitement et de règlement du compte marchand. | ||
region | M | M | M | |||
legalEntity | M | M | M | |||
productCode | M | M | M | Paysafe fournit ce code de produit de partenaire. Vous avez besoin d’un code produit différent (et d’un compte marchand) pour chaque combinaison de mode de paiement et de devise que vous souhaitez proposer : p. ex. carte de crédit USD, prélèvement automatique TEF, etc. | ||
category | O | O | O | Bien que la catégorie soit facultative lors de la création du compte marchand, vous devez mettre à jour le compte marchand pour ajouter cet élément ultérieurement avant que le compte marchand ne soit activé. | ||
averageTransactionAmount | O | O | O | Même si averageTransactionAmount est facultatif lorsque vous créez le compte marchand, vous devez mettre à jour le compte marchand pour ajouter cet élément à un moment ultérieur où le compte marchand peut être activé. | ||
url | O | O | O | |||
phone | O | O | O | Bien que le numéro de téléphone soit facultatif lors de la création du compte marchand, vous devez mettre à jour le compte marchand pour ajouter cet élément à un moment ultérieur avant que le compte marchand ne soit activé. | ||
adresse courriel | O | O | O | |||
yearlyVolumeRange | O | O | O | Même si yearlyVolumeRange est facultatif lorsque vous créez le compte marchand, vous devez mettre à jour le compte marchand pour ajouter cet élément à un moment ultérieur où le compte marchand peut être activé. | ||
locale | O | O | O | |||
userName | O | O | O | Si un userName existe sur un autre compte marchand que vous avez déjà créé, vous pouvez l’inclure ici. | ||
amexMid | O | O | O | Il s’agit de l’identifiant American Express du marchand. Il s’agit de votre identifiant American Express (identifiant du marchand ou numéro MID). Vous trouverez votre identifiant de marchand sur vos relevés AMEX. L’ajout d’un identifiant AMEX erroné peut entraîner le refus d’une transaction. | ||
externalAccountId | O | O | O | |||
Les champs suivants sont contenus dans les objets complexes caAccountDetails, euAccountDetails et usAccountDetails. Bien que cet objet soit facultatif lors de la création du compte marchand, vous devez mettre à jour le compte marchand pour ajouter cet objet ultérieurement, avant que le compte marchand ne soit activé. | ||||||
type | C | C | C | Requis si l’objet AccountDetails est fourni. | ||
description | O | O | O | |||
isCardPresent | O | O | O | Ce champ n’est pas pris en charge pour les comptes marchands qui traitent des prélèvements automatiques. | ||
hasPreviouslyProcessedCards | O | O | O | Ce champ n’est pas pris en charge pour les comptes marchands qui traitent des prélèvements automatiques. | ||
shipsGoods | O | O | O | |||
deliveryTimeRange | C | C | C | Si shipsGoods est défini sur « true », alors deliveryTimeRange est obligatoire. | ||
refundPolicy | O | O | O | |||
refundPolicyDescription | C | C | C | Si refundPolicy est réglé sur « true », alors fundPolicyDescription est obligatoire. | ||
federalTaxNumber | C | s.o. | C | Requis si l’objet AccountDetails pertinent est fourni. | ||
taxIdentificationNumber | s.o. | C | s.o. | Requis si l’objet AccountDetails pertinent est fourni. | ||
registrationNumber | s.o. | C | s.o. | Requis si l’objet AccountDetails pertinent est fourni. Toutefois, cette option est facultative si le type est défini sur TRUST, SOLEPROP, GOV ou PARTNERSHIP. | ||
additionalPaymentMethods | O | O | O | Ce champ n’est pas pris en charge pour les comptes marchands qui traitent des prélèvements automatiques. | ||
Les deux champs suivants se trouvent dans l’objet merchantDescriptor. Bien que le descripteur de marchand soit facultatif lors de la création du compte marchand, vous devez mettre à jour le compte marchand pour ajouter cet objet ultérieurement avant que le compte marchand ne soit activé. | ||||||
dynamicDescriptor | C | C | C | Requis si merchantDescriptor est fourni. Pour les marchands qui traitent des cartes de crédit, un préfixe supplémentaire peut être ajouté, en fonction de la banque de traitement. | ||
phone | C | C | C | Requis si merchantDescriptor est fourni. Non pris en charge par les marchands qui traitent des prélèvements automatiques. | ||
Créer un utilisateur | /accounts/account_id/users | userName | M | M | M | À utiliser uniquement s’il n’y a pas déjà un utilisateur associé au compte marchand. |
Mots de passe | M | M | M | |||
adresse courriel | M | M | M | |||
Les deux champs suivants se trouvent dans l’objet recoveryQuestion. | ||||||
questionId | M | M | M | |||
answer | M | M | M | |||
Créer de l’adresse du compte marchand | /accounts/account_id/addresses | street | M | M | M | |
street2 | O | O | O | |||
city | M | M | M | |||
state | M | M | M | |||
zip | M | M | M | |||
country | M | M | M | |||
Créer un propriétaire d’entreprise | /accounts/account_id/businessowners | firstName | M | M | M | Consultez ces tableaux pour connaître les conditions d’ajout d’un propriétaire d’entreprise à un compte marchand. |
lastName | M | M | M | |||
nas | O | s.o. | M | Si le numéro d’assurance sociale est fourni, il doit être composé de 9 chiffres et être numérique. Remarque : Le paramètre SSN n’est pas nécessaire lorsque le paramètre type de l’objet usAccountDetails est défini sur NPCORP, CHARITY ou GOV. Cet objet est inclus lorsque vous créez un compte marchand. | ||
phone | M | M | M | |||
jobTitle | M | M | M | |||
nationality | O | M | O | |||
dateOfBirth | M | M | M | |||
gender | O | M | O | |||
middleName | O | O | O | |||
previousLastName | O | O | O | |||
adresse courriel | O | O | O | |||
percentageOwnership | C | C | C | Si vous avez des propriétaires réels ultimes, le pourcentage de propriété de chacun d’entre eux doit être indiqué ici. | ||
isApplicant | M | M | M | Vous ne pouvez désigner qu’un seul propriétaire d’entreprise comme demandeur. Tous les partenaires des États-Unis, du Canada et de l’Union européenne doivent obliger leurs marchands à désigner l’un des propriétaires de l’entreprise comme demandeur. | ||
isControlProng | O | s.o. | M | Tous les partenaires américains doivent obliger leurs marchands à identifier l’un des propriétaires de l’entreprise comme étant l’entité de contrôle. | ||
Créer l’adresse actuelle du propriétaire de l’entreprise | /businessowners/business_owner_id/currentaddresses | street | M | M | M | |
street2 | O | O | O | |||
city | M | M | M | |||
state | M | M | M | |||
zip | M | M | M | |||
country | M | M | M | |||
yearsAtAddress | M | M | O | |||
Créer l’adresse antérieure du propriétaire de l’entreprise | /businessowners/business_owner_id/previousaddresses | street | M | M | O | L’adresse antérieure est requise si le propriétaire de l’entreprise est canadien ou européen et qu’il a vécu à son adresse actuelle pendant moins de trois ans. |
street2 | O | O | O | |||
city | M | M | M | |||
state | M | M | M | |||
zip | M | M | M | |||
country | M | M | M | |||
yearsAtAddress | M | M | O | |||
Créer un compte bancaire ACH | accounts/account_id/bankaccounts | routingNumber | s.o. | s.o. | M | |
accountNumber | s.o. | s.o. | M | |||
Créer un compte bancaire TEF | accounts/account_id/bankaccounts | transitNumber | M | s.o. | s.o. | |
institutionId | M | s.o. | s.o. | |||
accountNumber | M | s.o. | s.o. | |||
Créer un compte bancaire BACS | accounts/account_id/bankaccounts | beneficiaryBankCountry | s.o. | M | s.o. | |
beneficiaryAccountName | s.o. | M | s.o. | |||
accountNumber | s.o. | M | s.o. | |||
sortCode | s.o. | M | s.o. | |||
Créer un compte bancaire SEPA | accounts/account_id/bankaccounts | beneficiaryBankCountry | s.o. | M | s.o. | |
beneficiaryAccountName | s.o. | M | s.o. | |||
swiftNumber | s.o. | M | s.o. | |||
ibanNumber | s.o. | M | s.o. | |||
Créer un compte bancaire électronique | accounts/account_id/bankaccounts | accountNumber | s.o. | M | s.o. | |
routingNumber | s.o. | O | s.o. | |||
sortCode | s.o. | O | s.o. | |||
swiftNumber | s.o. | M | s.o. | |||
ibanNumber | s.o. | C | s.o. | Si beneficiaryBankCountry figure sur la liste des pays pris en charge pour SEPA, alors ibanNumber est obligatoire. | ||
beneficiaryCountry | s.o. | M | s.o. | |||
beneficiaryAccountName | s.o. | M | s.o. | |||
beneficiaryAddress | s.o. | M | s.o. | |||
beneficiaryCity | s.o. | M | s.o. | |||
beneficiaryRegion | s.o. | M | s.o. | |||
beneficiaryPostCode | s.o. | M | s.o. | |||
beneficiaryBankCountry | s.o. | M | s.o. | |||
beneficiaryBankName | s.o. | M | s.o. | |||
beneficiaryBankAddress | s.o. | M | s.o. | |||
beneficiaryBankCity | s.o. | M | s.o. | |||
beneficiaryBankRegion | s.o. | M | s.o. | |||
beneficiaryBankPostCode | s.o. | M | s.o. | |||
Rechercher les conditions générales | /accounts/account_id/ termsandconditions?version=termsandconditions_version | Aucun champ requis. | ||||
Accepter les conditions générales | /accounts/account_id/termsandconditions | version | M | M | M | |
Activer un compte marchand | /accounts/account_id/activation | Aucun champ requis. |