Worldline

Worldline Corporate Contract API

Corporate Contract API Controller

GitHub OpenAPI

Operations 43

GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference} Retrieve corporate employee Accounts #
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference} Update Corporate employee account #
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference} Retrieve corporate employee accounts by account external reference #
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference} Update Corporate employee account by account external reference #
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference} Retrieve corporate employee Accounts by contract external reference and account external reference #
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference} Update Corporate employee account by contract external reference and account external reference #
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference} Retrieve corporate employee Accounts by contract external reference #
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference} Update Corporate employee account by contract external reference #
GET /issuers/{issuerId}/corporate-contracts/{contractReference} Retrieve corporate contract #
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference} Modify Corporate contract #
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference} Retrieve corporate contract by external reference #
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference} Modify Corporate contract by external reference #
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/close Close Corporate contract #
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-contract-entity Add an entity to a Corporate contract #
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-contract-entity/{companyEntityExternalReference} Modify an entity of a Corporate contract - deprecated #
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-contract-entities/{companyEntityExternalReference} Modify an entity of a Corporate contract #
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-contract-entity/{companyEntityExternalReference} modify an entity of a Corporate contract by external reference - deprecated #
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-contract-entities/{companyEntityExternalReference} modify an entity of a Corporate contract by external reference #
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-contract-entity Add an entity to a Corporate contract by external reference #
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-employee-cards-accounts Add an employee and its card(s) and account(s) to a Corporate contract #
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-employee-cards-accounts Add an employee and its card(s) and account(s) to a Corporate contract by external reference #
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-virtual-cards-accounts-service Add Corporate VCA Service cards and accounts to a corporate contract #
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-virtual-cards-accounts-service Add Corporate VCA Service cards and accounts to a corporate contract by issuer contract external reference #
POST /issuers/{issuerId}/corporate-contracts/create-corporate-contract Create a Corporate contract #
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/close Close Corporate contract by external reference #
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/refund-fee-on-demand Refund fee by contract reference for corporate contract #
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions List add-on services subscriptions for a corporate contract by external reference #
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions Subscribe to add-on for a corporate contract by external reference #
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions List add-on services subscriptions for a corporate contract #
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions Subscribe to add-on for a corporate contract #
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions/unsubscribe Unsubscribe add-on for a corporate contract by external reference #
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions/unsubscribe Unsubscribe add-on for a corporate contract #
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/refund-fee-on-demand Refund Fee By Issuer Contract External Reference For Corporate Contract #
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/change-paying-account Change paying account structure for a corporate contract #
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/cancel-change-paying-account Cancel scheduled change of paying account type #
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/cancel-change-paying-account Cancel scheduled change of paying account type by external reference #
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/change-paying-account Change paying account structure for a corporate contract by external reference #
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/contract-owner Retrieve contract owner for a corporate contract (beta) #
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/contract-owner Retrieve contract owner for a corporate contract by external reference (beta) #
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/card-contracts/{cardContractReference}/reallocate Reallocate employee #
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/card-contracts/{cardContractReference}/reallocate Reallocate employee by issuer contract external reference #
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/reallocate Reallocate employee by issuer card contract external reference #
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/reallocate Reallocate employee by issuer contract external reference and issuer card contract external reference #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/wordline/refs/heads/main/openapi/wordline-corporate-contract-api-openapi.yml

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-corporate-contract-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.

GitHub Google LinkedIn

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

OpenAPI Specification

wordline-corporate-contract-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 Corporate Contract API
  contact: {}
servers:
- url: https://sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing/api/v2
tags:
- name: Corporate Contract
  description: Corporate Contract API Controller
paths:
  /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}:
    get:
      tags:
      - Corporate Contract
      summary: Retrieve corporate employee Accounts
      operationId: retrieveCorporateEmployeeAccounts
      description: "This API allows a particular corporate employee account or Virtual Card Account to be retrieved from its reference or its issuer external reference.\n\nThe API response contains corporate employee account information such as:\n- account identifier with the account reference and the issuer external account reference\n- external reference of the employee account\n- parent identifier with the account reference and the issuer external account reference\n- allowed advertisement channels (flags) \n- allowed delivery channel for possible letters\n-  if both membership and account setup fees are waived during contract lifecycle \n-  if both membership fee and account setup fee are paid by the account or the root\n- type of a corporate product (if the account is related to the company or an employee) \n- embedded fields if requested such as account information, card account(s), card contract(s) linked to this corporate employee account"
      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: filter
        in: query
        description: Filtered Fields
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: issuerId
        in: path
        description: Issuer ID
        required: true
        schema:
          type: string
      - name: contractReference
        in: path
        description: Contract Reference
        required: true
        schema:
          type: string
      - name: accountReference
        in: path
        description: Account Reference
        required: true
        schema:
          type: string
      - name: embed
        in: query
        description: Embedded Fields
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - account
            - cardContracts
            - cardContracts.cards
            - cards.orders
            - customers
            - customers.addresses
      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/ApiResponseEntityCorporateEmployeeAccountResponse'
      security:
      - basic: []
      deprecated: false
    patch:
      tags:
      - Corporate Contract
      summary: Update Corporate employee account
      operationId: updateCorporateEmployeeAccount
      description: 'The API allows to update certain data of an existing corporate employee account or Virtual Card Account, such as:

        - the external reference of the employee account

        - the allowed advertisement channels (flags)

        - the allowed delivery channel for possible letters

        -  if both membership and account setup fees should be waived during contract lifecycle (can be changed at any moment)

        - if both membership fee and account setup fee are paid by the card account (usually the employee) or the root account (usually the company)


        As a result the corporate employee account is immediately updated with provided data in our system.'
      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: filter
        in: query
        description: Filtered Fields
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: issuerId
        in: path
        description: Issuer ID
        required: true
        schema:
          type: string
      - name: contractReference
        in: path
        description: contract Reference
        required: true
        schema:
          type: string
      - name: accountReference
        in: path
        description: account 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/ApiResponseEntityModifyCorporateEmployeeAccountResponse'
      security:
      - basic: []
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyCorporateEmployeeAccountRequest'
  ? /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
  : get:
      tags:
      - Corporate Contract
      summary: Retrieve corporate employee accounts by account external reference
      operationId: retrieveCorporateEmployeeAccountsWithExtAccountRef
      description: "This API allows a particular corporate employee account or Virtual Card Account to be retrieved from its reference or its issuer external reference.\n\nThe API response contains corporate employee account information such as:\n- account identifier with the account reference and the issuer external account reference\n- external reference of the employee account\n- parent identifier with the account reference and the issuer external account reference\n- allowed advertisement channels (flags) \n- allowed delivery channel for possible letters\n-  if both membership and account setup fees are waived during contract lifecycle \n-  if both membership fee and account setup fee are paid by the account or the root\n- type of a corporate product (if the account is related to the company or an employee) \n- embedded fields if requested such as account information, card account(s), card contract(s) linked to this corporate employee account"
      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: filter
        in: query
        description: Filtered Fields
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: issuerId
        in: path
        description: Issuer ID
        required: true
        schema:
          type: string
      - name: contractReference
        in: path
        description: Contract Reference
        required: true
        schema:
          type: string
      - name: issuerAccountExternalReference
        in: path
        description: Issuer Account External Reference
        required: true
        schema:
          type: string
      - name: embed
        in: query
        description: Embedded Fields
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - account
            - cardContracts
            - cardContracts.cards
            - cards.orders
            - customers
            - customers.addresses
      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/ApiResponseEntityCorporateEmployeeAccountResponse'
      security:
      - basic: []
      deprecated: false
    patch:
      tags:
      - Corporate Contract
      summary: Update Corporate employee account by account external reference
      operationId: updateCorporateEmployeeAccountByExtAccount
      description: 'The API allows to update certain data of an existing corporate employee account or Virtual Card Account, such as:

        - the external reference of the employee account

        - the allowed advertisement channels (flags)

        - the allowed delivery channel for possible letters

        -  if both membership and account setup fees should be waived during contract lifecycle (can be changed at any moment)

        - if both membership fee and account setup fee are paid by the card account (usually the employee) or the root account (usually the company)


        As a result the corporate employee account is immediately updated with provided data in our system.'
      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: filter
        in: query
        description: Filtered Fields
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: issuerId
        in: path
        description: Issuer ID
        required: true
        schema:
          type: string
      - name: contractReference
        in: path
        description: contract Reference
        required: true
        schema:
          type: string
      - name: issuerAccountExternalReference
        in: path
        description: issuer Account 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/ApiResponseEntityModifyCorporateEmployeeAccountResponse'
      security:
      - basic: []
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyCorporateEmployeeAccountRequest'
  ? /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
  : get:
      tags:
      - Corporate Contract
      summary: Retrieve corporate employee Accounts by contract external reference and account external reference
      operationId: retrieveCorporateEmployeeAccountsWithExtContractRefAndExtAccountRef
      description: "This API allows a particular corporate employee account or Virtual Card Account to be retrieved from its reference or its issuer external reference.\n\nThe API response contains corporate employee account information such as:\n- account identifier with the account reference and the issuer external account reference\n- external reference of the employee account\n- parent identifier with the account reference and the issuer external account reference\n- allowed advertisement channels (flags) \n- allowed delivery channel for possible letters\n-  if both membership and account setup fees are waived during contract lifecycle \n-  if both membership fee and account setup fee are paid by the account or the root\n- type of a corporate product (if the account is related to the company or an employee) \n- embedded fields if requested such as account information, card account(s), card contract(s) linked to this corporate employee account"
      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: filter
        in: query
        description: Filtered Fields
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: issuerId
        in: path
        description: Issuer ID
        required: true
        schema:
          type: string
      - name: issuerContractExternalReference
        in: path
        description: Issuer Contract External Reference
        required: true
        schema:
          type: string
      - name: issuerAccountExternalReference
        in: path
        description: Issuer Account External Reference
        required: true
        schema:
          type: string
      - name: embed
        in: query
        description: Embedded Fields
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - account
            - cardContracts
            - cardContracts.cards
            - cards.orders
            - customers
            - customers.addresses
      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/ApiResponseEntityCorporateEmployeeAccountResponse'
      security:
      - basic: []
      deprecated: false
    patch:
      tags:
      - Corporate Contract
      summary: Update Corporate employee account by contract external reference and account external reference
      operationId: updateCorporateEmployeeAccountByExtContractAndExtAccount
      description: 'The API allows to update certain data of an existing corporate employee account or Virtual Card Account, such as:

        - the external reference of the employee account

        - the allowed advertisement channels (flags)

        - the allowed delivery channel for possible letters

        -  if both membership and account setup fees should be waived during contract lifecycle (can be changed at any moment)

        - if both membership fee and account setup fee are paid by the card account (usually the employee) or the root account (usually the company)


        As a result the corporate employee account is immediately updated with provided data in our system.'
      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: filter
        in: query
        description: Filtered Fields
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: issuerId
        in: path
        description: Issuer ID
        required: true
        schema:
          type: string
      - name: issuerContractExternalReference
        in: path
        description: Issuer Contract External Reference
        required: true
        schema:
          type: string
      - name: issuerAccountExternalReference
        in: path
        description: issuer Account 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/ApiResponseEntityModifyCorporateEmployeeAccountResponse'
      security:
      - basic: []
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyCorporateEmployeeAccountRequest'
  ? /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
  : get:
      tags:
      - Corporate Contract
      summary: Retrieve corporate employee Accounts by contract external reference
      operationId: retrieveCorporateEmployeeAccountsWithExtContractRef
      description: "This API allows a particular corporate employee account or Virtual Card Account to be retrieved from its reference or its issuer external reference.\n\nThe API response contains corporate employee account information such as:\n- account identifier with the account reference and the issuer external account reference\n- external reference of the employee account\n- parent identifier with the account reference and the issuer external account reference\n- allowed advertisement channels (flags) \n- allowed delivery channel for possible letters\n-  if both membership and account setup fees are waived during contract lifecycle \n-  if both membership fee and account setup fee are paid by the account or the root\n- type of a corporate product (if the account is related to the company or an employee) \n- embedded fields if requested such as account information, card account(s), card contract(s) linked to this corporate employee account"
      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: filter
        in: query
        description: Filtered Fields
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: issuerId
        in: path
        description: Issuer ID
        required: true
        schema:
          type: string
      - name: issuerContractExternalReference
        in: path
        description: Issuer Contract External Reference
        required: true
        schema:
          type: string
      - name: accountReference
        in: path
        description: Account Reference
        required: true
        schema:
          type: string
      - name: embed
        in: query
        description: Embedded Fields
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - account
            - cardContracts
            - cardContracts.cards
            - cards.orders
            - customers
            - customers.addresses
      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/ApiResponseEntityCorporateEmployeeAccountResponse'
      security:
      - basic: []
      deprecated: false
    patch:
      tags:
      - Corporate Contract
      summary: Update Corporate employee account by contract external reference
      operationId: updateCorporateEmployeeAccountByExtContractAndAccount
      description: 'The API allows to update certain data of an existing corporate employee account or Virtual Card Account, such as:

        - the external reference of the employee account

        - the allowed advertisement channels (flags)

        - the allowed delivery channel for possible letters

        -  if both membership and account setup fees should be waived during contract lifecycle (can be changed at any moment)

        - if both membership fee and account setup fee are paid by the card account (usually the employee) or the root account (usually the company)


        As a result the corporate employee account is immediately updated with provided data in our system.'
      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: filter
        in: query
        description: Filtered Fields
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: issuerId
        in: path
        description: Issuer ID
        required: true
        schema:
          type: string
      - name: issuerContractExternalReference
        in: path
        description: Issuer Contract External Reference
        required: true
        schema:
          type: string
      - name: accountReference
        in: path
        description: account 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/ApiResponseEntityModifyCorporateEmployeeAccountResponse'
      security:
      - basic: []
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyCorporateEmployeeAccountRequest'
  /issuers/{issuerId}/corporate-contracts/{contractReference}:
    get:
      tags:
      - Corporate Contract
      summary: Retrieve corporate contract
      operationId: retrieveCorporateContract
      description: "This API allows a particular corporate contract from its reference or its issuer external reference to be retrieved.\n\nThe API response contains corporate contract information such as:\n•\tcontract identifier with the contract reference and the issuer external contract reference if previously provided\n•\tlist of levels in the company organization\n•\tembedded fields if requested such as list of corporate contract entities (limited to 100), list of all customers (limited to 100), list of all companies (limited to 100), list of corporate employee accounts (limited to 100) linked to this corporate contract"
      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: filter
        in: query
        description: Filtered Fields
        required: false
      

# --- truncated at 32 KB (459 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wordline/refs/heads/main/openapi/wordline-corporate-contract-api-openapi.yml