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.

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.
For more information, see createPaymentRequest.
3. 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.
For more information, see Setting up the callback pages.
4. Use the Merchant Information Interface for post-processing, such as capturing and releasing reservations, or downloading funding lists.
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.

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. Make a HTTP POST request - using basic auth - with minimum required parameters (terminal, shop_orderid, amount, currency). We'll provide an example using cURL which can be used from the command line of any operating system.
   From the following example replace USERNAME, PASSWORD and YOUR_TERMINAL_PLACEHOLDER before making the request: (the username and password should be the same you use to log in to testgateway)

   curl -u "USERNAME:PASSWORD" -L -X POST 'https://testgateway.altapaysecure.com/merchant.php/API/createPaymentRequest' \
   -d 'terminal=YOUR_TERMINAL_PLACEHOLDER' \
   -d 'amount=250' \
   -d 'currency=EUR' \
   -d 'shop_orderid=0001'

   The XML result is returned.

5. Copy and paste the resulting <Url> value into the browser.

<Url>
https://testgateway.altapaysecure.com/eCommerce/API/requestForm?pid=1459b46a-9abe-4636-a0cf-2553b6e762e4
</Url>

6. On the payment page, enter the following details:

   card number	4111111111111111
   expiration date	pick a valid date
   CVC code	123

7. Submit the payment. The default success page is displayed.
8. Log in to the Merchant Information Interface again, and click Operations > Search.
9. Select your test terminal from the Terminal drop-down menu and click the Apply button to list all transactions.
   
10. Make a note of the Payment ID.

Capture the payment and view the XML response

1. As before, make a POST HTTP request to the testgateway, replacingPAYMENTID with the Payment ID of the transaction you just created:

   curl -u "USERNAME:PASSWORD" -L -X POST 'https://testgateway.altapaysecure.com/merchant.php/API/captureReservation' \
   -d 'transaction_id=PAYMENT_ID' 

2. The XML response is displayed, showing you details about the captured payment.
You can also View the XML response in the Merchant Information Interface.

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.