--- swagger: "2.0" info: version: V1.1 title: PSD2-Payments-API x-ibm-name: PSD2-Payments-API description: "" host: localhost basePath: /psd2 schemes: - https paths: /v1/payments: post: description: Create Payment operationId: createPayment schemes: - http - https consumes: - application/json produces: - application/json parameters: - name: client_id in: query description: Third party Provide ( TPP ) Application Id required: true type: string - name: client_secret in: query description: Unique ID for TPP required: false type: string - name: subscriptionId in: header description: Subscription Id of TPP required: true type: string - name: Authorization in: header description: 'Encrypted access token ' required: true type: string - name: correlationId in: header description: Correlation ID passed by the requesting system required: false type: string - name: journeyId in: header description: Global transaction Id 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: 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: tppId in: header description: Third party Provide ( TPP ) ID required: true type: string - in: body name: requestBody required: true schema: $ref: '#/definitions/CreatePaymentRequest' responses: 200: description: OK schema: $ref: '#/definitions/CreatePaymentResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 201: description: Created schema: $ref: '#/definitions/CreatePaymentResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 202: description: Accepted headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system 302: description: Found headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 400: description: Bad Request schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 401: description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 403: description: Forbidden schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 404: description: API URL Not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 405: description: Method not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 406: description: Not Acceptable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 429: description: Too many Requests schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system 500: description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 503: description: Service Unavailable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system /v1/payments/accounts/{accountId}: get: description: Get Account Payments operationId: getAccountPayments schemes: - http - https produces: - application/json parameters: - name: accountId in: path description: Account Id for which payments need to be retrieved required: true type: string - name: client_id in: query description: Third party Provide ( TPP ) Application Id required: true type: string - name: client_secret in: query description: Unique ID for TPP required: true type: string - name: endDate in: query description: 'End date ' required: false type: string - name: maxCount in: query description: Maximum Number of records to be retrieved required: false type: integer - name: startDate in: query description: Start date required: false type: string - name: Authorization in: header description: 'Encrypted access token ' required: true type: string - name: correlationId in: header description: Correlation ID passed by the requesting system required: false type: string - name: journeyId in: header description: Global transaction Id 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: 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: subscriptionId in: header description: Subscription Id of TPP required: true type: string - name: timeStamp in: header description: The time stamp when the request was sent to system required: true type: string - name: tppId in: header description: Third party Provide ( TPP ) ID required: true type: string responses: 200: description: OK schema: type: array items: $ref: '#/definitions/Payment' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 302: description: Found headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 400: description: Bad Request schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 401: description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 403: description: Forbidden schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 404: description: API URL Not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 405: description: Method not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 406: description: Not Acceptable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 429: description: Too many Requests schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system 500: description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 503: description: Service Unavailable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system /v1/payments/fundAvailability: post: description: Check availability of funds in a Account operationId: fundAvailability schemes: - http - https consumes: - application/json produces: - application/json parameters: - name: client_id in: query description: Third party Provide ( TPP ) Application Id required: true type: string - name: client_secret in: query description: Unique ID for TPP required: true type: string - name: Authorization in: header description: 'Encrypted access token ' required: true type: string - name: correlationId in: header description: Correlation ID passed by the requesting system required: false type: string - name: journeyId in: header description: Global transaction Id 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: 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: subscriptionId in: header description: Subscription Id of TPP required: true type: string - name: timeStamp in: header description: The time stamp when the request was sent to system required: true type: string - name: tppId in: header description: Third party Provide ( TPP ) ID required: true type: string - in: body name: requestBody required: true schema: $ref: '#/definitions/FundAvailabilityRequest' responses: 200: description: OK headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 202: description: Accepted headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system 302: description: Found headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 400: description: Bad Request schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 401: description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 403: description: Forbidden schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 404: description: API URL Not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 405: description: Method not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 406: description: Not Acceptable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 429: description: Too many Requests schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system 500: description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 503: description: Service Unavailable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system /v1/payments/{paymentId}: get: description: Retrieve the details of payment by payment ID operationId: getPaymentDetails schemes: - http - https consumes: - application/json produces: - application/json parameters: - name: client_id in: query description: Third party Provide ( TPP ) Application Id required: true type: string - name: client_secret in: query description: Unique ID for TPP required: true type: string - name: Authorization in: header description: 'Encrypted access token ' required: true type: string - name: correlationId in: header description: Correlation ID passed by the requesting system required: false type: string - name: journeyId in: header description: Global transaction Id 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: 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: paymentId in: path description: Payment Id for which details need to be retrieved required: true type: string - name: subscriptionId in: header description: subscriptionId of TPP required: true type: string - name: timeStamp in: header description: The time stamp when the request was sent to system required: true type: string - name: tppId in: header description: Third party Provide ( TPP ) ID required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/Payment' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 302: description: Found headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 400: description: Bad Request schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 401: description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 403: description: Forbidden schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 404: description: API URL Not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 405: description: Method not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 406: description: Not Acceptable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 429: description: Too many Requests schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system 500: description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 503: description: Service Unavailable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system delete: description: Cancel a payment which is authorized operationId: cancelPayment schemes: - http - https consumes: - application/json produces: - application/json parameters: - name: client_id in: query description: Third party Provide ( TPP ) Application Id required: true type: string - name: client_secret in: query description: Unique ID for TPP required: true type: string - name: Authorization in: header description: 'Encrypted access token ' required: true type: string - name: correlationId in: header description: Correlation ID passed by the requesting system required: false type: string - name: journeyId in: header description: Global transaction Id 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: 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: paymentId in: path description: Payment Id required: true type: string - name: subscriptionId in: header description: Subscription Id of TPP required: true type: string - name: timeStamp in: header description: The time stamp when the request was sent to system required: true type: string - name: tppId in: header description: Third party Provide ( TPP ) ID required: true type: string responses: 200: description: OK headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 302: description: Found headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 400: description: Bad Request schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 401: description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 403: description: Forbidden schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 404: description: API URL Not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 405: description: Method not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 406: description: Not Acceptable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 429: description: Too many Requests schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system 500: description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 503: description: Service Unavailable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system /v1/payments/{paymentId}/authorize: post: operationId: authorizePayment schemes: - http - https consumes: - application/json produces: - application/json parameters: - name: client_id in: query description: Third party Provide ( TPP ) Application Id required: true type: string - name: client_secret in: query description: Unique ID for TPP required: true type: string - name: Authorization in: header description: 'Encrypted access token ' required: true type: string - name: correlationId in: header description: Correlation ID passed by the requesting system required: false type: string - name: journeyId in: header description: Global transaction Id 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: 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: paymentId in: path description: Payment Id required: true type: string - name: subscriptionId in: header description: Subscription Id of TPP required: true type: string - name: timeStamp in: header description: The time stamp when the request was sent to system required: true type: string - name: tppId in: header description: Third party Provide ( TPP ) ID required: true type: string - in: body name: requestBody required: true schema: $ref: '#/definitions/AuthorizePaymentRequest' responses: 200: description: OK schema: $ref: '#/definitions/Status' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 202: description: Accepted headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system 302: description: Found headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 400: description: Bad Request schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 401: description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 403: description: Forbidden schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 404: description: API URL Not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 405: description: Method not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 406: description: Not Acceptable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 429: description: Too many Requests schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system 500: description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 503: description: Service Unavailable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system /v1/payments/{paymentId}/status: get: description: Get the Status of a Payment by payment ID operationId: getPaymentStatus schemes: - http - https produces: - application/json parameters: - name: client_id in: query description: Third party Provide ( TPP ) Application Id required: true type: string - name: client_secret in: query description: Unique ID for TPP required: true type: string - name: Authorization in: header description: 'Encrypted access token ' required: true type: string - name: correlationId in: header description: Correlation ID passed by the requesting system required: false type: string - name: journeyId in: header description: Global transaction Id 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: 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: paymentId in: path description: Payment Id to retrieve payment status required: true type: string - name: subscriptionId in: header description: subscriptionId of TPP required: true type: string - name: timeStamp in: header description: The time stamp when the request was sent to system required: true type: string - name: tppId in: header description: Third party Provide ( TPP ) ID required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/getPaymentStatusResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 302: description: Found headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 400: description: Bad Request schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 401: description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 403: description: Forbidden schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 404: description: API URL Not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 405: description: Method not Found schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 406: description: Not Acceptable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 429: description: Too many Requests schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system 500: description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID correlationId: type: string description: Correlation ID passed by the requesting system timeStamp: type: string description: The time stamp when the message was received from the system 503: description: Service Unavailable schema: $ref: '#/definitions/ErrorResponse' headers: journeyId: type: string description: Global Transaction id/Journey ID timeStamp: type: string description: The time stamp when the message was received from the system correlationId: type: string description: Correlation ID passed by the requesting system definitions: AdditionalDetails: type: object properties: errorCode: type: string severity: type: string status: type: string description: type: string Description: type: object properties: line1: type: string line2: type: string line3: type: string line4: type: string StatusNotificationOption: type: object required: - email - statusCode properties: statusCode: type: string email: type: string MassPayment: type: object properties: debtor: $ref: '#/definitions/Debtor' massPaymentCreditor: $ref: '#/definitions/MassPaymentCreditor' contactPhoneNumber: type: string description: Contact telephone number of debitor adviceNotificationOption: $ref: '#/definitions/NotificationOption' statusNotificationOption: $ref: '#/definitions/StatusNotificationOption' chargesPaidBy: type: string enum: - debtor - creditor - split chargesAccount: $ref: '#/definitions/ChargesAccount' amount: $ref: '#/definitions/Amount' description: $ref: '#/definitions/Description' endToEndId: type: string RUB: $ref: '#/definitions/RUB' executionDate: type: string valueDate: type: string getPaymentStatusResponse: type: object properties: status: $ref: '#/definitions/Status' totalDebitAmount: $ref: '#/definitions/Amount' Attachment: type: object required: - fileData - fileName properties: fileData: type: string fileName: type: string AuthorizePaymentRequest: type: object properties: transactionTime: type: string description: Needed only in case of two factor authentication. Time as received in the create payment message authCode: type: string description: Subscriber has to provide Auth code in case of two factor authentication. For example OTP entered by Subscriber on the TPP screen. FundAvailabilityRequest: type: object required: - accountId - transaction properties: bankId: type: string accountId: type: string transaction: $ref: '#/definitions/Amount' CreateGroupPaymentRequest: type: object required: - companyInfo - debtor - groupPayments - numberOfTransactions - totalAmount - type properties: filename: type: string maxLength: 35 numberOfTransactions: type: number totalAmount: type: string type: type: string enum: - PAYROLL - GROUP_PAYMENT executionDate: type: string debtor: $ref: '#/definitions/Debtor' companyInfo: $ref: '#/definitions/CompanyInfo' groupPayments: type: array items: $ref: '#/definitions/GroupPayment' GroupPaymentCreditor: type: object required: - accountId - bankId properties: bankId: type: string accountId: type: string description: IBAN or Account beneficiaryName: type: string beneficiaryAddress: $ref: '#/definitions/ShortAddress' CreatePaymentResponse: type: object properties: authCodeNeeded: type: boolean payment: $ref: '#/definitions/Payment' Debtor: type: object required: - accountId properties: bankId: type: string accountId: type: string maxLength: 35 MassPaymentStatus: type: object required: - massPayment - status properties: massPayment: $ref: '#/definitions/MassPayment' status: $ref: '#/definitions/Status' errorDescription: type: string ShortAddress: type: object properties: line1: type: string maxLength: 35 line2: type: string maxLength: 35 line3: type: string maxLength: 35 line4: type: string maxLength: 35 CreateGroupPaymentResponse: type: object required: - paymentId - status properties: paymentId: type: string status: $ref: '#/definitions/Status' Charges: type: object properties: name: type: string value: type: string MassPaymentCreditor: type: object required: - accountId - bankId properties: bankId: type: string description: SWIFT code accountId: type: string description: IBAN or Account beneficiaryName: type: string beneficiaryAddress: $ref: '#/definitions/ShortAddress' bankName: type: string nationalId: type: string bankCountryCode: type: string branchName: type: string RUB: type: object properties: voCode: type: string maxLength: 35 BIK: type: string maxLength: 35 INN: type: string maxLength: 35 correspondentAccount: type: string maxLength: 35 Status: type: object properties: code: type: string description: Allowed values CPLT | RJCT | PDNG | AUTH | description: type: array items: type: string description: |- It will be set to one of the following depending on the status: COMPLETED: The transaction has passed all validations and was successfully posted in bank systems. REJECTED: The transaction was rejected when attempting to post it on the banks systems.Please check error code PENDING: Processing Pending. Please, check your Transaction Status Page on Bank portal for more information. AUTHORISATION: The transaction has been accepted by the bank but needs to be authorized by another user(s) . refNumber: type: string description: A 9 digit number which the customer uses as a reference for support or for his records maxLength: 9 NotificationOption: type: object properties: faxNumber: type: string email: type: string ChargesAccount: type: object required: - accountId - bankId properties: bankId: type: string accountId: type: string Amount: type: object required: - amount properties: amount: type: number description: Amount is in EUR currency: type: string description: 3 Character ISO code maxLength: 3 currencyRate: type: string Error: type: object properties: code: type: string severity: type: string enum: - error - warning - Info description: type: string additionalDetails: type: array items: $ref: '#/definitions/AdditionalDetails' CreatePaymentRequest: type: object required: - creditor - debtor - paymentDetails - transactionAmount properties: debtor: $ref: '#/definitions/Debtor' creditor: $ref: '#/definitions/Creditor' transactionAmount: $ref: '#/definitions/Amount' endToEndId: type: string maxLength: 35 paymentDetails: type: string maxLength: 120 terminalId: type: string maxLength: 35 branch: type: string maxLength: 35 RUB: $ref: '#/definitions/RUB' executionDate: type: string valueDate: type: string attachments: type: array items: $ref: '#/definitions/Attachment' getMassPaymentStatusResponse: type: object required: - massPaymentStatus - numberOfInvalidPayments - numberOfTransactions - numberOfValidPayments - totalAmountOfValidPayments properties: numberOfTransactions: type: number numberOfValidPayments: type: number numberOfInvalidPayments: type: number totalAmountOfValidPayments: type: string massPaymentStatus: type: array items: $ref: '#/definitions/MassPaymentStatus' ErrorResponse: type: object properties: fatalError: type: boolean error: $ref: '#/definitions/Error' CreateMassPaymentRequest: type: object required: - massPayments - numberOfTransactions properties: filename: type: string numberOfTransactions: type: number massPayments: type: array items: $ref: '#/definitions/MassPayment' Payment: type: object properties: paymentId: type: string transactionTime: type: string status: $ref: '#/definitions/Status' debtor: $ref: '#/definitions/Debtor' creditor: $ref: '#/definitions/Creditor' transactionAmount: $ref: '#/definitions/Amount' charges: type: array items: $ref: '#/definitions/Charges' totalCharges: type: string endToEndId: type: string maxLength: 35 paymentDetails: type: string maxLength: 140 terminalId: type: string maxLength: 35 branch: type: string maxLength: 35 RUB: $ref: '#/definitions/RUB' executionDate: type: string valueDate: type: string totalDebitAmount: $ref: '#/definitions/Amount' attachments: type: array items: $ref: '#/definitions/Attachment' GroupPayment: type: object required: - amount properties: groupPaymentCreditor: $ref: '#/definitions/GroupPaymentCreditor' amount: type: number description: $ref: '#/definitions/Description' endToEndId: type: string CompanyInfo: type: object required: - identification properties: identification: type: string name: type: string Creditor: type: object required: - accountId properties: bankId: type: string accountId: type: string maxLength: 35 name: type: string maxLength: 35 address: type: string maxLength: 105 x-ibm-configuration: enforced: true testable: true phase: realized securityDefinitions: Application - Oauth: type: oauth2 description: "" flow: application scopes: TPPOAuth2Security: "" tokenUrl: https://sandbox-apis.bankofcyprus.com/df-boc-org-sb/sb/psd2/oauth2/token x-tokenIntrospect: url: "" Client_ID: type: apiKey description: "" in: query name: client_id Client_Secret: type: apiKey description: "" in: query name: client_secret security: - Application - Oauth: - TPPOAuth2Security Client_Secret: [] Client_ID: [] produces: - application/json consumes: - application/json x-ibm-endpoints: - endpointUrl: https://sandbox-apis.bankofcyprus.com/df-boc-org-sb/sb type: - production ...