-
Notifications
You must be signed in to change notification settings - Fork 0
Merchant PSP Configuration
The merchant must add their PSP configuration on the Dashboard. The data needed for the PSP configuration will be received whenever a merchant registers at a PSP.
The merchant can add a configuration for a wanted PSP by providing the following parameter in the URL path:
| Parameter Name | Description | Type | Required |
|---|---|---|---|
| Merchant-Id | Merchant id | String | Yes |
Request body:
| Parameter Name | Description | Type | Required |
|---|---|---|---|
| pspId | BS_PAYONE, BRAINTREE or ADYEN | String | Yes |
| pspConfig | PSP configuration | PspConfig | Yes |
PspConfig:
| Parameter Name | Description | Type | Required |
|---|---|---|---|
| merchantId | Merchant id | String | Yes |
| portalId | Portal identifier | String | Yes for BS Payone |
| key | Key | String | Yes for BS Payone |
| accountId | Account id | String | Yes for BS Payone |
| sandboxMerchantId | Sandbox (test) merchant id | String | Yes for Adyen and Braintree |
| sandboxPublicKey | Sandbox (test) public key | String | Yes for Adyen and Braintree |
| sandboxPrivateKey | Sandbox (test) private key | String | Yes for Adyen and Braintree |
| publicKey | Production (live) public key | String | Yes for Adyen and Braintree |
| privateKey | Production (live) private key | String | Yes for Adyen and Braintree |
| default | A flag whether is a default config or not | Boolean | Yes |
| currency | Merchant's currency | String | Yes for Adyen |
| country | Merchant's currency | String | Yes for Adyen |
| locale | Merchant's locale | String | Yes for Adyen |
| urlPrefix | Live URL prefix | String | Yes for Adyen |
| sandboxClientEncryptionKey | Sandbox encryption key for encrypting CC data on the client side | String | Yes for Adyen |
| clientEncryptionKey | Encryption key for encrypting CC data on the client side | String | Yes for Adyen |
The response body will contain:
| Parameter Name | Description | Type |
|---|---|---|
| pspId | BS_PAYONE, BRAINTREE or ADYEN | String |
The merchant can retrieve the list of the existing PSP configurations by providing the following parameter in the URL path:
| Parameter Name | Description | Type | Required |
|---|---|---|---|
| Merchant-Id | Merchant id | String | Yes |
The merchant can retrieve the configuration for a specific PSP by providing the following parameters in the URL path:
| Parameter Name | Description | Type | Required |
|---|---|---|---|
| Merchant-Id | Merchant id | String | Yes |
| Psp-Id | BS_PAYONE, BRAINTREE or ADYEN | String | Yes |
The merchant can update the configuration for a specific PSP by providing the following parameters in the URL path:
| Parameter Name | Description | Type | Required |
|---|---|---|---|
| Merchant-Id | Merchant id | String | Yes |
| Psp-Id | BS_PAYONE, BRAINTREE or ADYEN | String | Yes |
The PSP configurable fields(PspConfig object) mentioned above should be sent in a request body.
The merchant can delete the configuration for a specific PSP by providing the following parameters in the URL path:
| Parameter Name | Description | Type | Required |
|---|---|---|---|
| Merchant-Id | Merchant id | String | Yes |
| Psp-Id | BS_PAYONE, BRAINTREE or ADYEN | String | Yes |