Create Payment Link

Step by Step

In this chapter you will learn how to create a payment link, consume it by using our checkout solution and checking the payment status.

In the figure below you can see the payment link flow in AceHub:

AceHub - Payment link flowAceHub - Payment link flow

AceHub - Payment link flow

Step 1 - Merchant creates a payment link

Creating links is done via a simple call to our API. You are able to set the amount and currency as well as the expiration time of the link. In this call you can also include unique identifiers, such as a tracking ID and a custom description  or the customer's details, allowing you to easily match the order once the payment is completed. 

To create a payment link, the Merchant must send a POST request to the /links endpoint. The response received contains an "Id" and the "Url" of the payment link created. To read more information please check the /links page.

The following code snippets are examples of payment link creation request/response.

{
  "header": {
    "businessId": "{businessId}"
  },
  "body": {
    "transaction": {
      "trackingCode": "{UniqueTrackingCode}",
      "authorizationMode": "PAYMENT",
      "amount": 10.0,
      "currencyCode": "EUR",
      "type": "SINGLE",
      "purchaseId": "your_purchaseId",
      "invoiceId": "your_invoiceId",
      "descriptor": "your_descriptor"
    },
    "link":{
      "duration": "P7D",
      "returnUrl": "http://YourInterceptorUrl.com",
      "brandIds":[1010,1011,1013,1020,1023,1030,1040,1050,1060,1090,1210,3010,3020,3025,4010,6010,5020,8010]
    }
  }
}
{
    "result": 0,
    "description": "Ok",
    "header": {
        "requestTimestamp": "2019-01-01T12:00:00Z"
    },
    "body": {
        "link": {
            "linkId": "{linkId}",
            "status": "READY",
            "redirect": {
                "method": "GET",
                "url": "https://stagconnect.acehubpaymentservices.com/gateway/v3/web/paymentlinks/{linkId}"
            },
            "brandIds": [
                1010,
                1011,
                1013,
                1020,
                1023,
                1030,
                1040,
                1050,
                1060,
                1090,
                1210,
                3010,
                3020,
                3025,
                4010,
                6010,
                5020,
                8010
            ],
            "expirationTime": "2019-01-08T12:00:00Z",
            "tokenize": "FALSE",
            "threeDSecure": false
        },
        "transaction": {
            "amount": 10,
            "currencyCode": "EUR",
            "authorizationMode": "PAYMENT",
            "trackingCode": "{UniqueTrackingCode}"
        }
    }
}
{
    "result": -1,
    "description": "Input error",
    "header": {
        "requestTimestamp": "2019-08-02T08:33:23Z"
    },
    "body": {
        "error": {
            "code": 1002,
            "message": "Invalid property value: body.link.duration."
        }
    }
}
  • The supported list of payment methods (or brands) can be found here

In case of error, you will receive a message with the format from below and specific error code and message. For error code details please check this section.

Step 2 - Merchant share the link with the consumer

You are free to share our links via any channel. You can paste the links via email, SMS, Social Media messages or chat, print your full URL (i.e. MyShop.com/pay/Invoice_12345), a shortened link (i.e. bit.ly/1234nN) or convert the link into a QR code.

As soon as the merchant receives the "Url" from create payment link, the link is available for consumption.

Step 3 - Consumer opens the link and pay

When a consumer opens the link, a checkout form is loaded in the browser allowing the consumer to enter the payment details to complete the transaction. After processing the payment, the consumer is displayed the payment result page.

If the link has expired or it was cancelled by the merchant, an explanatory message is displayed to the consumer.

Step 4 - Merchant gets payment link status

The Merchant check the payment status at any time. The service offers two different way explained below:

  1. Via API: send a GET request to Payment link API endpoint /links/{linkId} to get the status of the payment link. Please check Get Payment Link section for more information.

  2. Via webhooks: merchants are notified about payment transactions via webhooks. TrackingCode and Payment link Id generated in create payment link POST request are included in hooks messages for traceability.

For further details please check webhooks section.

Additionally, a transaction reporting tool is available. Please contact our team to get further details.