The SIBS Payment Gateway exposes a REST-based API that allows merchant systems to create payments, perform post-payment operations, and query transaction status.

All interactions with SIBS Payment Gateway use standard HTTP semantics and exchange data using JSON-formatted requests and responses.

API Interaction Model

Most SIBS Payment Gateway API calls are synchronous from an HTTP perspective. However, payment execution may involve asynchronous processing, depending on the payment method and execution flow.

API responses reflect the immediate result of the request, while the final transaction outcome is communicated through status updates and notifications when applicable.

Base URLs

The URL to the API service depends on the target environment:

• Sandbox: https://spg.qly.site1.sibs.pt/api/v2
• Live: https://api.sibspayments.com/api/v2

The API version is included in the base URL. All examples in this documentation refer to version v2 of the SIBS Payment Gateway API.

Making API Requests

o make a REST API request, combine:

• an HTTP method (GET or POST)
• the API base URL
• a resource URI
• the required HTTP request headers

Optionally, GET requests may include query parameters to filter results, limit the size of responses, or control sorting. Most POST requests require a JSON request body.

Example Request

The following example retrieves the current status of an existing payment using its unique identifier.

curl -v -X GET "https://api.qly.sibspayments.com/sibs/spg/v2/payments/s2SUPFxhGNyyNu2bsG0B/status" \
--header "X-IBM-Client-ID: b824198a-321c-4f53-9bcb-832281d95735" \
--header "Authorization: ••••••"
--header "Accept: application/json"
--header "Content-Type: application/json"

HTTP Request Headers

All API requests to the SIBS Payment Gateway must include a set of mandatory HTTP headers.

Accept

Defines the response format returned by the API.

For all operations that return a response body, the value must be:

Accept: application/json

Authorization

Authenticates the request and authorizes access to the SIBS Payment Gateway API.

Authorization: ••••••••••••••••••••••••••••••

The authorization token is generated through the SIBS Backoffice Portal, under SIBS Payment Gateway 2.0 → Credentials

X-IBM-Client-ID

Identifies the merchant application making the request.

X-IBM-Client-ID: ••••••••••••••••••••••••••••••

The Client ID is provided by the SIBS Onboarding team, and is assigned to you as follows:

• in Sandbox environment, the Client ID is assigned to you by our Onboarding team, as soon as your sandbox account is approved
• in the Live environment, the Client ID is assigned after the technical integration is validated and the commercial setup with the financial partner is completed

Client IDs are environment-specific and cannot be reused across environments.

Content-Type

Defines the request format used for operations that include a request body.

Content-Type: application/format

TLS Setup

Connections to the SIBS Payment Gateway must use TLS version 1.2 or higher.

Client requests using lower TLS versions will be rejected. This requirement ensures secure communication between merchant systems and SPG.