Ajouter un compte bancaire à un profil
POST /customervault/v1/profiles/profile_id/achbankaccounts
L’API Coffre-fort client vous permet de stocker plusieurs comptes bancaires dans le profil de votre client. Pour la facturation, chaque compte bancaire peut être associé à une adresse différente ou tous les comptes bancaires peuvent être associés à la même adresse de facturation, en fonction des besoins de votre entreprise.
Pour ajouter un compte bancaire à un profil et l’associer à l’adresse que vous venez de créer, vous devez utiliser l’identifiant du profil (716adb4f-6b85-4089-ba9c-d9c0eb649cd7 dans l’exemple précédent) et effectuer une requête POST vers le point de terminaison de compte bancaire approprié du profil concerné.
- Comptes bancaires ACH – point de terminaison se terminant par achbankaccounts
- Comptes bancaires BACS – point de terminaison se terminant par bacsbankaccounts
- Compte bancaire TEF – point de terminaison se terminant par eftbankaccounts
- Comptes bancaires SEPA – point de terminaison se terminant par sepabankaccounts
- Mandats – point de terminaison se terminant par mandates
Lorsque vous utilisez l’API Coffre-fort client pour créer un compte bancaire, le compte bancaire nouvellement créé fait partie du profil qui possède l’identifiant de profil et l’identifiant d’adresse (billingAddressId) que vous avez utilisés. L’exemple ci-dessous montre comment créer un compte bancaire ACH à ajouter au profil d’un client.
Avant d’essayer l’exemple, vous devez remplacer la clé API (après le -u) par la clé API que vous avez reçue, ainsi que l’identifiant du profil et le numéro d’identification de l’utilisateur et les valeurs billingAddressId par les valeurs renvoyées lors de la création d’un exemple de profil et d’adresse respectivement.
curl -X POST https://api.test.paysafe.com/customervault/v1/profiles/716adb4f-6b85-4089-ba9c-d9c0eb649cd7/achbankaccounts \
-u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
-H ’Content-Type: application/json’ \
-d ’ {
"nickName": "John's RBC Business Bank Account",
"accountNumber": "511201",
"routingNumber": "123456789",
"accountHolderName": "XYZ Business",
"billingAddressId": "60022f38-fd17-4731-909c-923930d0d5d4",
"accountType": "CHECKING"
}'
| Valeur | Requis? | Type | Description |
|---|---|---|---|
| accountHolderName | Oui | string | Le nom du client ou de l’entreprise titulaire du compte bancaire. |
| accountNumber | Oui | string | Le numéro de compte bancaire. |
| accountType | Oui (ACH seulement) | enum | Le type de compte bancaire :
|
| bic | Oui (SEPA seulement) | string | Le code d’identification de la banque. |
| billingAddressIdbillingAddressId | Oui | string | L’identifiant renvoyé lors de la création de l’adresse, à associer au compte bancaire. |
| iban | Oui (SEPA seulement) | string | Le numéro de compte bancaire international. |
| institutionId | Oui (TEF seulement) | string | L’identifiant à trois chiffres d’institution de la banque du client. |
| mandates | array | Un ou plusieurs mandats associés au compte bancaire (BACS et SEPA seulement). | |
| merchantRefNum | string | Numéro de référence créé par le marchand. Stocké par le système Paysafe, mais sans effet sur la requête. | |
| nickName | string | Un alias pour ce compte bancaire défini par le client (p. ex. « Compte de Jean »). | |
| routingNumber | Oui (ACH seulement) | string | Pour les comptes en USD, le numéro d’acheminement à 9 chiffres de la banque du client. |
| sortCode | Oui (BACS seulement) | string | Code à six chiffres qui identifie la banque du client et la succursale. |
| transitNumber | Oui (TEF seulement) | string | Code à cinq chiffres qui identifie la succursale de la banque du client. |
{
"id": "6a275b7c-6f11-4ed1-ae77-21071724574a",
"status": "ACTIVE",
"nickName": "John's RBC Business Bank Account",
"routingNumber": "123456789",
"accountHolderName": "XYZ Business",
"billingAddressId": "60022f38-fd17-4731-909c-923930d0d5d4",
"accountType": "CHECKING",
"lastDigits": "01",
"paymentToken": "CNjEzMTM4NDg1"
}
| Valeur | Type | Description |
|---|---|---|
| Id | string | L’identifiant unique du compte bancaire. |
| status | string | L’état de la requête :
|
| lastDigits | string | Les deux derniers chiffres du numéro de compte bancaire. |
| paymentToken | string | Un jeton représentant le compte bancaire, qui peut être utilisé à la place des informations sur le compte bancaire dans les transactions de prélèvement automatique. |