Skip to content
Menu

PAYMENT GATEWAY

[THK] F.9.1 Postman Collections Structure

Overview

The official SIBS Postman collections are structured to reflect the organization of SPG API operations, providing a clear and consistent way to navigate and understand requests.

These collections group requests according to payment methods, operation types, and predefined scenarios, ensuring a structured representation of the available API capabilities.

Collection Organization

The SPG Payment Gateway Collection is organized into logical groups primarily based on payment methods and operation types, including:

  • MB WAY
  • Multibanco Reference
  • Card
  • Backoffice Operations

Within each group, requests represent individual API operations.

For example:

  • SPG Payment Gateway Collection → Card → Checkout Card
  • SPG Payment Gateway Collection → Card → Purchase – Server to Server

For complete execution flows using these requests, refer to F.1 End-to-End Integration Examples.

This organization provides a clear structural representation of the SIBS SPG API.

In addition to method-specific groupings, certain operations such as status inquiry appear across multiple groups, reflecting their use across different payment methods.

Operation-Level Structure

Each request in the collection corresponds to a specific SPG API operation and includes the necessary method, endpoint, headers, and payload required for execution.

This ensures that each request directly maps to a specific API capability exposed by SPG.

For detailed information on request payloads, headers, and field semantics, refer to F.2 Requests and Responses (Annotated).

Sandbox Collection Structure

The SPG Sandbox Collection is organized by:

  • Payment method (e.g., MB WAY, Card, Multibanco)
  • Predefined scenarios within each method

Examples include:

  • SPG Sandbox Collection → MB WAY → MB WAY – Success
  • SPG Sandbox Collection → MB WAY → MB WAY – Declined
  • SPG Sandbox Collection → CARD → Card – Success
  • SPG Sandbox Collection → MULTIBANCO → Multibanco – PAID

Each scenario contains a set of requests representing API operations organized according to the available interactions within that scenario.

The collection also includes additional grouped scenarios covering specific operational cases and API behaviors.

For guidance on reproducible testing using these scenarios, refer to F.8 Sandbox Reproducible Examples.

Final Consideration

The Postman collections provide a structured representation of the SIBS SPG API, grouping requests by payment method, operation type, and predefined scenarios.

A correct understanding of this structure enables integrators to:

  • Navigate the collections effectively
  • Identify the appropriate requests for each operation
  • Understand how API interactions are organized and related within the collections

By following the structure provided in the collections, integrators ensure that API interactions are consistent with the defined SPG interfaces and available scenarios, enabling reliable and structured validation of integration behavior.

Privacy Overview

This website uses cookies so that we can provide you with the best user experience possible. Cookie information is stored in your browser and performs functions such as recognising you when you return to our website and helping our team to understand which sections of the website you find most interesting and useful.

Strictly Necessary Cookies

Strictly Necessary Cookie should be enabled at all times so that we can save your preferences for cookie settings.