Connect Checkout.com
Take credit and debit card payments through your Checkout.com account, with subscriptions, order bumps and one-click upsells.
Checkout.com processes credit and debit cards for accounts opened in about 60 countries across Europe, the Americas, the Middle East and Asia-Pacific. Connected to Vipter, it handles one-time sales, subscriptions, order bumps and one-click upsells. Checkout.com does not do PIX or installments through Vipter.
Before you start
- A Checkout.com account. To try it first, a sandbox account works.
- Access to the Checkout.com dashboard with permission to create API keys and webhooks.
- The Admin or Owner role in the Vipter project.
- Room in your plan for one more active connection. The providers screen shows how many you already use.
Step 1: copy your account details from Checkout.com
Vipter asks for three details from your account. Copy all three from the same environment: all from the sandbox to test, or all from production to sell.
- Secret key: in the Checkout.com dashboard, open DevelopersKeys and create an API key. The sandbox secret key starts with
sk_sbox_and the production one withsk_. It is shown only once: copy it right away. - Processing channel ID: open SettingsProcessing channels and copy the ID of the channel that will receive the sales. It starts with
pc_. - Subdomain prefix: under DevelopersOverview, your account's API URL looks like
https://abcd1234.api.checkout.com(.api.sandbox.checkout.comin the sandbox). The prefix is the 8 characters before.api.
Keep the key safe
The secret key gives full access to your Checkout.com account. Paste it only into Vipter. If it leaks, revoke it in Checkout.com, create another one and replace it in Vipter with the Replace keys button.
Step 2: create the connection in Vipter
- In the Vipter dashboard, open PaymentsProvidersCheckout.com.
- Click New connection. If the store has no Checkout.com account yet, the form is already open.
- Fill in the fields:
| # | Field | What to paste |
|---|---|---|
| 1 | Account name | A name to recognize the account, such as "Checkout.com Europe". It appears in the payment flows. |
| 2 | Account country | The country where the Checkout.com account was opened. It cannot be changed later. |
| 3 | Secret key | The secret key you copied in step 1 (sk_sbox_ or sk_). |
| 4 | Processing channel ID | The processing channel ID, which starts with pc_. |
| 5 | API subdomain prefix | The 8 characters before .api in your account's API URL, lowercase letters and digits only. |
| 6 | Test connection | On, it only accepts the sandbox key (sk_sbox_). Turn it off to charge for real with the production key. |
- Click Save and get the webhook URL. Vipter checks the details with Checkout.com before saving. If any of them is wrong, nothing is stored and the error shows in the form.
Test mode starts on
The Test connection switch starts on so the first connection does not charge anyone by mistake. To sell, create the connection with it off and the production key.
If this is the store's first card account, Vipter creates the credit and debit card payment flows pointing to it on its own. The store can take payments after step 4.
Step 3: register the webhook in Checkout.com
Through the webhook, Checkout.com tells Vipter what happens after the purchase, such as confirmed payments, refunds and disputes. Each notice is signed with a key you set on the webhook, and Vipter refuses the notices until it has that key.
- After saving, the connection card shows the Webhook URL. Copy the address.
- In Checkout.com, open DevelopersWebhooks and create a new webhook.
- Paste the URL you copied in item 1 and select the payment events.
- Generate or set the webhook's Signature key, copy the value and save the webhook.
- Back in Vipter, paste the key on the connection card and click Save secret.
| # | Field | What to paste |
|---|---|---|
| 1 | Webhook signature key | The Signature key of the webhook you created in Checkout.com. |
Step 4: test the connection
- On the connection card, click Test. Vipter queries Checkout.com with the saved details.
- Make a test purchase on an offer's checkout, with one of the test cards from the Checkout.com documentation (the Test cards page).
It worked if
The message Connection OK. appears and the test purchase shows up in SalesTransactions as paid.
Common problems
-
Your plan allows N active connector(s). Upgrade to add more.
The plan has reached its limit of active connections. Deactivate a connection you no longer use or change plans in Vipter plan.
-
Invalid value
One of the three details does not have the Checkout.com format: the key starts with
sk_, the channel withpc_, and the prefix has exactly 8 lowercase letters or digits, with nohttps://and no dots. -
Checkout.com refused the key
The key belongs to another environment: an
sk_sbox_key only works with test mode on, and a production key only with it off. Also check that the prefix and the channel belong to the same account and environment as the key. -
Payments confirmed in Checkout.com do not change status in Vipter
The webhook was not registered, or the Signature key saved in Vipter is not the webhook's. Check both and save the key again on the connection card.
What to do next
- Review the payment flows to decide which account charges each payment and which one is the fallback.
- See how payments work to compare Checkout.com with the other providers.