Follow the instructions below to implement the Payment Form and start accepting payments seamlessly.

Step 1: Create an order

This step describes how to create an order once your shopper is ready to pay.

The available endpoint destination URL:

Regarding the required data to create the order, the process is simple, and it requires only a few actions:

Action 1: Define the header and add merchant and customer information

Action 2: Add transaction information to your order

Action 3: Configure Webhooks for transaction updates

Action 1: Define the header and add merchant and customer information

Check below the full description of the required data to start creating your order.

Header parameters

Request parameters

For logged in users the CustomerName and CustomerEmail elements are Mandatory. This will prevent the user from having to fill them in again in the payment form.

Action 2: Add transaction information to your order

Now, it is time to include your transaction information based on the payment methods you want to render in your paywall.

Request parameters: application/json

Check how to perform a one-time purchase or a pre-authorised capture.

Action 3: Configure Webhooks for transaction updates

In this step, you will learn to set up webhooks to automatically receive with real-time transaction updates, keeping your payment status information current.

Here is an example of how to create an order.

Request body:

{
    "merchant": {
        "terminalId": 24,
        "channel": "web",
        "merchantTransactionId": "Order Id: 5hraff455o",
        "transactionDescription": "transaction short description",
        "shopURL": "https://mytest.e-shop.pl/"
    },
    "transaction": {
        "transactionTimestamp": "2023-05-16T10:33:43.587Z",
        "description": "transaction statement description",
        "moto": false,
        "paymentType": "PURS",
        "amount": {
            "value": 50.5,
            "currency": "PLN"
        },
        "paymentMethod": [
            "CARD",
            "BLIK",
            "PBLKV"
        ]
    }
}

Step 2: Create the payment form

To create the payment form you just need to add the following lines of HTML/Javascript to your page and populate the following variables that you got in response from the first step:

• The checkout’s transactionID that you got in the response from the first step:

<script src="https://stargate-cer.qly.site1.sibs.pt/assets/js/widget.js?id={transactionID}"></script>

The formContext that you get in response from the first step and a formConfig:

<form class="paymentSPG" spg-context="{formContext}" spg-config="{formConfig}"></form>

The formConfig is necessary for you to be able to create the form correctly.

formConfig -> spg-config=”{formConfig}”

{
  "paymentMethodList": [],
  "amount": {
    "value": 50.50,
    "currency": "PLN"
  },
  "language": "en",
  "redirectUrl": ""
}

The attribute attr.spg-config is a JSON in a string format with the follow parameters:

You also have the option to add a formStyle to personalize your payment form. For more in-depth information, please go to Customized Form.

After the payment has been processed, a page displaying the transaction status is presented, and the customer is then redirected to the redirectUrl defined.

Below you can see the Payment Form (default look), into which customers can enter the details of the selected payment method and finalize the transaction:

Step 3: Get the payment status

You can check the status of your transaction making a GET request.

GET {transactionID}/status

Request URL:

https://stargate-cer.qly.site1.sibs.pt/api/v1/payments/{transactionID}/status

Request Headers:

Authorization: ‘Bearer <AuthToken>’
X-IBM-Client-Id: ‘<ClientId>
Content-Type: application/json