Finding API credentials for Payeezy gateway
In order to use your Payeezy account with OwnerRez, there are a set of API credentials that you will need to retrieve from Payeezy and store in OwnerRez.
Once you've added the Payeezy payment method in OwnerRez, you will notice that we ask you for a set of four fields at the top of the page:
- Gateway ID
- Gateway Password
- Key ID
- HMAC Key
These items are provided to you by Payeezy and can be found in the Payeezy gateway terminal.
However, these numbers are a bit complicated to find and require some specific steps. Please follow the following instructions exactly.
Login to the Payeezy gateway terminal and click on the Administration tab on the far top-right side.
Then find and click the Terminals tab on the left side.
This will load the "terminals" that First Data has created for you.
Typically, you'll have a terminal for MOTO, ECOMM and RETAIL. MOTO is for transactions keyed in manually (such as over the phone), ECOMM is for online or "card not present" processing and RETAIL is for "card present" or swiping that you would do in a traditional retail point-of-sale setting. For our purposes, ECOMM is the one you want to use.
Click on the terminal for ECOMM.
Once the ECOMM terminal opens, you'll see a number of tabs and options.
Under the Detail tab, which should be the panel you're looking at already, you'll see the "Gateway ID". That's the first number you need. Copy that one over into your OwnerRez payment method.
Then look down the page a bit and you'll see the next one called "Password". That's the Gateway Password.
This one is a bit tricky. Payeezy doesn't show you the numbers directly. You have to use the Generate link, next to it, to create a new password. Once you do this, the password will be shown to you.
You need to make sure, first of all, that you copy the new password into your OwnerRez payment method. Then, make sure you click the Update button at the bottom of the Payeezy page to save the new password. It's very important that you save after generating or the new password won't work and OwnerRez will have the wrong number.
If you forget to copy the new password to OwnerRez or forget to save it in Payeezy, you'll have to start the process over and generate another one.
Please note: every time you generate a new password and save, any software integration that does not have the new password (any other shopping carts or software programs that use your Payeezy account) may stop working.
Next, you need to click on the API Access tab. That's on the right side of the terminal options.
Once the API Access tab opens, you'll see the last two fields, Key ID and HMAC Key right at the top of the panel.
The Key ID is shown in plain view - copy that directly over into the OwnerRez payment method.
The HMAC Key is presented like the Gateway Password. You'll have to use the Generate link to create a new one, copy the new one to OwnerRez and then click the Update button back in Payeezy to save it. Make sure to save it after copying the new one!
That's it! You now have your API Credentials in OwnerRez and can finish filling out the payment method. Make sure to save the payment method on the OwnerRez side too.
Test, Test, Test
After creating the payment method in OwnerRez, use the Test Credentials button to see if everything validates. This sends a request to Payeezy with your API credentials. We check the response that Payeezy sends back to see if it looks right.
There is a chance that your Key ID and HMAC Key are entered wrong and yet the Test Credentials still validates. This is due to how the credentials are used by Payeezy. Please do a test transaction using a real credit card. There is no better way of testing your API Credentials then running a real credit card. To do that, create a manual booking, collect a payment using your personal credit and a small amount (say $5). Once it goes through, use the Void & Delete option on the payment to void the credit card payment. Then cancel or delete the booking. That will tell you definitively that everything is good to go.
- Page-Specific Help
- Getting Started
- Recommended Reading