Integrating using the Merchant API

To integrate using the Merchant API, you simply set up your payment page to call the createPaymentRequest method, and set up your callback pages.

Initially, you will typically be working against the test environment/gateway. Once your integration is ready, it can be put into production. We use different subdomains, so you should prepare your code so that you can target another URL once the code is ready to be placed into production.
  1. Work through the steps in Getting Started with your Integration to familiarise yourself with the createPaymentRequest method.
  2. Set up your checkout page so that it calls createPaymentRequest with the relevant order information and customer information.
  3. For more information, see createPaymentRequest.
  4. Set up your callback pages (for example, ok, fail, open, and notification) to handle the business logic of the payment. The URLs to the callback pages are passed as parameters on the API call to the createPaymentRequest method.
  5. For more information, see Setting up the callback pages.
  6. Use the Merchant Information Interface for post-processing, such as capturing and releasing reservations, or downloading funding lists.
  7. For more information, see Using the MII.

    Alternatively, you can integrate the Merchant API for the post-processing tasks.

    For more information, see Merchant API Methods.

Getting Started with your Integration

This is a brief "how to" guide, to get you started with your integration, telling you how to manually create a payment request, then capture it, and finally view the XML response of the capture.

Before you get started, make sure you have:

Create a new payment

  1. Log in to the Merchant Information Interface.
  2. Click Home > Terminal Settings. This shows you all of the shops and terminals within your area. Ensure that the correct shop is displayed, and then click on the tab for the terminal you want to use.
  3. Make a note of the terminal name. (The terminal name in the screenshot is Sander Improvement Software AB Test Terminal.)
  4. Paste the following URL in your browser, replacing TERMINAL with your terminal name: 
    https://testgateway.altapaysecure.com/merchant/API/createPaymentRequest?terminal=TERMINAL&shop_orderid=0001&amount=250.0&currency=EUR

    The XML result is displayed.

  5. Copy and paste the resulting <Url> value into the browser.
  6. <Url>
    https://testgateway.altapaysecure.com/eCommerce/API/requestForm?pid=1459b46a-9abe-4636-a0cf-2553b6e762e4
    </Url>
  7. On the payment page, enter the following details:
    card number4111111111111111
    expiration datepick a valid date
    CVC code123
  8. Submit the payment. The default success page is displayed.
  9. Log in to the Merchant Information Interface again, and click Operations > Search.
  10. Select your test terminal from the Terminal drop-down menu and click the Apply button to list all transactions.
  11. Make a note of the Payment ID.

Capture the payment and view the XML response

  1. Paste the following URL in your browser, replacingPAYMENTID with the Payment ID of the transaction you just created:
    https://testgateway.altapaysecure.com/merchant/API/captureReservation?transaction_id=PAYMENTID
  2. Provide your username and password at the prompt, if requested to do so.
  3. The XML response is displayed, showing you details about the captured payment.

You have successfully created a payment request, and captured the resulting reservation. You can also use the Merchant Information Interface to capture reservations. For more information, and instructions, see Capturing and Releasing Payments.

Next Steps

Next, you need to:

  • Set up your checkout page so that it calls createPaymentRequest with the relevant order information and customer information.
  • For more information, see createPaymentRequest.
  • Set up your checkout page so that it calls createPaymentRequest with the relevant order information and customer information.
  • For more information, see Setting up the callback pages.