--- swagger: "2.0" info: version: V1.1 title: PSD2-Payments-API x-ibm-name: PSD2-Payments-API description: "" host: localhost:443 basePath: /psd2 schemes: - https paths: /v1/payments/initiate: post: description: Initiate Payment Request operationId: initiatePaymentRequest schemes: - http - https consumes: - application/json produces: - application/json parameters: - name: client_id in: query description: Third party Provide ( TPP ) Application Id required: false 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: 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: false 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: false type: string - name: customerIP type: string required: true in: header description: The PSU's IP address if the PSU is currently logged in with the TPP - name: customerSessionId type: string required: true in: header description: The PSU’s Session Identifier with the TPP - name: customerDevice type: string required: true 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: true in: header description: The time of PSU’s last login with the TPP related to the Session Id provided above - in: body name: requestBody required: true schema: $ref: '#/definitions/InitiatePaymentRequest' responses: 200: description: OK schema: $ref: '#/definitions/InitiatePaymentResponse' 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/InitiatePaymentResponse' 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 security: - Application - Oauth: - TPPOAuth2Security /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: false 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: false 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: 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 - 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/{paymentId}/execute: post: operationId: executePayment schemes: - http - https consumes: - application/json produces: - application/json parameters: - name: client_id in: query description: Third party Provide ( TPP ) Application Id required: false type: string - name: client_secret in: query description: Unique ID for TPP required: false type: string - name: Authorization in: header description: 'Encrypted access token ' required: false 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: false 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: false 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: false type: string - name: timeStamp in: header description: The time stamp when the request was sent to system required: false type: string - name: tppId in: header description: Third party Provide ( TPP ) ID 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 - 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 security: - Access Code - Oauth: - UserOAuth2Security /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: false type: string - name: client_secret in: query description: Unique ID for TPP required: false 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: false 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: 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: 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: 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/{paymentId}/funds-confirmation: get: description: Check availability of funds in a Account operationId: fundAvailabilityByPaymentId schemes: - http - https consumes: - application/json produces: - application/json parameters: - name: client_id in: query description: Third party Provide ( TPP ) Application Id required: false type: string - name: client_secret in: query description: Unique ID for TPP 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: false 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: 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: false type: string - name: paymentId in: path description: Payment Id for which details need to be retrieved required: true 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 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/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: false type: string - name: client_secret in: query description: Unique ID for TPP 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: false 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: 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 - 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: false type: string - name: client_secret in: query description: Unique ID for TPP 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: false 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: 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: 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/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: false type: string - name: client_secret in: query description: Unique ID for TPP 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: false 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: 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: 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 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: false type: string - name: client_secret in: query description: Unique ID for TPP 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: false 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: 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 - 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: false type: string - name: client_secret in: query description: Unique ID for TPP 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: false 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: 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: 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/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 /v1/payments/utilityBillCompanies: get: tags: - Psd2Payments API summary: "" description: Retrieve Utility Bill Companies operationId: getUtilityCompanies consumes: - application/json produces: - application/json parameters: - name: client_id in: query description: Third party Provide ( TPP ) Application Id required: false type: string - name: client_secret in: query description: Unique ID for TPP 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: false 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: subscriptionId of TPP 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: 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/RetrieveCompaniesResponse' 302: description: Found schema: $ref: '#/definitions/RetrieveCompaniesResponse' 400: description: Bad Request schema: $ref: '#/definitions/ErrorResponse' 401: description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' 403: description: Forbidden schema: $ref: '#/definitions/ErrorResponse' 404: description: API URL Not Found schema: $ref: '#/definitions/ErrorResponse' 405: description: Method not Found schema: $ref: '#/definitions/ErrorResponse' 406: description: Not Acceptable schema: $ref: '#/definitions/ErrorResponse' 429: description: Too many Requests schema: $ref: '#/definitions/ErrorResponse' 500: description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' 503: description: Service Unavailable schema: $ref: '#/definitions/ErrorResponse' /v1/payment/healthCheck: get: responses: 200: description: 200 OK operationId: healthCheck security: - [] consumes: [] produces: [] /v1/payments/standingOrder/initiate: post: tags: - Psd2Payments Initiate StandingOrder API summary: "" description: Create Standing Order operationId: initiateStandingOrder consumes: - application/json produces: - application/json parameters: - name: subscriptionId in: header required: false type: string - name: Authorization in: header required: true type: string - name: journeyId in: header required: true type: string - name: originUserId in: header required: false type: string - name: timeStamp in: header required: true type: string - name: tppId in: header required: false type: string - name: correlationId in: header required: false type: string - name: lang in: header required: false type: string - name: originSourceId in: header required: false type: string - name: originChannelId in: header required: false type: string - name: originDeptId in: header required: false type: string - name: originEmployeeId in: header required: false type: string - name: originTerminalId in: header required: false type: string - name: customerIp in: header required: true type: string - name: customerSessionId in: header required: true type: string - name: customerDevice in: header required: true type: string - name: loginTimeStamp in: header required: true type: string format: date-time - name: client_id in: header required: false type: string - in: body name: body required: true schema: $ref: '#/definitions/InitiateStandingOrderRequest' responses: 200: description: OK schema: $ref: '#/definitions/InitiateStandingOrderResponse' 201: description: Created schema: $ref: '#/definitions/InitiateStandingOrderResponse' 202: description: Accepted schema: $ref: '#/definitions/InitiateStandingOrderResponse' 302: description: Found schema: $ref: '#/definitions/InitiateStandingOrderResponse' 400: description: Bad Request schema: $ref: '#/definitions/ErrorResponse' 401: description: Unauthorized schema: $ref: '#/definitions/ErrorResponse' 403: description: Forbidden schema: $ref: '#/definitions/ErrorResponse' 404: description: API URL Not Found schema: $ref: '#/definitions/ErrorResponse' 405: description: Method not Found schema: $ref: '#/definitions/ErrorResponse' 406: description: Not Acceptable schema: $ref: '#/definitions/ErrorResponse' 429: description: Too many Requests schema: $ref: '#/definitions/ErrorResponse' 500: description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' 503: description: Service Unavailable schema: $ref: '#/definitions/ErrorResponse' /v1/payments/massPaymentsXML: post: operationId: createMassPayments schemes: - http - https consumes: - application/json produces: - application/json parameters: - name: client_id in: header description: Third party Provide ( TPP ) Application Id 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: false 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: 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 - in: body name: requestBody required: true schema: $ref: '#/definitions/CreateMassPaymentXMLRequest' responses: 200: description: OK schema: $ref: '#/definitions/InitiateMassPaymentResponse' 400: description: Bad Request schema: $ref: '#/definitions/ErrorResponse' 404: description: Not Found schema: $ref: '#/definitions/ErrorResponse' 405: description: Method Not Allowed schema: $ref: '#/definitions/ErrorResponse' 500: description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' tags: - PSD2 Payments /v1/payments/massPaymentsXML/{paymentId}: get: tags: - PSD2 Payments operationId: getMassPaymentStatusXML parameters: - name: paymentId type: string required: true in: path - name: client_id in: header description: Third party Provide ( TPP ) Application Id 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: false 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: 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/GetMassPaymentStatusXMLResponse' 400: description: Bad Request schema: $ref: '#/definitions/ErrorResponse' 404: description: Not Found schema: $ref: '#/definitions/ErrorResponse' 405: description: Method Not Allowed schema: $ref: '#/definitions/ErrorResponse' 500: description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' summary: getMassPaymentStatusXML /v1/payments/groupPayments/initiate: post: responses: 200: description: 200 OK schema: $ref: '#/definitions/InitiateGroupPaymentResponse' tags: - PSD2 Payments operationId: initiateGroupPayment parameters: - name: client_id in: header description: Third party Provide ( TPP ) Application Id 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: false 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: 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 - in: body name: requestBody required: true schema: $ref: '#/definitions/InitiateGroupPaymentRequest' summary: initiate Group Payment description: initiate Group Payment definitions: AdditionalDetails: type: object properties: errorCode: type: string severity: type: string status: type: string description: type: string getPaymentStatusResponse: type: object properties: status: $ref: '#/definitions/Status' totalDebitAmount: $ref: '#/definitions/Amount' RetrieveCompaniesResponse: type: object required: - utilityCompanies properties: utilityCompanies: type: array items: $ref: '#/definitions/UtilityBillCompany' InitiateStandingOrderRequest: type: object required: - creditor - debtor - frequency - lastPaymentDate - recurringAmount - startDate properties: retrieveDebitAccount: type: string frequency: type: string enum: - DAILY - WEEKLY - MONTHLY - QUARTERLY - SEMI_ANNUALLY - ANNUALLY - FORTNIGHTLY debtor: $ref: '#/definitions/Debtor' creditor: $ref: '#/definitions/Creditor' initialAmount: $ref: '#/definitions/Amount' finalAmount: $ref: '#/definitions/Amount' recurringAmount: $ref: '#/definitions/Amount' startDate: type: string lastPaymentDate: type: string description: type: string url: type: string minLength: 0 maxLength: 60 referenceId: type: string minLength: 0 maxLength: 35 InitiateStandingOrderResponse: type: object properties: retrieveDebitAccount: type: string authCodeNeeded: type: boolean default: false getstandingOrder: $ref: '#/definitions/StandingOrder' url: type: string minLength: 0 maxLength: 60 referenceId: type: string minLength: 0 maxLength: 35 UtilityBillCompany: type: object required: - accountCheckDigit - amountCheckDigit - companyCode - companyName properties: companyName: type: string companyCode: type: string amountCheckDigit: type: boolean default: false accountCheckDigit: type: boolean default: false 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. Amount: type: object required: - amount properties: amount: type: number format: double currency: type: string minLength: 0 maxLength: 3 currencyRate: type: string FundAvailabilityRequest: type: object required: - accountId - transaction properties: bankId: type: string accountId: type: string transaction: $ref: '#/definitions/Amount' CreatePaymentResponse: type: object properties: authCodeNeeded: type: boolean payment: $ref: '#/definitions/Payment' Debtor: type: object required: - accountId properties: bankId: type: string minLength: 0 maxLength: 20 pattern: ([A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}) accountId: type: string minLength: 0 maxLength: 35 pattern: '[A-Za-z\ ,0-9,]*' accountName: pattern: '[A-Za-z\ ,0-9,]*' type: string Charges: type: object properties: name: type: string value: type: string RUB: type: object properties: voCode: type: string minLength: 0 maxLength: 35 correspondentAccount: type: string minLength: 0 maxLength: 35 BIK: type: string minLength: 0 maxLength: 35 INN: type: string minLength: 0 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 StandingOrder: type: object properties: refNumber: type: string frequency: type: string enum: - DAILY - WEEKLY - MONTHLY - QUARTERLY - SEMI_ANNUALLY - ANNUALLY - FORTNIGHTLY 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' ErrorResponse: type: object properties: fatalError: type: boolean error: $ref: '#/definitions/Error' RecurringInfo: type: object required: - frequency - lastPaymentDate - recurringAmount - startDate properties: frequency: type: string enum: - DAILY - WEEKLY - MONTHLY - QUARTERLY - SEMI_ANNUALLY - ANNUALLY - FORTNIGHTLY initialAmount: $ref: '#/definitions/Amount' finalAmount: $ref: '#/definitions/Amount' recurringAmount: $ref: '#/definitions/Amount' startDate: type: string lastPaymentDate: type: string 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 minLength: 0 maxLength: 35 paymentDetails: type: string minLength: 0 maxLength: 137 terminalId: type: string minLength: 0 maxLength: 35 branch: type: string minLength: 0 maxLength: 35 executionDate: type: string valueDate: type: string totalDebitAmount: $ref: '#/definitions/Amount' attachments: type: array items: $ref: '#/definitions/Attachment' recurringInfo: $ref: '#/definitions/RecurringInfo' RUB: $ref: '#/definitions/RUB' Creditor: type: object required: - accountId properties: bankId: type: string minLength: 0 maxLength: 20 accountId: type: string minLength: 0 maxLength: 35 name: type: string minLength: 0 maxLength: 35 address: type: string minLength: 0 maxLength: 105 bankName: type: string minLength: 0 maxLength: 50 bankAddress: type: string minLength: 0 maxLength: 200 bankBic: type: string minLength: 0 maxLength: 10 checkDigit: type: string amountCheckDigit: type: string billNumber: type: string minLength: 0 maxLength: 35 utilityCompany: type: string minLength: 0 maxLength: 20 InitiatePaymentRequest: type: object required: - creditor - paymentDetails - transactionAmount properties: debtor: $ref: '#/definitions/Debtor' creditor: $ref: '#/definitions/Creditor' transactionAmount: $ref: '#/definitions/Amount' endToEndId: type: string maxLength: 35 retrieveDebitAccount: type: string 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' InitiatePaymentResponse: type: object properties: authCodeNeeded: type: boolean retrieveDebitAccount: type: string payment: $ref: '#/definitions/Payment' InitiateMassPaymentResponse: properties: uploadedFile: $ref: '#/definitions/Attachment' paymentId: type: string numberOfPayments: type: string retrieveDebitAccount: type: string timeStamp: type: string additionalProperties: false CreateMassPaymentXMLRequest: type: object required: - uploadedFile properties: uploadedFile: $ref: '#/definitions/Attachment' timeStamp: type: string example: "2023-09-07T10:10:00.898+0000" retrieveDebitAccount: type: string example: "true" GetMassPaymentStatusXMLResponse: properties: numberOfTransactions: type: number massPaymentStatus: items: $ref: '#/definitions/MassPaymentStatus' type: array additionalProperties: false required: - massPaymentStatus - numberOfTransactions MassPaymentStatus: type: object properties: massPayment: $ref: '#/definitions/massPayment' status: $ref: '#/definitions/Status' required: - massPayment - status massPayment: properties: debtor: $ref: '#/definitions/Debtor' massPaymentCreditor: $ref: '#/definitions/massPaymentCreditor' contactPhoneNumber: type: string description: contact telephone number of debitor maxLength: 35 minLength: 0 pattern: '[0-9]*' 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: maxLength: 100 minLength: 0 pattern: (([a-zA-Z0-9\_\-])+(\.[a-zA-Z0-9\_\-]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*(\.[a-zA-Z]{2,})$)? type: string RUB: $ref: '#/definitions/RUB' executionDate: type: string valueDate: type: string additionalProperties: false massPaymentCreditor: 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 companyCode: type: string checkDigit: type: string amountCheckDigit: type: string additionalProperties: false required: - accountId ShortAddress: properties: line1: type: string line2: type: string line3: type: string line4: type: string additionalProperties: false Description: properties: line1: type: string maxLength: 140 minLength: 0 pattern: '[A-Za-z\u0391-\u03A9\u03B1-\u03C9\u03AC-\u03CE\u0386-\u038F\.\,\-\?\:\+\''\/\(\)\ ,0-9,]*' line2: type: string maxLength: 140 minLength: 0 pattern: '[A-Za-z\u0391-\u03A9\u03B1-\u03C9\u03AC-\u03CE\u0386-\u038F\.\,\-\?\:\+\''\/\(\)\ ,0-9,]*' line3: type: string maxLength: 140 minLength: 0 pattern: '[A-Za-z\u0391-\u03A9\u03B1-\u03C9\u03AC-\u03CE\u0386-\u038F\.\,\-\?\:\+\''\/\(\)\ ,0-9,]*' line4: type: string maxLength: 140 minLength: 0 pattern: '[A-Za-z\u0391-\u03A9\u03B1-\u03C9\u03AC-\u03CE\u0386-\u038F\.\,\-\?\:\+\''\/\(\)\ ,0-9,]*' additionalProperties: false NotificationOption: properties: faxNumber: type: string maxLength: 35 minLength: 0 pattern: '[0-9]*' email: maxLength: 100 minLength: 0 pattern: (([a-zA-Z0-9\_\-])+(\.[a-zA-Z0-9\_\-]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*(\.[a-zA-Z]{2,})$)? type: string additionalProperties: false StatusNotificationOption: properties: email: maxLength: 100 minLength: 0 pattern: (([a-zA-Z0-9\_\-])+(\.[a-zA-Z0-9\_\-]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*(\.[a-zA-Z]{2,})$)? type: string statusCode: type: string additionalProperties: false required: - email - statusCode ChargesAccount: properties: accountId: type: string bankId: type: string additionalProperties: false required: - accountId - bankId InitiateGroupPaymentRequest: properties: type: type: string enum: - PAYROLL - GROUP_PAYMENT companyCode: type: string processingDate: type: string format: date-time total: $ref: '#/definitions/Amount' retrieveDebitAccount: type: string description: type: string uploadedFile: $ref: '#/definitions/Attachment' additionalProperties: false required: - type - companyCode - total - uploadedFile InitiateGroupPaymentResponse: properties: uploadedFile: $ref: '#/definitions/Attachment' paymentId: type: string description: paymentId retrieveDebitAccount: type: string description: retrieveDebitAccount description: type: string description: description additionalProperties: false x-ibm-configuration: enforced: true testable: true phase: realized securityDefinitions: Access Code - Oauth: type: oauth2 description: "" flow: accessCode scopes: UserOAuth2Security: "" authorizationUrl: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/psd2/oauth2/authorize tokenUrl: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/oauth2/token Application - Oauth: type: oauth2 description: "" flow: application scopes: TPPOAuth2Security: "" tokenUrl: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/oauth2/token x-tokenIntrospect: url: "" security: - Application - Oauth: - TPPOAuth2Security Access Code - Oauth: - UserOAuth2Security produces: - application/json x-ibm-endpoints: - endpointUrl: https://apis.bankofcyprus.com/df-boc-org-prd/prod description: APIC Gateway Server type: - production ...