Evolve Documentation Centre

Prerequisites

Before integrating with Direct Checkout, the following prerequisites must be in place:

General
  • Onboarding
  • Credentials
  • Evolve Payment Service (EPS) Endpoints
  • Publishable ID
Apple Pay
  • Payment Account ID
  • Payment method activation
  • Apple Pay sandbox testing setup
  • Apple Pay merchant registration (Production only).

Onboarding

Refer to the Quickstart Guide, where there are sections covering:

  • Creating a merchant
  • Creating a user
  • Completing the onboarding.

Currently the Creating a payment section is for Hosted Page integration, please refer to Processing a payment with Direct Checkout.

Credentials

Access PaySuite will provide you with your credentials, consisting of:

  • ISV ID
  • API key for onboarding and other non-payment endpoints
  • Payment API Key for the payment endpoints.

Evolve Payment Service (EPS) Endpoints

Our environments for payments are:

Sandbox https://secure.test.pay360evolve.com
Production https://secure.pay360evolve.com

Payment Account ID

The Payment Account ID is used when sending requests to certain Evolve endpoints. It is available from the Evolve Payment Service (EPS) paymentAccounts endpoint.

Call the general paymentAccounts endpoint, which will return a list of all your payment accounts:

curl --location --request GET '/api/v1/merchants/{ISV_ID}/paymentAccounts' \
--header 'jwt: {PAYMENT_API_KEY}' \
--header 'Content-Type: application/json' \
--data-raw ''

The response contains a JSON body with details about all your payment accounts, including the ID for the payment account you will be using.

Publishable ID

The publishable ID is used to secure the card data collected in Direct Checkout and transmitted to the Access PaySuite payment platform. It is available from the Evolve Payment Service (EPS) paymentAccounts endpoint.

Request the Payment Account ID as described above. Then call the paymentAccounts endpoint for a specific payment account:

curl 
--request GET '/api/v1/merchants/{ISV_ID}/paymentAccounts/{PAYMENT_ACCOUNT_ID}' \
--header 'jwt: {PAYMENT_API_KEY}' \
--header 'Content-Type: application/json' \
--data-raw ''

The response contains a JSON body with details about this payment account and will contain the Publishable ID

Payment method activation

Cards (credit and debits cards) is the only payment method activated by default for merchants.  

Apple Pay must be activated for merchants, either by Integrators via an endpoint, or by merchants via Merchant Portal.  Instructions can be found in Payment method activation.

Apple Pay sandbox testing setup

Apple provide a sandbox environment to test offline implementations of Apple Pay. Instructions can be found in Apple Pay sandbox testing setup.

Apple Pay merchant registration (Production only)

Apple mandates registration of merchants and the domain or domains where the Apple Pay button is displayed. Instructions can be found in Apple Pay merchant registration.

Note: merchant registration is not required for sandbox testing.