Connect a payment gateway

Take card, Apple Pay, BenefitPay, KNET and mada payments into your own merchant account: connect in test mode, make a test payment, then go live.

How toUpdated

Connect a gateway so that customers can pay their payment links online. The money goes straight to your own merchant account, and each payment is recorded on the booking by itself. Start in test mode, check one payment from end to end, then switch to live.

The Online payments card with the provider and card brands

Before you start

  • Your role must allow changing settings.
  • A merchant account with one of the supported gateways: Tap, Stripe, Credimax, AFS, another bank on the Mastercard Gateway (MPGS), or BENEFIT. Ask the gateway for test (sandbox) keys as well as live keys.
  • To try the flow without any gateway, choose Test gateway (no real money): there is nothing to fill in.

Connect in test mode

  1. Open Settings → Connections and find the Online payments card.
  2. Turn on the switch Use this connection on the card and choose your gateway in Provider.
  3. Open Where to find these details and follow the steps. Open the dashboard opens the gateway's dashboard.
  4. In Mode, keep Sandbox (test). The chip shows Test mode: no real money.
  5. Paste the test details for your gateway:
    • Tap: Secret key (sk_test_…) and Publishable key.
    • Stripe: Secret key (sk_test_…). Under Advanced settings (optional), paste the Webhook signing secret (whsec_…) after step 6.
    • Credimax, AFS or another bank on MPGS: Merchant ID (test merchants start with TEST), API password and Name shown on the payment page. Under Advanced settings (optional): Webhook notification secret, and for another bank its Gateway address.
    • BENEFIT: Tranportal ID (terminal), Tranportal password and Terminal resource key (32 characters).
  6. Press Copy next to Webhook address to paste in your gateway dashboard and add that address in the gateway's dashboard (for BENEFIT, give it as your response address if they ask).
  7. Press Save. The card shows Connected and Test mode.
  8. Press Test connection and wait for It works., for example Tap accepted the credentials.

Make a test payment

  1. Open a test booking and create a payment link for a small amount.
  2. Open the link. The payment page shows Test mode: this gateway is in sandbox, so no real money moves. Use the gateway’s test cards. With the test gateway, 4242 4242 4242 4242 pays and 4000 0000 0000 0002 is declined.
  3. Pay with a test card. You come back to the payment page, which shows Confirming your payment with the bank…, then Payment received. Thank you! with the receipt.
  4. Check the booking: the payment is recorded under the online payment method and the balance went down.

Go live

  1. On the Online payments card, switch Mode to Live. The chip shows Real payments.
  2. Replace the test keys with the live keys (for Tap and Stripe, sk_live_…).
  3. Check the webhook address is also added to the live side of the gateway's dashboard.
  4. Press Save, then Test connection.

After you connect

  • Payment links, deposit links and the customer's trip page take payments through your gateway. The payment page shows the cards and wallets under Customers can pay with.
  • Each payment is recorded on the booking by itself, with the gateway's reference. Do not record it again.
  • If the customer closes the page before coming back, the gateway confirms the payment through the webhook address, and the system also checks with the gateway every few minutes. The customer is asked not to pay twice while the bank confirms.
  • The receipt goes out on the channel set in Settings → Preferences → Send online payment receipts by.
  • Refunds to the card are made from the booking and go back through the same gateway.

Warning

In Live mode customers are charged for real. If you change to another gateway later, payments taken through the old one can no longer be refunded from the system: refund them from the old gateway's dashboard and record a manual refund.

If something goes wrong

  • A warning under It works.: These look like live credentials, but the connection is set to sandbox. (or the other way round). Make Mode match the keys and save. The answer is in your screen's language. Under it, What the gateway said: shows the gateway's own words in full (usually in English), so you can pass them to the gateway's support.

  • It did not work: Tap did not accept the credentials. Check the keys or password and the mode (sandbox or live). (with your gateway's name), and under it, for example, … rejected the credentials. Check the keys in Settings → Connections.: the keys are wrong, or are test keys in live mode.

  • It did not work: …: some details are missing or wrong. See what the gateway said below., with for example:

    • Add the merchant ID and API password first. or Add the tranportal ID and password first.: fill in the missing details and save.
    • The BENEFIT terminal resource key must be 32 characters. Check it in Settings → Connections.
  • It did not work: … could not be reached. Check the gateway address and try again., with for example Could not reach … Check the gateway address in Settings → Connections or try again later. or … did not answer in time. Please try again.: check the gateway address under Advanced settings (optional), or try later.

  • It did not work: … refused the connection test.: read what the gateway said and fix that detail, or send it to the gateway's support.

  • The gateway address must be a public internet address or The gateway address must start with https:// when you save: copy the exact address from the gateway.

  • Save your changes first, then test the connection: press Save before Test connection.

Related articles