Direct Payment

Overview.

The provided API documentation details the payInvoice endpoint within the Paylink API framework. This specific endpoint is designed for merchants, enabling them to create invoices and accept online payments through the Paylink gateway. The integration process facilitates the collection of card information directly from customers. This information is then utilized for processing payments on your webpage. Notably, this method provides immediate results regarding the payment status, eliminating the need for webpage redirections.

Important Note

To request activation of the direct payment feature, adherence to Payment Card Industry Data Security Standards (PCI DSS) is mandatory, and obtaining PCI DSS certification is essential. Compliance with these standards is a legal requirement. Non-compliance not only endangers customer data but also exposes you to the possibility of substantial penalties.

Once you have ensured compliance and obtained the necessary certification, please reach out to your account manager or sales representative to enable the Direct Payment feature.

🚧

Available Payment Methods for Direct Integration

It's essential to be aware that not all Payment Methods support the Direct Payment feature. For detailed information, please consult with your account manager.

Environment

Paylink has two environments which are testing and production environments. The base server link of both environments are:

📘

Testing:

The testing server base is https://restpilot.paylink.sa.

📘

Production:

The production server base is https://restapi.paylink.sa.

Authentication

This endpoint requires authentication using a bearer token provided by RestPilot Paylink. The token should be included in the Authorization header of the request.

Endpoint

POST /api/payInvoice

Request Headers

{
  "Authorization": "Bearer [id_token]",
  "Accept": "application/json",
  "Content-Type": "application/json"
}

Request Body Parameters

Creating an invoice requires information on the new invoice, such as the amount, callback URL, and client email. The following table describes the body parameters.

Product Object Details

An example of the request is as follows:

{
  "amount": 5,
  "callBackUrl": "https://www.example.com",
  "clientEmail": "[email protected]",
  "clientMobile": "0509200900",
  "clientName": "Zaid Matooq",
  "note": "This invoice is for VIP client.",
  "orderNumber": "MERCHANT-ANY-UNIQUE-ORDER-NUMBER-123123123",
  "card":{
    "expiry": {
      "month": "04",
      "year": "28"
    },
    "number": "4111111111111111",
    "securityCode":"446"
  },
  "products": [
    {
      "description": "Brown Hand bag leather for ladies",
      "imageSrc": "http://merchantwebsite.com/img/img1.jpg",
      "isDigital": true,
      "price": 150,
      "qty": 1,
      "title": "Hand bag"
    }
  ]
}

Success Response

If the add invoice request success. The response details are as follows:

Failure Response:

If any failure occurred, the response details are as follows

Important Note

📘

Invoice minimum amount

The minimum invoice amount in the Paylink system is SAR 5.00.

🚧

Important use of GetInvoice in server side

Merchant's application must perform this endpoint on the server-side. Then send the resulting response to the client-side. If this endpoint is used in the client-side, then its result must be verified and confirmed using GetInvoice endpoint from the server-side to check the orderStatus equal to piad and the amount paid.

Try the endpoint

For more detail about the endpoint and to try it out, please click here.