Skip to content
GPAS Docs

X-Parent-System-Id

X-Parent-System-Id

Overview

The X-Parent-System-Id header represents a unique identifier of the GPAS integration in the operator’s system. It must be provided for its configuration and will be sent as a parameter in the header of the message.

Purpose

The X-Parent-System-Id serves several important functions:

  1. Integration Identification: Uniquely identifies the GPAS integration within the operator’s system
  2. Configuration Mapping: Allows the operator’s system to apply the correct configuration for the specific GPAS integration
  3. Request Routing: Helps route requests to the appropriate processing logic
  4. Audit Trail: Facilitates tracking and auditing of requests from different integrations

Format

The X-Parent-System-Id is typically a short alphanumeric string, for example: BL13GT

Configuration

The X-Parent-System-Id value is assigned during the initial setup of the integration between GPAS and the operator’s system. This identifier should be stored securely and used consistently across all API calls.

Implementation Requirements

When implementing the OAS API, ensure that:

  1. All incoming requests from GPAS are validated to include a valid X-Parent-System-Id
  2. The X-Parent-System-Id is used to retrieve the appropriate configuration for processing the request
  3. If an invalid or missing X-Parent-System-Id is detected, an appropriate error response is returned

Error Handling

If an invalid X-Parent-System-Id is provided, the OAS should return an error response. While there is no specific error code defined for this in the standard error responses, it would typically be handled as a system error:

  • HTTP Status Code: 400
  • Error Code: 1001
  • Error Type: SYSTEM_ERROR
  • Message: “Invalid system identifier”

Example Usage

In every API call from GPAS to the OAS, the X-Parent-System-Id will be included in the headers:

POST /sessions?walletId=2sdf1sd
HEADER
Authorization: Bearer <AuthToken>
x-parent-system-id: BL13GT
x-signature: 8F0F3379F1C6CC24DF5A4DC2A937061102487C46

The OAS should extract this header and use it to identify the specific GPAS integration making the request.