--- swagger: "2.0" info: x-ibm-name: payments title: Transactions/Payments version: 1.2.7 description: Transactions/Payments API supports various kinds of payments (single/RF and bill/non-RF payments) contact: name: rapidlink support email: rapidlink@piraeusbank.gr url: https://rapidlink.piraeusbank.gr termsOfService: Privacy Policy license: name: Terms and Conditions of Use url: https://rapidlink.piraeusbank.gr/terms schemes: - https basePath: /v1.2/transactions/payments consumes: - application/json produces: - application/json securityDefinitions: MSIS OAuth: type: oauth2 description: "" flow: accessCode authorizationUrl: https://openbank.piraeusbank.gr/identityserver/connect/authorize scopes: winbankAccess winbankAccess.info winbankAccess.monetaryTransactions: "" tokenUrl: https://openbank.piraeusbank.gr/identityserver/connect/token x-tokenIntrospect: url: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/v1.2/oauth/external/introspect Sandbox OAuth: type: oauth2 description: Resource Owner Implicit Grant Type flow: accessCode authorizationUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize scopes: /sandboxapi: Access to all payments resources in sandbox tokenUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/token x-tokenIntrospect: url: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/v1.2.1/oauth/internal/introspect clientIdHeader: type: apiKey in: header name: X-IBM-Client-Id description: Client ID Header security: - clientIdHeader: [] MSIS OAuth: - winbankAccess winbankAccess.info winbankAccess.monetaryTransactions - clientIdHeader: [] Sandbox OAuth: - /sandboxapi x-ibm-configuration: testable: true enforced: true phase: realized categories: - Transactions paths: /codes: get: responses: 200: description: 200 OK schema: $ref: '#/definitions/Codes_Output' operationId: GetAllCodes summary: Retrieve all payment codes description: Retrieve all payment codes tags: - Transactions - Payments parameters: - $ref: '#/parameters/Authorization' /codes/{paymentCode}: get: responses: 200: description: 200 OK schema: $ref: '#/definitions/Code_Output' parameters: - name: paymentCode type: string required: true in: path operationId: GetSpecificCode summary: Retrieve information about a specific payment code description: Retrieve information about a specific payment code tags: - Transactions - Payments /single/{RFCode}/validate: post: responses: 200: description: 200 OK schema: $ref: '#/definitions/Payments_Single_Validate_Output' parameters: - name: RFCode type: string required: true in: path description: payment code in RF999..999 format - name: payments_single_validate_input required: false in: body schema: $ref: '#/definitions/Payments_Single_Validate_Input' operationId: ValidateSinglePayment tags: - Transactions - Payments summary: Validate a single (RF) payment description: Validate a single (RF) payment /single/{RFCode}/execute/{SessionKey}: post: responses: 200: description: 200 OK schema: $ref: '#/definitions/Payments_Single_Execute_Output' parameters: - name: SessionKey type: string required: true in: path description: Session key retrieved from payment validation step - name: payments_single_execute_input required: false in: body schema: $ref: '#/definitions/Payments_Single_Execute_Input' operationId: ExecuteSinglePayment tags: - Transactions - Payments summary: Execute a single (RF) payment description: Execute a single (RF) payment /{paymentCode}/validate: post: responses: 200: description: 200 OK schema: $ref: '#/definitions/Payments_Validate_Output' parameters: - name: paymentDetails required: false in: body schema: $ref: '#/definitions/Payments_Validate_Input' operationId: ValidatePayment summary: Validate a (non-RF) bill payment description: Validate a (non-RF) bill payment tags: - Transactions - Payments parameters: - $ref: '#/parameters/Authorization' - $ref: '#/parameters/PaymentCode' /{paymentCode}/execute/{SessionKey}: post: responses: 200: description: 200 OK schema: $ref: '#/definitions/Payments_Execute_Output' operationId: ExecutePayment summary: Execute a (non-RF) bill payment description: Execute a (non-RF) bill payment tags: - Transactions - Payments parameters: - $ref: '#/parameters/Authorization' - $ref: '#/parameters/PaymentCode' - name: SessionKey type: string required: true in: path description: Session key retrieved from payment validation step /{paymentOrderID}/history: get: responses: 200: description: 200 OK schema: $ref: '#/definitions/PaymentOrder_History_Output' operationId: GetRecurringHistory parameters: - name: paymentOrderID type: integer required: true in: path format: int64 description: the id of the payment order to retrieve its execution history (list of payments) tags: - Transactions - Payments summary: Retrieve recurring history of a specific payment order description: Retrieve recurring history of a specific payment order /{paymentOrderID}/{paymentID}: get: responses: 200: description: 200 OK schema: $ref: '#/definitions/GetTransactionDetails_Output' operationId: GetTransactionDetails parameters: - name: paymentOrderID type: integer required: true in: path format: int64 - name: paymentID type: integer required: true in: path format: int64 tags: - Transactions - Payments summary: Retrieve details about a specific transaction/payment description: Retrieve details about a specific transaction/payment /{paymentOrderID}/action/{action}: put: responses: 200: description: 200 OK schema: $ref: '#/definitions/PaymentOrder_Action_Output' operationId: UpdatePaymentOrderExecution parameters: - name: paymentOrderID type: integer required: true in: path format: int64 description: Payment Order ID to act upon - name: action type: string required: true in: path description: 'Action to perform on Payment Order (possible values: 0 = Suspend, 1 = Resume, 2 = Cancel, 3 = Complete, 4 = Reversal )' summary: Update execution of a specific payment order description: Update execution of a specific payment order tags: - Transactions - Payments /history/type/{type}: get: responses: 200: description: 200 OK schema: $ref: '#/definitions/Transaction_History_Output' operationId: GetTransactionHistory parameters: - name: type type: string required: true in: path description: 'Possible values: done, active, canceled' - name: pageSize type: string required: false in: query description: Number of rows to return - name: pagingId type: string required: false in: query description: Fetch entries after this Payment Order ID - name: dateFrom type: string required: false in: query description: Earlier date of the entries to fetch - name: dateTo type: string required: false in: query description: Latest date of the entries to fetch summary: Retrieve transaction history per transaction type description: Retrieve transaction history per transaction type tags: - Transactions - Payments definitions: Error_Output: description: Standard error object type: object properties: httpCode: type: string description: Http code of returned error httpMessage: type: string description: Http message of returned error errorCode: type: string description: Code of returned error errorMessage: type: string description: Message of returned error example: "{\n\t\"httpCode\": \"412\",\n\t\"httpMessage\": \"Precondition Failed\",\n\t\"errorCode\": \"API-987\",\n\t\"errorMessage\": \"sample error message\"\n}" Payments_Single_Validate_Input: properties: assetId: type: string description: Id of asset from which the payment will be done assetType: properties: [] type: string description: Type of asset from which the payment will done (values 'account', 'creditCard') example: account amount: properties: [] type: number format: double description: Amount of the particular payment example: 10.350000 currency: properties: [] type: string description: Currency of the particular payment example: EUR installments: properties: [] type: integer format: int32 description: number of installments (for specific asset types, e.g. credit card) example: "5" scheduling: properties: [] $ref: '#/definitions/Scheduling' description: Scheduling parameters for future payment additionalProperties: false required: - assetId - assetType - amount - currency description: Object containing the input data to be provided for a single (RF) payment to be validated Payments_Single_Validate_Output: properties: Installments: type: integer format: int32 description: Number of installments (for specific asset types, e.g. credit card) example: "0" RFCode: properties: [] type: string description: The organization's (RF) code of the particular payment example: RF84907738000300001234567 PaymentCode: properties: [] type: string description: Payment code (internal notation) PaymentDescription: properties: [] type: string description: Description of internal payment code example: DEH SessionKey: properties: [] type: string example: 2112c28e9d2342a0b7b2bb94ef523736 description: Session key required along with the OTP for payment execution Status: properties: [] type: string example: Success description: Status of validation of the particular payment Amount: properties: [] type: number format: double description: Amount of payment example: 25.300000 Currency: properties: [] type: string description: Currency of payment example: EUR RequiresApproval: properties: [] type: boolean description: Flag indicating whether the payment requires approval example: "false" RequiresTransactionalPin: properties: [] type: boolean description: Flag indicating whether the payment requires OTP Execute: properties: [] type: string description: Date of single payment execution Commission: properties: [] type: number format: double description: Amount of commissions charged for payment execution CommissionCurrency: properties: [] type: string description: Currency of commissions additionalProperties: false description: Object containing the output data to be returned upon validation of a single (RF) payment Payments_Single_Execute_Input: properties: ExtraPin: type: string description: One Time Pin (OTP) to be provided for payment execution additionalProperties: false description: Object containing the input data to be provided for single (RF) payment execution Payments_Single_Execute_Output: properties: Succeded: type: boolean description: Flag indicating whether the single (RF) payment execution was successful example: "" TransactionReference: properties: [] type: string description: Transaction reference number generated upon successful execution of single (RF) payment Status: properties: [] type: string description: Status of payment execution Message: properties: [] type: string description: System message returned RequiresApproval: properties: [] type: boolean description: Flag indicating whether the payment requires approval RequiresTransactionalPin: properties: [] type: boolean description: Flag indicating whether the payment requires OTP AssetType: properties: [] type: string description: Type of asset from which the payment was done AssetNumber: properties: [] type: string description: Id number of asset from which the payment was done RFCode: properties: [] type: string description: The organization's (RF) code of the particular payment Amount: properties: [] type: string description: Amount of the particular payment Currency: properties: [] type: string description: Currency of the particular payment Commission: properties: [] type: string description: Amount of commissions charged for payment execution CommissionCurrency: properties: [] type: string description: Currency of commissions Execute: properties: [] type: string description: Date of single payment execution additionalProperties: false description: Object containing the output data to be returned upon execution of a single (RF) payment Scheduling: properties: ExecuteDate: type: string format: date description: Scheduled date of payment execution example: '''2022-12-31''' Recurrence: properties: [] type: integer format: int32 description: Recurrence options ( 0 = None, 1 = First Day of Month, 2 = Last Day of Month, 3 = Specific Day of Month) example: "2" RecurrenceDay: properties: [] type: integer format: int32 description: Specific day of month when the payment execution should recur (required when Recurrence value is 3) example: "3" additionalProperties: false description: Object containing the data to be provided for future payment scheduling Codes_Output: description: Array of objects of type Code_Output type: array xml: namespace: "" items: $ref: '#/definitions/Code_Output' Code_Output: description: Object containing the basic information about a specific payment code type: object properties: id: type: integer description: Unique identifier of payment code example: "6303" format: int32 name: type: string description: Name of payment example: Vodafone Mobile/Fixed definition: properties: categoryID: type: number categoryDescription: type: string subCategoryID: type: number subCategoryDescription: type: string paymentCode: type: string paymentDescription: type: string paymentLogo: type: string isPopularPayment: type: boolean sample: type: object properties: [] requires2FA: type: boolean ib_action: type: string hostTxCode: type: string useCreditCard: type: boolean numberOfInstallments: type: number useDebitCard: type: boolean usePrepaidCard: type: boolean useAccount: type: boolean onlyPiraeusCards: type: boolean fields: type: array items: properties: name: type: string type: type: string mandatory: type: boolean showOnResult: type: boolean partOfPayment: type: boolean size: type: number length: type: number assetType: type: array items: properties: name: type: string title: type: object properties: gr: type: string en: type: string type: object type: object $ref: '#/definitions/Code_Definition' description: Object containing the definition of a specific payment code example: " {\r\n \"id\": \"6201\",\r\n \"name\": \"EFKA Employers Contributions\",\r\n \"definition\": {\r\n \"categoryID\": 5,\r\n \"categoryDescription\": \"Public Sector\",\r\n \"subCategoryID\": 504,\r\n \"subCategoryDescription\": \"Social Security Funds\",\r\n \ \"paymentCode\": \"6201\",\r\n \"paymentDescription\": \"EFKA Employers Contributions\",\r\n \"paymentLogo\": \"images/BillPayments/Logo/6201.png\",\r\n \ \"isPopularPayment\": true,\r\n \"sample\": {},\r\n \ \"requires2FA\": false,\r\n \"ib_action\": \"PiraeusBank.InternationalBanking.Services.GenericPayment.6201\",\r\n \ \"hostTxCode\": \"1000115\",\r\n \"useCreditCard\": true,\r\n \"numberOfInstallments\": 1,\r\n \"useDebitCard\": true,\r\n \"usePrepaidCard\": true,\r\n \"useAccount\": true,\r\n \"onlyPiraeusCards\": false,\r\n \"fields\": [\r\n {\r\n \"name\": \"AssetFrom\",\r\n \ \"type\": \"text\",\r\n \"mandatory\": true,\r\n \"showOnResult\": false,\r\n \"partOfPayment\": true,\r\n \"size\": 50,\r\n \"length\": 50,\r\n \"assetType\": [\r\n {\r\n \ \"name\": \"creditCard\",\r\n \"title\": {\r\n \"gr\": \"CreditCard\",\r\n \"en\": \"CreditCard\"\r\n }\r\n },\r\n \ {\r\n \"name\": \"debitCard\",\r\n \ \"title\": {\r\n \"gr\": \"DebitCard\",\r\n \"en\": \"DebitCard\"\r\n \ }\r\n },\r\n {\r\n \ \"name\": \"prepaidCard\",\r\n \"title\": {\r\n \"gr\": \"PrepaidCard\",\r\n \"en\": \"PrepaidCard\"\r\n }\r\n },\r\n \ {\r\n \"name\": \"account\",\r\n \ \"title\": {\r\n \"gr\": \"Account\",\r\n \"en\": \"Account\"\r\n \ }\r\n }\r\n ]\r\n \ },\r\n {\r\n \"name\": \"SubscriberCode\",\r\n \"type\": \"text\",\r\n \"mandatory\": true,\r\n \"showOnResult\": true,\r\n \"partOfPayment\": true,\r\n \"size\": 0,\r\n \"length\": 30,\r\n \"title\": {\r\n \"gr\": \"IKAPaymentCode\",\r\n \"en\": \"IKAPaymentCode\"\r\n \ }\r\n },\r\n {\r\n \ \"name\": \"AmountValue\",\r\n \"type\": \"money\",\r\n \"mandatory\": true,\r\n \"showOnResult\": false,\r\n \"partOfPayment\": true,\r\n \"size\": 0,\r\n \"length\": 13,\r\n \"title\": {\r\n \"gr\": \"amount\",\r\n \"en\": \"amount\"\r\n }\r\n }\r\n ]\r\n \ }\r\n }" Code_Definition: description: Object containing the definition of a specific payment code type: object properties: categoryID: type: integer description: Unique Identifier of the category in which the payment code belongs format: int32 example: "7" categoryDescription: type: string description: Description of the category in which the payment code belongs example: Telecommunications subCategoryID: type: integer description: Unique Identifier of the subcategory in which the payment code belongs format: int32 example: "702" subCategoryDescription: type: string description: Description of the subcategory in which the payment code belongs example: Telecommunications paymentCode: type: string description: Payment code example: "6303" paymentDescription: type: string description: Description of payment code example: Vodafone Mobile/Fixed paymentLogo: type: string example: /images/BillPayments/Logo/6303.png description: Path of specific payment's logo image isPopularPayment: type: boolean description: Flag indicating whether the specific payment is popular example: "true" sample: type: object properties: [] example: '{}' description: Object providing a sample of the payment requires2FA: type: boolean description: Flag indicating whether the specific payment requires second-factor authentication (OTP) example: "false" ib_action: type: integer description: Internally defined action for specific payment code format: int32 example: Piraeusbank.InternationalBanking.Services.GenericPayment.6303 hostTxCode: type: string description: Internally generated host transaction code for specific payment example: "1000427" useCreditCard: type: boolean description: Flag indicating whether the specific payment can be executed via credit card example: "true" numberOfInstallments: type: integer format: int32 description: Maximum number of instalments in case of credit card use example: "1" useDebitCard: type: boolean description: Flag indicating whether the specific payment can be executed via debit card example: "true" usePrepaidCard: type: boolean description: Flag indicating whether the specific payment can be executed via prepaid card example: "true" useAccount: type: boolean description: Flag indicating whether the specific payment can be executed via account example: "true" onlyPiraeusCards: type: boolean description: Flag indicating whether the specific payment can be executed via Piraeusbank cards only example: "true" fields: items: properties: name: type: string type: type: string mandatory: type: boolean showOnResult: type: boolean partOfPayment: type: boolean size: type: number length: type: number assetType: type: array items: properties: name: type: string title: type: object properties: gr: type: string en: type: string type: object type: object $ref: '#/definitions/Code_Definition_Fields' description: Object containing additional fields related to the definition of the specific payment code example: "{\r\n \"categoryID\": 3,\r\n \"categoryDescription\": \"Energy\",\r\n \"subCategoryID\": 302,\r\n \"subCategoryDescription\": \"Gas\",\r\n \"paymentCode\": \"6426\",\r\n \"paymentDescription\": \"Zeni� Gas Utility\",\r\n \"paymentLogo\": \"images/BillPayments/Logo/6426.png\",\r\n \ \"isPopularPayment\": false,\r\n \"sample\": {},\r\n \"requires2FA\": false,\r\n \"ib_action\": \"PiraeusBank.InternationalBanking.Services.GenericPayment.6426\",\r\n \ \"hostTxCode\": \"1000140\",\r\n \"useCreditCard\": true,\r\n \ \"numberOfInstallments\": 9,\r\n \"useDebitCard\": true,\r\n \ \"usePrepaidCard\": true,\r\n \"useAccount\": true,\r\n \"onlyPiraeusCards\": false,\r\n \"fields\": [\r\n {\r\n \"name\": \"AssetFrom\",\r\n \"type\": \"text\",\r\n \"mandatory\": true,\r\n \"showOnResult\": false,\r\n \"partOfPayment\": true,\r\n \"size\": 50,\r\n \"length\": 50,\r\n \ \"assetType\": [\r\n {\r\n \"name\": \"creditCard\",\r\n \"title\": {\r\n \"gr\": \"CreditCard\",\r\n \"en\": \"CreditCard\"\r\n }\r\n \ },\r\n {\r\n \"name\": \"debitCard\",\r\n \"title\": {\r\n \"gr\": \"DebitCard\",\r\n \"en\": \"DebitCard\"\r\n }\r\n \ },\r\n {\r\n \"name\": \"prepaidCard\",\r\n \"title\": {\r\n \"gr\": \"PrepaidCard\",\r\n \"en\": \"PrepaidCard\"\r\n \ }\r\n },\r\n {\r\n \ \"name\": \"account\",\r\n \"title\": {\r\n \"gr\": \"Account\",\r\n \"en\": \"Account\"\r\n }\r\n }\r\n ]\r\n \ },\r\n {\r\n \"name\": \"PayeeName\",\r\n \ \"type\": \"text\",\r\n \"mandatory\": true,\r\n \ \"showOnResult\": true,\r\n \"partOfPayment\": false,\r\n \"size\": 0,\r\n \"length\": 50,\r\n \ \"title\": {\r\n \"gr\": \"fullName\",\r\n \ \"en\": \"fullName\"\r\n }\r\n },\r\n \ {\r\n \"name\": \"SubscriberCode\",\r\n \"type\": \"text\",\r\n \"mandatory\": true,\r\n \"showOnResult\": true,\r\n \"partOfPayment\": true,\r\n \"size\": 0,\r\n \"length\": 20,\r\n \"title\": {\r\n \"gr\": \"paymentCode\",\r\n \"en\": \"paymentCode\"\r\n }\r\n \ },\r\n {\r\n \"name\": \"AmountValue\",\r\n \ \"type\": \"money\",\r\n \"mandatory\": true,\r\n \ \"showOnResult\": false,\r\n \"partOfPayment\": true,\r\n \"size\": 0,\r\n \"length\": 13,\r\n \ \"title\": {\r\n \"gr\": \"amount\",\r\n \ \"en\": \"amount\"\r\n }\r\n }\r\n \ ]\r\n }" Code_Definition_Fields: type: array items: $ref: '#/definitions/Code_Definition_Field' description: Array of objects of type Code_Definition_Field Code_Definition_Field: description: Object containing additional fields related to the definition of the specific payment code type: object properties: name: type: string description: Name of field example: AssetFrom type: type: string description: Type of field example: Text mandatory: type: boolean description: Flag indicating whether the field is mandatory example: "true" showOnResult: type: boolean description: Flag indicating whether the field will be shown in the result of payment execution example: "false" partOfPayment: type: boolean description: Flag indicating whether the field is part of the payment example: "true" size: type: integer format: int32 description: Maximum character size of the particular field example: "50" length: type: integer format: int32 description: Maximum length of the particular field example: "50" assetType: items: properties: name: type: string title: type: object properties: gr: type: string en: type: string type: object $ref: '#/definitions/Code_Definition_Field_AssetTypeArray' description: Array of objects containing information about each of the asset types available for the specific payment definition example: "{\r\n \"name\": \"AssetFrom\",\r\n \"type\": \"text\",\r\n \"mandatory\": true,\r\n \"showOnResult\": false,\r\n \"partOfPayment\": true,\r\n \"size\": 50,\r\n \"length\": 50,\r\n \"assetType\": [\r\n \ {\r\n \"name\": \"creditCard\",\r\n \ \"title\": {\r\n \"gr\": \"CreditCard\",\r\n \"en\": \"CreditCard\"\r\n }\r\n \ },\r\n {\r\n \"name\": \"debitCard\",\r\n \"title\": {\r\n \"gr\": \"DebitCard\",\r\n \"en\": \"DebitCard\"\r\n }\r\n \ },\r\n {\r\n \"name\": \"prepaidCard\",\r\n \"title\": {\r\n \"gr\": \"PrepaidCard\",\r\n \"en\": \"PrepaidCard\"\r\n \ }\r\n },\r\n {\r\n \ \"name\": \"account\",\r\n \"title\": {\r\n \"gr\": \"Account\",\r\n \"en\": \"Account\"\r\n }\r\n }\r\n ]\r\n \ }" Code_Definition_Field_AssetTypeArray: type: array items: $ref: '#/definitions/Code_Definition_Field_AssetType' description: Array of objects of type Code_Definition_Field_AssetType Code_Definition_Field_AssetType: description: Object containing information about each of the asset types available for the specific payment definition type: object properties: name: type: string description: Name of asset type supported for the specific payment code example: creditCard title: properties: gr: type: string en: type: string $ref: '#/definitions/Code_Definition_Field_AssetType_Title' description: Array of titles of the asset type supported for the specific payment code per language example: "" example: " {\r\n \"name\": \"creditCard\",\r\n \"title\": {\r\n \"gr\": \"CreditCard\",\r\n \"en\": \"CreditCard\"\r\n }\r\n }" Code_Definition_Field_AssetType_Title: description: Array of titles of the asset type supported for the specific payment code per language (en, gr) type: object properties: gr: type: string description: Title of asset type in greek locale example: CreditCard en: type: string description: Title of asset type in english locale example: CreditCard example: "{\r\n \"gr\": \"CreditCard\",\r\n \"en\": \"CreditCard\"\r\n}" Payments_Validate_Input: properties: fields: type: array items: type: string description: Array of the fields that each payment expects as input as provided in the scheduling: $ref: '#/definitions/Scheduling' description: Object containing information about scheduling payment execution in a future date additionalProperties: false description: Object containing information about the input required by a specific payment code before validation Payments_Validate_Output: description: Object containing information about the output generated upon validation of a specific payment code type: object properties: requiredTokenType: type: integer example: 0 format: int32 succeeded: type: boolean example: "true" description: Boolean showing if the validation was successfull sessionKey: type: string example: 286e97192aa141e7a4fe215b60821fc3 description: Session key required along with the OTP for payment execution status: type: string example: success description: Status of the validation requiresApproval: type: boolean example: "false" description: True if second signature is needed to complete the execution requiresTransactionalPin: type: boolean example: "true" description: True if second factor authentication (extrapin) is needed account: type: string example: GR34 0172 1234 1234 1234 1234 123 (Πληρωμών) description: Iban account that will be charged amount: type: number example: 12.540000 description: Amount that will be paid format: double currency: type: string example: EUR description: Currency of the amount to be paid commission: type: number example: 0.600000 description: Commission that will be charged format: double commissionCurrency: type: string example: EUR description: Currency of the commission execute: type: string example: immediately description: Date of payment execution example: "{\r\n \"requiredTokenType\": 0,\r\n \"succeeded\": true,\r\n \"sessionKey\": \"286e97192aa141e7a4fe215b60821fc3\",\r\n \"status\": \"Success\",\r\n \"requiresApproval\": false,\r\n \"requiresTransactionalPin\": true,\r\n \"account\": \"GR34 0172 9760 0059 7600 8074 131 (Πληρωμών)\",\r\n \"amount\": 7.1,\r\n \"currency\": \"EUR\",\r\n \"commission\": 0.6,\r\n \"commissionCurrency\": \"EUR\",\r\n \ \"execute\": \"Immediately\"\r\n}" Payments_Execute_Input: properties: ExtraPin: type: string description: One Time Pin (OTP) to be provided for payment execution additionalProperties: false description: Object containing information about the input required by a specific payment code before execution Payments_Execute_Output: properties: Succeeded: type: boolean description: Succeeded TransactionReference: type: string description: Transaction Reference Status: type: string description: Status RequiresApproval: type: boolean description: Requires Approval BankAccount: type: string description: Bank Account Account: type: string description: Account paymentCode: type: string description: Payment Code Amount: type: number example: 12.500000 format: double description: Amount that was paid Currency: type: string example: EUR description: Currency of the paid amount Commission: type: number format: double example: 0.500000 description: Commission that was charged to execute the payment CommissionCurrency: type: string description: Currency of charged commission Execute: type: string description: Date of payment execution Message: type: string description: Message returned upon execution additionalProperties: false description: Object containing information about the output generated upon execution of a specific payment code PaymentOrder_History_Output: type: array items: $ref: '#/definitions/PaymentOrder_Payment_Output' description: Array of objects of type PaymentOrder_Payment_Output PaymentOrder_Payment_Output: properties: nextPaymentId: type: integer format: int32 description: Next Payment Id scheduledDate: type: string format: date-time description: Scheduled Date amount: $ref: '#/definitions/Amount' description: Amount status: type: integer format: int32 description: Status statusDescription: type: string description: Status Description paymentStatus: type: integer format: int32 description: Payment Status isRecurring: type: boolean description: Is Recurring paymentType: type: string description: Payment Type recipient: type: string description: Recipient additionalProperties: false description: Object containing information about a particular payment order PaymentOrder_Action_Output: properties: message: type: string description: Message additionalProperties: false description: Object containing information about a particular payment order action Amount: properties: Amount: type: number format: double description: Amount Currency: type: string description: Currency additionalProperties: false description: Object containing information about an amount GetTransactionDetails_Output: properties: paymentTypeDescription: type: string description: Payment Type Description transactionSearchType: type: integer description: Transaction Search Type format: int32 executionDate: type: string description: Execution Date format: date-time paymentOrderId: type: integer description: Payment Order Id format: int32 status: type: integer description: Status format: int32 statusDescription: type: string description: Status Description reason: type: string description: Reason posted_date: type: string description: Posted Date channel: type: string description: Channel card: type: string description: Card installments: type: string description: Installments payment_Code: type: string description: Payment Code amount: type: number description: Amount format: double currency: type: string description: Currency commission: type: number description: Commission format: double executeOn: type: string description: Execute On additionalProperties: false description: Object containing detailed information about a specific transaction Transaction_History_Output: properties: LastPaymentId: type: integer format: int32 description: Last Payment Id PagingPaymentId: type: string description: Paging Payment Id Transactions: $ref: '#/definitions/Transaction_History_Transactions' description: List of Transaction History objects additionalProperties: false description: Object containing information about the transaction history of a specific transaction type Transaction_History_Transactions: type: array items: $ref: '#/definitions/Transaction_History_TransactionDefinition' description: Array of objects of type Transaction_History_TransactionDefinition Transaction_History_TransactionDefinition: properties: PaymentOrderId: type: integer format: int32 description: Payment Order Id PaymentId: properties: [] type: integer format: int32 description: Payment Id PaymentAction: type: string description: Payment Action CustomerName: type: integer format: int32 description: Customer Name ExternalApp: type: string description: External App Description: type: string description: Description ExecutionDate: type: string format: date-time description: Execution Date PostedDate: type: string format: date-time description: Posted Date LastExecutionStatus: type: integer format: int32 description: Last Execution Status LastExecutionStatusDescription: type: string description: Last Execution Status Description Status: type: integer format: int32 description: Status of validation of the particular payment StatusDescription: type: string description: Status Description AccountNumber: type: string description: Account Number SourceType: type: integer format: int32 description: Source Type Amount: $ref: '#/definitions/Amount' description: Amount of payment Recipient: type: string description: Recipient SearchTransactionType: type: integer format: int32 description: Search Transaction Type PaymentTransactionType: type: integer format: int32 description: Payment Transaction Type additionalProperties: false description: Object containing information about a specific Transaction History element tags: - name: Transaction description: Transaction - name: Payment description: Payment parameters: Authorization: name: Authorization type: string required: true in: header description: This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2 CardId: name: CardId type: string required: true in: path description: Card ID input. returned from /assets/cards/list paymentCode: name: paymentCode type: string required: true in: path description: Payment code for bulk payment or payroll details externalDocs: description: Getting Started url: https://rapidlink.piraeusbank.gr/start x-ibm-endpoints: - endpointUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production description: Base Gateway API Endpoint type: - production - development ...