--- swagger: "2.0" info: version: 1.0.0 title: Services description: The Servicing APIs allow you to perform servicing functions such as getting Citi Customer's statements and advices. You may reset ATM Pin as well. Authorized access is a pre-requisite. You will be able to retrieve the statement and advices listings as well as individual statement or advice in PDF format. x-ibm-name: services_100 basePath: /api schemes: - https x-ibm-configuration: enforced: true phase: realized testable: true tags: [] securityDefinitions: Client ID: description: "" in: header name: X-IBM-Client-Id type: apiKey definitions: ResetAtmPinRequest: properties: cardId: description: Unique Id of the card in encrypted format. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d newPin: description: New pin in encrypted format. type: string example: q745963215y6d4r951753845f455a418789x required: - cardId - newPin ErrorResponse: properties: type: description: Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again enum: - error - warn - invalid - fatal type: string code: description: Error code which qualifies the error type: string details: description: Human readable explanation specific to the occurrence of the problem type: string location: description: The name of the field that resulted in the error type: string moreInfo: description: URI to human readable documentation of the error type: object required: - type - code StatementListResponse: properties: statementList: type: array items: $ref: '#/definitions/StatementList' required: - statementList StatementList: properties: statementId: description: Unique identifier for the statement type: string example: "123456789" statementDate: description: Date on which the account statement has been generated in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2017-01-01" required: - statementId - statementDate StatementPdfResponse: properties: binaryData: description: This field contains binary data for the statement. type: string example: "01010100011010000110100101110011001000000110011001101001011001010110110001100100001000000110001101100101010001101000011010010111001100100000011001100110100101100101011010101000110100001101001011100110010000001100110011010010110010101101010100011010000110100101110011001000000110011001101001011001010110101010001101000011010010111001100100000011001100110100101100101011010101000110100001101001011100110010000001100110011010010110010101101010100011010000110100101110011001000000110011001101001011001010110101010001101000011010010111001100100000011001100110100101100101011" required: - binaryData AdviceListResponse: properties: adviceList: type: array items: $ref: '#/definitions/AdviceList' required: - adviceList AdviceList: properties: adviceId: description: Unique identifier for the advice type: string example: "123456789" adviceType: description: Type of advice. This is a reference data field. Please use /v1/apac/utilities/referenceData/{adviceType} resource to get possible value of this field with description. type: string example: PRIMARY_MOBILE_NUMBER_CHANGE_FOR_NON_DINER_CUSTOMER adviceDate: description: Date on which the account advice has been generated in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2017-01-01" required: - adviceId - adviceDate - adviceType AdvicePdfResponse: properties: binaryData: description: This field contains binary data for the advice. type: string example: "01010100011010000110100101110011001000000110011001101001011001010110110001100100001000000110001101100101010001101000011010010111001100100000011001100110100101100101011010101000110100001101001011100110010000001100110011010010110010101101010100011010000110100101110011001000000110011001101001011001010110101010001101000011010010111001100100000011001100110100101100101011010101000110100001101001011100110010000001100110011010010110010101101010100011010000110100101110011001000000110011001101001011001010110101010001101000011010010111001100100000011001100110100101100101011" required: - binaryData paths: /v1/cards/atmPin/reset: put: summary: Reset Atm Pin description: Sets the ATM Pin of the Card in context parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: ResetAtmPinRequest required: true in: body schema: $ref: '#/definitions/ResetAtmPinRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorinvalidPinPIN is invalid
errordecryptionFailedPIN decryption is failed
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredThe request operation is not configured to access this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/statements: get: summary: Statement List description: Returns a list of available statements for the requested year parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: client id generated during consumer onboarding type: string required: true - name: statementYear in: query description: Statement year for which statement dates should be populated in 'YYYY' format. type: string required: true - name: statementLevel in: query description: This is a reference data field. Please use /v1/apac/utilities/referenceData/{statementLevel} resource to get possible value of this field with description. type: string required: true - name: accountId in: query description: The account identifier in encrypted format.Typically, this is not displayed to the customer. Mandatory if statementLevel=ACCOUNT type: string - name: statementView in: query description: This is a reference data field. Please use /v1/apac/utilities/referenceData/{statementView} resource to get possible value of this field with description. type: string required: true responses: 200: description: Successful operation. schema: $ref: '#/definitions/StatementListResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/statements/{statementId}: get: summary: Statement Pdf View description: Returns PDF binary data for the requested Statement ID parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: client id generated during consumer onboarding type: string required: true - name: statementId in: path description: Unique identifier for the statement type: string required: true responses: 200: description: Successful operation. schema: $ref: '#/definitions/StatementPdfResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorpayloadTooLargePayload size is larger than the server is willing or able to process
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/advices: get: summary: Advice List description: Returns a list of available advices parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: client id generated during consumer on-boarding type: string required: true - name: fromDate in: query description: Starting range for advice date in ISO 8601 date format 'YYYY-MM' and We support maximum of 24 months up to the current month. type: string required: true - name: toDate in: query description: End range for advice date in ISO 8601 date format 'YYYY-MM' type: string required: true - name: adviceLevel in: query description: This is a reference data field. Please use /v1/apac/utilities/referenceData/{adviceLevel} resource to get possible value of this field with description. type: string required: true - name: accountId in: query description: The account identifier in encrypted format.Typically, this is not displayed to the customer. Mandatory if adviceLevel=ACCOUNT type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/AdviceListResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidDateRangeDate range is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/advices/{adviceId}: get: summary: Advice Pdf View description: Returns PDF binary data for the requested Advice ID parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response type: string required: true - name: client_id in: header description: client id generated during consumer onboarding type: string required: true - name: adviceId in: path description: Unique identifier for the advice type: string required: true responses: 200: description: Successful operation. schema: $ref: '#/definitions/AdvicePdfResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorpayloadTooLargePayload size is larger than the server is willing or able to process
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' security: - Client ID: [] consumes: - application/json produces: - application/json x-ibm-endpoints: - endpointUrl: https://sandbox.apihub.citi.com/gcb description: Custom Gateway API Endpoint type: - production - development ...