Yoco Payment Gateway: User Guide
Updated over a week ago

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.

How do I get started using Yoco Payment Gateway to take payments on my website?

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:

Shopify users don’t need to use API Keys for their Yoco plugin.

Screenshot 2022-06-10 at 12.41.09.png

You can get your API keys by logging into your Business Portal here. Go to ‘Sell Online’ on the menu, and click on ‘Payment Gateway’.

An API key is a code used to identify and authenticate an application or user. They also act as a unique identifier and provide a secret token for authentication purposes. They form an integral part of setting up your secure payment gateway integration on your website.

Test keys

Test keys are for safely testing out how the integration of Yoco payment gateway works on your website. You can test out transactions without any actual money changing hands.

Test keys can only be used with the test card details, also provided in your Portal — real credit cards won't work in test mode! And, these test transactions won't appear in the Portal.

Live keys

Live keys are for when all your testing is complete, and you’re ready to take real transactions from real customers. When you’re ready to go live, swap to using Live keys.

You can only use real credit cards with live keys - test cards won’t work.

Public and Secret Keys:

For both Test and Live mode, we provide a public key and a secret key. You’ll have to enter both for the integration to work. You can think of the public key almost like your ID number. It's only visible to others under certain circumstances and is unique to you. But the secret key is like a password that no-one else should ever see, and should be securely stored on your server.

Struggling to get set up? Check out our troubleshooting guide here.

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 Yoco Portal's Export feature, making sure all your successful transactions are correctly recorded.

Step 1: Keep your Checkout ID

When creating a checkout using the Checkout API, make sure to keep the checkout ID that will have been provided in the response. You'll need this ID later for reconciling your transactions with your daily payouts.

Step 2: Go check out your payouts

  1. Log in to your Business Portal.

  2. Navigate to the "Sales and Refunds" section.

  3. In the "Sales and Refunds" section, click on "Payouts."

  4. You'll see a list of your recent payouts in the "Payout History."

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.

Step 4: Export the payout records

  1. On the bottom of the payout details page, you'll find an "Export" button.

  2. Click on it to start the export process.

  3. The system will generate a CSV file containing the payment records for the payout.

Struggling to export? Get trouble steps here.

Step 5: Match transactions with payouts

  1. Once the download is complete, you can open the file.

  2. In the exported file, you'll see various columns containing payment information, including the "Online Reference" column.

  3. The "Online Reference" column contains unique IDs for each payment.
    For example, "ch_ngopqZ91r65hl8Osp2IPDrxB."

  4. Use this ID to cross-reference and match the successful transactions.

Step 6: Reconciliation

  1. Refer to the payout report, which will only include successful transactions that have been either paid out or subtracted for refunds.

  2. For each transaction, check if the "Online Reference" in the payout report matches to the Checkout ID provided by the API response data.

  3. If there is a match, mark the transaction as successfully reconciled.

By following these steps, you can successfully reconcile your processed payments against your daily payout, ensuring that your financial records are accurate and up-to-date.

Did this answer your question?