Ready to integrate Yoco Payment Gateway with your hosting platform? We’re here to help you navigate the process!
The exact steps for payment gateway integration will depend on the website or hosting platform you’re using. However, there are several common steps, and we’ve broken down specific steps for each of our integration partners.
Getting started with Yoco Payment Gateway
The first step, is understanding how the web platform you’re using will affect the process, and being ready to navigate your settings:
API keys
An API key is a unique code used to identify and authenticate users, developers or applications trying to access an application programming interface or API (in this case, the Yoco Checkout API). API keys form an integral part of setting up the secure payment gateway integration on your website.
Note: Shopify users don’t need to use API Keys for their Yoco plugin.
You can get your API keys by logging into your Yoco Mobile/Web App here.
Go to the Sales tab and click on the Payment Gateway tile.
1. Test keys
Test keys allow you to safely test the integration of the Yoco Payment Gateway on your website. They can be used with test cards (details are provided in your Portal) to complete transactions where no money changes hands.
💡 Only test cards work in Test mode. And test transactions won’t appear in the Portal.
2. Live keys
Start using live keys as soon as you’re finished testing and are ready to switch to Live mode and start accepting real transactions from customers.
💡 Only real credit cards can be used with live keys.
3. Public and secret keys
In Test and Live mode, we provide two keys – a public key and a secret key. The public key is like your ID number; it’s unique to you and is only visible to others under certain circumstances. The secret key is like a password; it should never be revealed and should be securely stored on your server. Both keys must be entered for the integration to succeed.
Accessing API keys for integration
Please note: Shopify users don’t need API Keys for the Yoco plug-in.
To obtain your API keys, log in to your Yoco Web App, head to the ‘Sales’ tab and click on the ‘Payment Gateway’ tile.
Need help getting set up? Refer to our troubleshooting guide.
Reconciling your online transactions with Yoco Payouts
Matching your Checkout API payments with daily Yoco payouts is essential for accurate financial records. Here's how to do this using the Yoco Mobile/Web App, making sure all your successful transactions are correctly recorded and downloaded.
Step 1: Keep your Checkout ID
Make a note of the checkout ID that’s provided when you create a checkout with the Checkout API – you’ll need it for reconciling your transactions with your daily payouts.
Step 2: View your payouts
You can view all your Yoco Payouts on the Yoco Mobile/Web App here.
Here, you can see all your payout records and track when your next payout will be settled. Your payout history can be exported for your own records for accounting, and you can also click on each individual payout to see a list of the individual card transactions that were included in that particular settlement amount.
Click here for more on how Yoco fees, balance and payouts work together.
Step 3: Choose the payout to reconcile
Select the specific payout you want to reconcile by clicking on it. You'll then be directed to the payout details page.
For a payout that's still being processed, you'll see a processing icon in the details screen.
Step 4: Export the payout records
From your Payouts history page in the Money tab, you can choose to download a record of any of your payouts by selecting the date or date range. Once you've filtered your records to narrow in on the payouts you want to reconcile, click on the download icon in the top right corner of your screen.
💡The download icon looks like this:
Your payout records will download to your computer in CSV. Format. You’ll be able to access them from your Downloads folder.
Step 5: Match transactions with payouts
Open the downloaded file.
Look for the ‘Online Reference’ column which contains unique IDs (for example, ch_ngopqZ91r65hl8Osp2IPDrxB) for each payment.
Use this ID to cross-reference and match the successful transactions.
Step 6: Reconcile your processed payments
Refer to the payout report, which only includes successful transactions that have been paid out or subtracted for refunds.
For each transaction, check whether the ‘Online Reference’ in the payout report matches the Checkout ID provided by the API response data.
If there’s a match, mark the transaction as successfully reconciled.