Zen Cart

Getting your SagePay API credentials

You will need to retrieve your Integration Key (username) and Integration Password. You can do this by following the steps below:

Step 1: Log in to MySagePay

Go to MySagePay in either the TEST or LIVE environment and log in using the Administration log in details that were provided to you during the setup of the account.

Once you are logged in as the Administrator, in the Password details section of the Administrator tab you will see an option to ‘Create API credentials’.

Step 2: Create API credentials

To create your credentials you just have to select the tick-box labelled “I understand that this will create new credentials and may break any existing Sage Pay API implementations.” and click on the ‘Create API credentials’ button.

When you choose to create new credentials, any previously generated credentials are immediately rendered invalid. Therefore, if you have already integrated with our REST API, you will not be able to authenticate your calls until you replace your expired credentials with the ones you just generated.

Once you have opted to create your new credentials we will present you with the following information:

►  Environment: This specifies the environment for which the credentials apply (test or live)

►  Vendor Name: The vendorname for the account

►  Integration Key: The value for the Integration key (username)

►  Integration Password: The value for the Integration password

Step 3: Save credentials

It is important that you store these credentials safely and securely. If you lose them, you will need to generate a new set of credentials using the same process. Please note that these credentials are only valid for PI and not for any legacy Sage Pay integration methods

Each card number will provide you with a different result when processing a transaction to ensure your website can handle all possible responses from our system.

Along with the different 3D Secure results each card type will return you are also able to test cards issued from multiple countries.

The 3D Secure responses are –

• Y – Enrolled, and will progress to the password page to complete verification.
• N – NOT Enrolled and will return a 3DSecureStatus=NOTAVAILABLE back to your system.
• U – Unable to verify enrollment and will return a 3DSecureStatus=NOTAVAILABLE back to your system.
• E – Error occurred during the 3D Secure verification.  This will return a 3DSecureStatus=ERROR back to your system.

Each response is to ensure your website can handle the multiple responses that are sent from Sage Pay back to your site.

When using any of the cards above for testing you will also need to enter an expiry date.  Any expiry date can be accepted as long as it is in the future from the date you are processing the test transaction.

Address Details

When using the test card details and processing a transaction you will be required to enter an address for the shopper.

We have assigned address details to each of the above cards that will be accepted on our test system.

When using the address details with the card details above the transactions will be able to processed successfully, along with passing both the simulated address and postcode fraud prevention checks.

Address                 : 88

Postcode               : 412

3D Secure

If you have 3D Secure active on your account you will also be required to enter a password to complete the process.

We have a range of passwords that can be used to test the different responses that will be sent back by 3D Secure upon completion of the verification (PaRes).

To successfully complete 3D Secure you will need to enter – password (case sensitive) on the 3D Secure page.

If you would like to test the other 3D Secure responses that can be sent you will simply need to enter :

• A:D:06 – The Cardholder is not enrolled in the 3D Secure scheme and will return the 3DSecureStatus=ATTEMPTONLY
• U:N:06 – The 3D Secure authentication is not available and will return the 3DSecureStatus=INCOMPLETE
• E:N:06 – An error occurred during the 3D Secure authentication and will return the 3DSecureStatus=ERROR

By using these passwords you will be able to complete and test all other responses 3D Secure can return to you.