--- swagger: "2.0" info: description: Swagger Specifications for the B2B Customer APIs version: "1.0" title: B2B Customer API x-ibm-name: B2B_Customer_Application host: localhost:443 basePath: /psd2 tags: - name: Customer schemes: - https paths: /v1/customers: get: tags: - Customer summary: Get list of connected cif's for a subscriber based of User_Id operationId: GET retrieveConnectedCustomers schemes: - http - https produces: - application/json parameters: - name: maxCount in: query required: false type: string - name: journeyId in: header description: Global transaction Id required: true type: string - name: originSourceId in: header description: ID of the source system invoking required: false type: string - name: originChannelId in: header description: ID of the channel from which the invocation occurred required: false type: string - name: originDeptId in: header description: ID of the department from which the invocation occurred required: false type: string - name: originUserId in: header description: User ID of the requester (as per LDAP) required: true type: string - name: originEmployeeId in: header description: Employee ID of the requester (as per employee HR record) required: false type: string - name: originTerminalId in: header description: Terminal ID of the requester required: false type: string - name: timeStamp in: header description: The time stamp when the request was sent to system required: true type: string - name: correlationId in: header description: Correlation ID passed by the requesting system required: false type: string - name: tppId in: header description: Third party Provide ( TPP ) ID required: false type: string - name: client_id in: query description: Third party Provide ( TPP ) Application Id required: false type: string - name: subscriptionId in: header description: 'Subscription ID of a subscriber ' required: true type: string - name: Authorization in: header description: 'Encrypted access token ' required: true type: string - name: lang in: header description: 2-character iso code for preferred language. If empty the default will be English required: false type: string - name: client_secret in: query required: false type: string - name: customerIP type: string required: false in: header description: The PSU's IP address if the PSU is currently logged in with the TPP - name: customerSessionId type: string required: false in: header description: The PSU’s Session Identifier with the TPP - name: customerDevice type: string required: false in: header description: The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App - name: loginTimeStamp type: string required: false in: header description: The time of PSU’s last login with the TPP related to the Session Id provided above responses: 200: description: OK schema: $ref: '#/definitions/RetrieveConnectedCustomers' headers: journeyId: type: string timeStamp: type: string format: date-time correlationId: type: string 302: description: Found headers: journeyId: type: string timeStamp: type: string format: date-time correlationId: type: string 400: description: Bad Request schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string timeStamp: type: string format: date-time correlationId: type: string 401: description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string timeStamp: type: string format: date-time correlationId: type: string 403: description: Forbidden schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string timeStamp: type: string format: date-time correlationId: type: string 404: description: API URL Not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string timeStamp: type: string format: date-time correlationId: type: string 405: description: Method not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string timeStamp: type: string format: date-time correlationId: type: string 406: description: Not Acceptable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string timeStamp: type: string format: date-time correlationId: type: string 429: description: Too many Requests schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string timeStamp: type: string format: date-time correlationId: type: string 500: description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string timeStamp: type: string format: date-time correlationId: type: string 503: description: Service Unavailable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string timeStamp: type: string format: date-time correlationId: type: string /v1/customers/healthCheck: get: responses: 200: description: 200 OK tags: - healthCheck operationId: healthCheck produces: [] consumes: [] security: - [] definitions: AdditionalDetails: type: object properties: errorCode: type: string example: "404" severity: type: string example: High status: type: string example: failure description: type: string example: more information RetrieveConnectedCustomers: type: object properties: customers: type: array items: $ref: '#/definitions/Customer' Customer: type: object required: - clientBusinessId - customerName properties: clientBusinessId: type: string example: "123" customerName: type: string example: Mike Error: type: object properties: code: type: string example: "404" severity: type: string enum: - error - warning - Info example: High description: type: string example: Not found additionalDetails: type: array items: $ref: '#/definitions/AdditionalDetails' example: Not found ErrorResponse: type: object properties: fatalError: type: boolean example: "10101" error: $ref: '#/definitions/Error' example: "404" x-ibm-configuration: enforced: true testable: true phase: realized securityDefinitions: Application_oauth: type: oauth2 description: "" flow: application scopes: TPPOAuth2Security: "" tokenUrl: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/v1/oauth2/token security: - Application_oauth: - TPPOAuth2Security consumes: - application/json produces: - application/json x-ibm-endpoints: - endpointUrl: https://apis.bankofcyprus.com/df-boc-org-prd/prod description: APIC Gateway Server type: - production ...