Paysafe is a third party supplier which is integrated with EBS to process online payments. You must contact Paysafe to agree a contract.
When you have negotiated a contract and been through the testing process with Paysafe you are ready to start the configuration with EBS. At this point you should have received a URL from Paysafe that is specific to your organisation.
Configuration
The institution settings for Paysafe are configured on the following screens (accessed from the Product Modules pane):
ePayments (Self-Service)
The fields that are relevant to Paysafe are described in the table ePayments (Self-Service) settings. It is recommended that unused fields are left blank.
| This field | Holds this information... |
|---|---|
| ePayment provider | The electronic payment provider being used for Ontrack Learner Hub. Select Paysafe from the drop-down list. |
| ePayment URL |
The URL provided by Paysafe. This should be in one of the following formats:
Important.This field must include the URL of your payment provider.
|
| Payment Account ID | The Paysafe account ID. |
| Payment Account Key | The single-use token-generating API key (used in the client-side JavaScript code). |
| Payment Security Key | The server-to-server API key. |
| Only use default account code for payments | It is recommended this field is set to N for Paysafe. |
| Payment Merchant Reference | The payment merchant reference for Paysafe. |
| Default Payment Email Address | The email address to which transaction emails are sent (that is: your Ontrack Learner Hub URL). |
| Payment Host IP Address | The payment host IP address for Paysafe. |
| Payment Process Allowed IP Addresses - (Empty=Allow All) | The payment process allowed IP address for Paysafe or leave blank to allow all. |
| Default VAT code | The default VAT code to use for Paysafe. |
| ePayment failure message (Prospect) | The message displayed to learners in Ontrack Learner Hub when payment fails in the institution's payment provider. |
ePayments (Staff)
The fields that are relevant to Paysafe are described in the table ePayments (Staff) settings. It is recommended that unused fields are left blank.
| This field | Holds this information... |
|---|---|
| ePayment provider | The electronic payment provider being used for Central. Select Paysafe from the drop-down list. |
| ePayment URL |
The URL provided by Paysafe. This should be in one of the following formats:
Important.This field must include the URL of your payment provider.
|
| Payment Account ID | The Paysafe account ID. |
| Payment Account Key | The single-use token-generating API key (used in the client-side JavaScript code). |
| Payment Security Key | The server-to-server API key. |
| Only use default account code for payments | It is recommended this field is set to N for Paysafe. |
| Default Payment Email Address | The email address to which transaction emails are sent. |
| Payment Host IP Address | The payment host IP address for Paysafe. |
| Payment Process Allowed IP Addresses - (Empty=Allow All) | The payment process allowed IP address for Paysafe or leave blank to allow all. |
| Only use default VAT code for payments | It is recommended this field is set to N for Paysafe. |
| Default VAT code | The default VAT code to use for Paysafe. |
| The Method of Transfer That EBS Central Uses For ePayments |
The method of transfer that EBS uses for ePayments. Select Open in default browser for Paysafe. Important.You must select Open in default browser for Paysafe.
|
The following configuration information for Paysafe is also applicable:
Payment Account Key and Payment Security KeyYou must create a Single-Use Token API key (Payment Account Key) and a Server-to-Server API key (Payment Security Key).
For more information on creating Paysafe API keys, go to Using your API Keys.
tribal and password group is converted to tribal:group, which is encoded to dHJpYmFsOmdyb3Vw.Data sent to Paysafe
The data sent to Paysafe when making a payment is described in the table Data sent to Paysafe.
| Value | Source | Notes |
|---|---|---|
| PublicToken | Payment Account Key | Sent in the JS in PaySafe.aspx when setting up the payment iframe |
| amount | The total amount being paid | None |
| holderName | The Full Name of the person making the payment | None |
| currency | 'GBP', 'AUD' or 'NZD' | Dependent on institution type |
| environment | 'TEST' or 'LIVE' | 'TEST' if PaymentProviderTestMode = True |
| companyName | Organisation Name institution setting | None |
| account.CC | Payment Account ID | None |
| threeDS.useThreeDSecureVersion2 | True or false | Used to enable 3DS2 security. If payment mode is staff then false, otherwise true |
| billingAddress.country | ISO2 country code populated from a drop-down | Drop-down values built from verifiers in ISO_ALPHA_2_COUNTRY_CODE domain |
| billingAddress.zip | Postcode from payment person details | Mandatory for 3DS2 verification |
| billingAddress.street | AddressLine1 from payment person details | Mandatory for 3DS2 verification |
The data sent to Paysafe when a payment is verified is described in the table Verification data.
| Value | Source | Notes |
|---|---|---|
| amount | The total amount being paid | None |
| firstName | The forename from the payment details | None |
| lastName | The surname from the payment details | None |
| The email address from the payment details | None |