Worldline Product Override API

Product Override API Controller

Operations 4

GET /issuers/{issuerId}/products/external-products/{issuerProductExternalReference}/product-extension-balancing Retrieve the product extensions' load balancing by issuer product external reference (beta) #
PATCH /issuers/{issuerId}/products/external-products/{issuerProductExternalReference}/product-extension-balancing Override the product extensions' load balancing by issuer product external reference (beta) #
GET /issuers/{issuerId}/card-products/{cardTemplateReference}/card-producer-balancing Retrieve the card producers' load balancing (beta) #
PATCH /issuers/{issuerId}/card-products/{cardTemplateReference}/card-producer-balancing Override the card producers' load balancing (beta) #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/wordline-product-override-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

wordline-product-override-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'The current set of APIs will be available in Q2 2026 on Worldline Global Issuing Platforms.

    Additional APIs are under construction and planned to be available in 2026.'
  version: 2.41.1
  title: Worldline Card Issuing Product Override API
  contact: {}
servers:
- url: https://sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing/api/v2
tags:
- name: Product Override
  description: Product Override API Controller
paths:
  /issuers/{issuerId}/products/external-products/{issuerProductExternalReference}/product-extension-balancing:
    get:
      tags:
      - Product Override
      summary: Retrieve the product extensions' load balancing by issuer product external reference (beta)
      operationId: retrieveProductExtensionLoadBalancing
      description: 'The API allows the parameters of the product extensions'' load balancing to be retrieved. The parameters of the load balancing are used when a new card is requested.

        The main input fields are:

        - The issuer ID

        - The issuer product external reference for which the detail of the product extensions'' load balancing is requested.'
      parameters:
      - name: WL-Correlation-ID
        in: header
        required: false
        schema:
          type: string
      - name: WL-Origin
        in: header
        required: false
        schema:
          type: string
      - name: WL-Username
        in: header
        required: false
        schema:
          type: string
      - name: issuerId
        in: path
        description: Issuer ID
        required: true
        schema:
          type: string
      - name: issuerProductExternalReference
        in: path
        description: Issuer Product External Reference
        required: true
        schema:
          type: string
      responses:
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorApiResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorApiResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundErrorApiResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorErrorApiResponse'
        '502':
          description: Bad gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadGatewayErrorApiResponse'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseEntityProductExtensionBalancing'
      security:
      - basic: []
      deprecated: false
    patch:
      tags:
      - Product Override
      summary: Override the product extensions' load balancing by issuer product external reference (beta)
      operationId: modifyProductExtensionBalancing
      description: 'The API allows a list of pre-defined parameters for a product extensions'' load balancing to be overridden. The parameters of the load balancing are used when a new card is requested.

        The main input fields are:

        - The issuer ID

        - The issuer product external reference for which the changes are required

        - The parameters (profiles or thresholds of a product) to be overridden


        The parameters of the load balancing can be retrieved using the Retrieve the product extensions'' load balancing API.

        The overridden parameters should be consistent with the initial product configuration defined in the system (e.g., the profiles to be updated must exist in the system to be found).'
      parameters:
      - name: WL-Correlation-ID
        in: header
        required: false
        schema:
          type: string
      - name: WL-Origin
        in: header
        required: false
        schema:
          type: string
      - name: WL-Username
        in: header
        required: false
        schema:
          type: string
      - name: issuerId
        in: path
        description: Issuer ID
        required: true
        schema:
          type: string
      - name: issuerProductExternalReference
        in: path
        description: Issuer Product External Reference
        required: true
        schema:
          type: string
      responses:
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorApiResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorApiResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundErrorApiResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorErrorApiResponse'
        '502':
          description: Bad gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadGatewayErrorApiResponse'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseEntityOverrideProductExtensionBalancingResponse'
      security:
      - basic: []
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OverrideProductExtensionBalancingRequest'
  /issuers/{issuerId}/card-products/{cardTemplateReference}/card-producer-balancing:
    get:
      tags:
      - Product Override
      summary: Retrieve the card producers' load balancing (beta)
      operationId: retrieveCardProducersLoadBalancing
      description: 'The API allows the parameters of the load balancing between card producers to be retrieved.

        The main input field is:

        - The issuer ID

        - The card template reference for which the detail of the card producers'' load balancing is requested.'
      parameters:
      - name: WL-Correlation-ID
        in: header
        required: false
        schema:
          type: string
      - name: WL-Origin
        in: header
        required: false
        schema:
          type: string
      - name: WL-Username
        in: header
        required: false
        schema:
          type: string
      - name: issuerId
        in: path
        description: Issuer ID
        required: true
        schema:
          type: string
      - name: cardTemplateReference
        in: path
        description: Card Template Reference
        required: true
        schema:
          type: string
      responses:
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorApiResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorApiResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundErrorApiResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorErrorApiResponse'
        '502':
          description: Bad gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadGatewayErrorApiResponse'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseEntityCardProducerBalancing'
      security:
      - basic: []
      deprecated: false
    patch:
      tags:
      - Product Override
      summary: Override the card producers' load balancing (beta)
      operationId: modifyCardProducersLoadBalancing
      description: 'The API allows for the replacement of the load balancing parameters between card producers.

        The main input fields are:

        - The issuer ID

        - The card template reference for which the changes are requested

        - The parameters to be overridden


        The overridden parameters of the card producers'' load balancing can be retrieved using the Retrieve the card producers'' load balancing API.'
      parameters:
      - name: WL-Correlation-ID
        in: header
        required: false
        schema:
          type: string
      - name: WL-Origin
        in: header
        required: false
        schema:
          type: string
      - name: WL-Username
        in: header
        required: false
        schema:
          type: string
      - name: issuerId
        in: path
        description: Issuer ID
        required: true
        schema:
          type: string
      - name: cardTemplateReference
        in: path
        description: Card Template Reference
        required: true
        schema:
          type: string
      responses:
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorApiResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorApiResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundErrorApiResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorErrorApiResponse'
        '502':
          description: Bad gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadGatewayErrorApiResponse'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseEntityOverrideCardProducerBalancingResponse'
      security:
      - basic: []
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OverrideCardProducerBalancingRequest'
components:
  schemas:
    InternalServerErrorResponseMetadata:
      type: object
      required:
      - correlationId
      - responseDateTime
      - statusCode
      - statusMessage
      properties:
        correlationId:
          type: string
          description: Correlation Identifier
        responseDateTime:
          type: string
          example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
          description: Timestamp when response date was generated
        statusCode:
          type: integer
          format: int32
          example: 500
          description: HTTP status code
        statusMessage:
          type: string
          example: Internal server error
          description: Executed REST API status message
      title: InternalServerErrorResponseMetadata
    ProductExtensionIdentifier:
      properties:
        issuerProductExtensionExternalReference:
          description: External reference of the product extension provided by the issuer and defined for a product (e.g. it can be used when adding cards and accounts to a contract )
          type: string
      title: ProductExtensionIdentifier
      type: object
    ResponseMetadata:
      type: object
      required:
      - correlationId
      - responseDateTime
      - statusCode
      - statusMessage
      properties:
        correlationId:
          type: string
          description: Correlation Identifier
        links:
          description: Metadata Links
          allOf:
          - $ref: '#/components/schemas/Links'
        statusMessage:
          type: string
          example: Executed successfully
          description: Executed REST API status message
        statusCode:
          type: integer
          format: int32
          example: 200
          description: HTTP status code
        responseDateTime:
          type: string
          example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
          description: Timestamp when response date was generated
        timeTakenMs:
          type: integer
          format: int64
          example: 12
          description: Wall clock time required from service to generate the response
      title: ResponseMetadata
    ProductExtensionBalancingPercentage:
      type: object
      properties:
        value:
          type: integer
          description: Value of this percentage for the product extension (e.g. 60 means 60%)
        productExtensionIdentifier:
          description: 'Identifier of the product extension for the percentage '
          allOf:
          - $ref: '#/components/schemas/ProductExtensionIdentifier'
      title: ProductExtensionBalancingPercentage
    OverrideCardProducerBalancingResponse:
      type: object
      properties:
        cardProductIdentifier:
          description: Card template reference used to overide the parameters of the load balancing.
          allOf:
          - $ref: '#/components/schemas/CardProductIdentifier'
      title: OverrideCardProducerBalancingResponse
    BadRequestErrorApiResponse:
      type: object
      required:
      - responseMetadata
      properties:
        responseMetadata:
          allOf:
          - $ref: '#/components/schemas/BadRequestResponseMetadata'
      title: BadRequestErrorApiResponse
    NotFoundErrorApiResponse:
      type: object
      required:
      - responseMetadata
      properties:
        responseMetadata:
          allOf:
          - $ref: '#/components/schemas/NotFoundResponseMetadata'
      title: NotFoundErrorApiResponse
    ApiResponseEntityProductExtensionBalancing:
      x-wl-api-response: true
      type: object
      required:
      - responseMetadata
      properties:
        responseMetadata:
          description: Response metadata
          allOf:
          - $ref: '#/components/schemas/ResponseMetadata'
        data:
          description: Response data
          allOf:
          - $ref: '#/components/schemas/ProductExtensionBalancing'
      description: Issuer response entity
      title: ApiResponseEntityProductExtensionBalancing
    ProductIdentifier:
      type: object
      properties:
        issuerProductExternalReference:
          type: string
          description: Product External Reference provided by the issuer
        productReference:
          type: string
          description: Reference of the product in our system, unique per platform
      title: ProductIdentifier
    OverrideProductExtensionBalancingProfile:
      type: object
      properties:
        name:
          type: string
          description: Name of the profile to override.
        percentages:
          type: array
          description: List of percentages to be applied to select the product extension
          items:
            $ref: '#/components/schemas/ProductExtensionBalancingPercentage'
      title: OverrideProductExtensionBalancingProfile
    OverrideProductExtensionBalancingRequest:
      type: object
      x-wl-patch-request: true
      properties:
        deviceTokensThreshold:
          type: integer
          description: Threshold on the device tokens number
        merchantTokensThreshold:
          type: integer
          description: Threshold on the merchant tokens number
        profiles:
          type: array
          description: The issuer can override the percentages of one or several profiles
          items:
            $ref: '#/components/schemas/OverrideProductExtensionBalancingProfile'
      title: OverrideProductExtensionBalancingRequest
    ForbiddenErrorApiResponse:
      type: object
      required:
      - responseMetadata
      properties:
        responseMetadata:
          allOf:
          - $ref: '#/components/schemas/ForbiddenResponseMetadata'
      title: ForbiddenErrorApiResponse
    NotFoundResponseMetadata:
      type: object
      required:
      - correlationId
      - responseDateTime
      - statusCode
      - statusMessage
      properties:
        correlationId:
          type: string
          description: Correlation Identifier
        responseDateTime:
          type: string
          example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
          description: Timestamp when response date was generated
        statusCode:
          type: integer
          format: int32
          example: 404
          description: HTTP status code
        statusMessage:
          type: string
          example: Not found
          description: Executed REST API status message
      title: NotFoundResponseMetadata
    ApiResponseEntityCardProducerBalancing:
      x-wl-api-response: true
      type: object
      required:
      - responseMetadata
      properties:
        responseMetadata:
          description: Response metadata
          allOf:
          - $ref: '#/components/schemas/ResponseMetadata'
        data:
          description: Response data
          allOf:
          - $ref: '#/components/schemas/CardProducerBalancing'
      description: Issuer response entity
      title: ApiResponseEntityCardProducerBalancing
    UnauthorizedErrorApiResponse:
      type: object
      required:
      - responseMetadata
      properties:
        responseMetadata:
          allOf:
          - $ref: '#/components/schemas/UnauthorizedResponseMetadata'
      title: UnauthorizedResponseMetadata
    Links:
      type: object
      required:
      - self
      properties:
        self:
          type: string
          example: /x/{x}?x=x
          description: Service method URL
        next:
          type: string
          example: /x/{x}?page[offset]=2
          description: URL pagination query parameter next page
      title: Links
    ForbiddenResponseMetadata:
      type: object
      required:
      - correlationId
      - responseDateTime
      - statusCode
      - statusMessage
      properties:
        correlationId:
          type: string
          description: Correlation Identifier
        responseDateTime:
          type: string
          example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
          description: Timestamp when response date was generated
        statusCode:
          type: integer
          format: int32
          example: 403
          description: HTTP status code
        statusMessage:
          type: string
          example: Forbidden
          description: Executed REST API status message
      title: ForbiddenResponseMetadata
    CardProductIdentifier:
      type: object
      properties:
        cardTemplateReference:
          type: string
          description: Reference of the card template used to instantiate a card
      title: CardProductIdentifier
    OverrideCardProducerBalancingRequest:
      type: object
      properties:
        percentages:
          type: array
          description: List of parameters to be applied for card creation and card replacement
          items:
            $ref: '#/components/schemas/CardProducerBalancingPercentage'
        renewalPercentages:
          type: array
          description: List of parameters to be applied for card renewal
          items:
            $ref: '#/components/schemas/CardProducerBalancingPercentage'
      title: OverrideCardProducerBalancingRequest
    InternalServerErrorErrorApiResponse:
      type: object
      required:
      - responseMetadata
      properties:
        responseMetadata:
          allOf:
          - $ref: '#/components/schemas/InternalServerErrorResponseMetadata'
      title: InternalServerErrorErrorApiResponse
    UnauthorizedResponseMetadata:
      type: object
      required:
      - correlationId
      - responseDateTime
      - statusCode
      - statusMessage
      properties:
        correlationId:
          type: string
          description: Correlation Identifier
        responseDateTime:
          type: string
          example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
          description: Timestamp when response date was generated
        statusCode:
          type: integer
          format: int32
          example: 401
          description: HTTP status code
        statusMessage:
          type: string
          example: Unauthorized
          description: Executed REST API status message
      title: UnauthorizedResponseMetadata
    CardProducerBalancing:
      type: object
      properties:
        cardProductIdentifier:
          description: Unique identifier of the card product
          allOf:
          - $ref: '#/components/schemas/CardProductIdentifier'
        percentages:
          type: array
          description: List of parameters to be applied for card creation and card replacement
          items:
            $ref: '#/components/schemas/CardProducerBalancingPercentage'
        renewalPercentages:
          type: array
          description: List of parameters to be applied for card renewal
          items:
            $ref: '#/components/schemas/CardProducerBalancingPercentage'
      title: CardProducerBalancing
    ProductExtensionBalancing:
      type: object
      properties:
        issuerId:
          type: string
          description: Issuer identifier (unique per platform)
        deviceTokensThreshold:
          type: integer
          description: Threshold on the device tokens number
        merchantTokensThreshold:
          type: integer
          description: Threshold on the merchant tokens number
        productIdentifier:
          description: Unique identifier of the product used for the product extensions' load balancing
          allOf:
          - $ref: '#/components/schemas/ProductIdentifier'
        profiles:
          type: array
          description: List of profiles configured for the product extension choice
          items:
            $ref: '#/components/schemas/ProductExtensionBalancingProfile'
      title: ProductExtensionBalancing
    BadGatewayErrorApiResponse:
      type: object
      required:
      - responseMetadata
      properties:
        responseMetadata:
          allOf:
          - $ref: '#/components/schemas/BadGatewayResponseMetadata'
      title: BadGatewayErrorApiResponse
    CardProducerBalancingPercentage:
      type: object
      properties:
        value:
          type: integer
          description: Value of percentage allocated to the card producer (e.g. 60 means 60%)
        cardProducer:
          type: string
          description: Card producer for the percentage.
      title: CardProducerBalancingPercentage
    OverrideProductExtensionBalancingResponse:
      type: object
      properties:
        productIdentifier:
          description: Identifier of the product used to overide the parameters of the load balancing.
          allOf:
          - $ref: '#/components/schemas/ProductIdentifier'
      title: OverrideProductExtensionBalancingResponse
    BadRequestResponseMetadata:
      type: object
      required:
      - correlationId
      - responseDateTime
      - statusCode
      - statusMessage
      properties:
        correlationId:
          type: string
          description: Correlation Identifier
        responseDateTime:
          type: string
          example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
          description: Timestamp when response date was generated
        statusCode:
          type: integer
          format: int32
          example: 400
          description: HTTP status code
        statusMessage:
          type: string
          example: Bad request
          description: Executed REST API status message
      title: BadRequestResponseMetadata
    ProductExtensionBalancingProfile:
      type: object
      properties:
        name:
          type: string
          description: Name of the profile
        cardProductIdentifier:
          description: Unique identifier of the card product
          allOf:
          - $ref: '#/components/schemas/CardProductIdentifier'
        deviceTokensOperator:
          type: string
          description: Operator used by the algorithm to compare the device tokens counter to the threshold for this profile
        merchantTokensOperator:
          type: string
          description: Operator used by the algorithm to compare the merchant tokens counter to the threshold for this profile
        percentages:
          type: array
          description: List of percentages applied to select the product extension
          items:
            $ref: '#/components/schemas/ProductExtensionBalancingPercentage'
      title: ProductExtensionBalancingProfile
    BadGatewayResponseMetadata:
      type: object
      required:
      - correlationId
      - responseDateTime
      - statusCode
      - statusMessage
      properties:
        correlationId:
          type: string
          description: Correlation Identifier
        responseDateTime:
          type: string
          example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
          description: Timestamp when response date was generated
        statusCode:
          type: integer
          format: int32
          example: 502
          description: HTTP status code
        statusMessage:
          type: string
          example: Bad Gateway
          description: Executed REST API status message
      title: BadGatewayResponseMetadata
    ApiResponseEntityOverrideCardProducerBalancingResponse:
      x-wl-api-response: true
      type: object
      required:
      - responseMetadata
      properties:
        responseMetadata:
          description: Response metadata
          allOf:
          - $ref: '#/components/schemas/ResponseMetadata'
        data:
          description: Response data
          allOf:
          - $ref: '#/components/schemas/OverrideCardProducerBalancingResponse'
      description: Issuer response entity
      title: ApiResponseEntityOverrideCardProducerBalancingResponse
    ApiResponseEntityOverrideProductExtensionBalancingResponse:
      x-wl-api-response: true
      type: object
      required:
      - responseMetadata
      properties:
        responseMetadata:
          description: Response metadata
          allOf:
          - $ref: '#/components/schemas/ResponseMetadata'
        data:
          description: Response data
          allOf:
          - $ref: '#/components/schemas/OverrideProductExtensionBalancingResponse'
      description: Issuer response entity
      title: ApiResponseEntityOverrideProductExtensionBalancingResponse
  securitySchemes:
    basic:
      type: oauth2
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: https://sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/token