{"openapi":"3.0.3","info":{"title":"DN Online & Mobile API","description":"Diebold Nixdorf Online & Mobile API.","version":"3.2.1","contact":{"name":"Diebold Nixdorf","email":"info.de@dieboldnixdorf.com"}},"externalDocs":{"description":"Find out more about Swagger","url":"http://swagger.io"},"tags":[{"name":"Transaction Middleware","externalDocs":{"description":"Product page","url":"https://www.dieboldnixdorf.com/en-us/banking/portfolio/software/"}}],"servers":[{"url":"http://localhost:8080/tm-om-api/v4","description":"Transaction Middleware (VTE) 3.0+"},{"url":"https://localhost:8080/tm-om-api/v4","description":"Transaction Middleware (VTE) 3.0+"}],"paths":{"/getRsaKey":{"get":{"tags":["Accessibility API"],"summary":"Returns the public key (RSA) for API request encryption.","description":"If the client decides to use the __RSA/AES__ encryption scheme the __/getRsaKey__ endpoint can be used to obtain the server's public RSA key in PEM format. \n\nThe client is liable to encrypt all security relevant request parameters and parts of the request body (where applicable) with a 256 bit AES key of his own choosing.\n\nThe key parameters and initialization vector (128 bit) must be encrypted with the server's  public RSA key and transmitted alongside the request.","operationId":"getRsaKey","responses":{"200":{"$ref":"#/components/responses/getRsaKeyResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getEcKey":{"get":{"tags":["Accessibility API"],"summary":"Returns the public key (ECIES) of the server system.","description":"If the client decides to use the __ECIES__ encryption scheme the __/getEcKey__ endpoint can be used to obtain the servers public EC key in PEM format.\n\nThis key is used to encrypt critical request parameters and parts of  the request body (where applicable).\n\n### NOTE:\nThe ECIES implementation of iOS is not standard-compliant. At least until now.<br> In contrary to the description provided, Apple does not use authentication data in GCM.<br> That's why __for iOS clients the RSA/AES based solution MUST be used__ by using the __/getRsaKey__ endpoint.","operationId":"getEcKey","responses":{"200":{"$ref":"#/components/responses/getEcKeyResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getVersion":{"get":{"tags":["Accessibility API"],"summary":"Returns API version info.","description":"Returns API version information.","operationId":"getVersion","responses":{"200":{"$ref":"#/components/responses/getVersionResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getAccounts":{"get":{"tags":["Account Management API"],"summary":"Returns a list of accounts for the given consumerId.","description":"Returns a list of accounts for the given consumerId (see __GetAccountsResponsePayload__).\n\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"getAccounts","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/bankCodeParam"}],"responses":{"200":{"$ref":"#/components/responses/getAccountsResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getAccountTypes":{"get":{"tags":["Account Management API"],"summary":"Returns a list of supported account types.","description":"Returns a list of supported account types (see __GetAccountTypesResponsePayload__).\n\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"getAccountTypes","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"responses":{"200":{"$ref":"#/components/responses/getAccountTypesResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/checkAccount":{"get":{"tags":["Account Management API"],"summary":"Check for account.","description":"Check if a given account does exist (see __CheckAccountResponse__).\n### Example Response:\n\n    {\n      \"responseStatus\": {\n        \"success\": true\n      }\n    }","operationId":"checkAccount","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/bankCodeParam"},{"$ref":"#/components/parameters/accountNumberParam"},{"$ref":"#/components/parameters/accountTypeParam"}],"responses":{"200":{"$ref":"#/components/responses/checkAccountResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/createTransfer":{"post":{"tags":["Account Management API"],"summary":"Create a transfer of funds request.","description":"Create a transfer of funds request. Returns a referenceId if the transfer was created successfully (see __CreateTransferResponsePayload__).\n\nThe transfer's source account must be owned by the customer with the given consumerId (see __CreateTransferRequestPayload__).\n\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"createTransfer","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/createTransferRequestBody"},"responses":{"200":{"$ref":"#/components/responses/createTransferResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getTransactions":{"get":{"tags":["Account Management API"],"summary":"Returns all transactions for the given account and consumerId.","description":"Returns all transactions for the given account and consumerId (see __GetTransactionsResponsePayload__).\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"getTransactions","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/bankCodeParam"},{"$ref":"#/components/parameters/accountNumberParam"},{"$ref":"#/components/parameters/accountTypeParam"},{"name":"endDate","in":"query","description":"The __endDate__ parameter can be used to delimit  the results by the transactions' creation date. The validation pattern is __ISO-8601 Date__ (YYYY-MM-DD).  If __endDate__ is not provided the date of the  current day is used.\n\nBy default all transactions within 10 days prior to the given __endDate__ are selected. The 10 day offset can be adjusted on the server's configuration page in OCM. The configuration parameters are as follows:\n\n    \"configurationParams\": [\n      {\n        \"owner\": \"OM-API\",a\n        \"sectionName\": \"API\",\n        \"name\": \"getTransactions.endDateOffset\",\n        \"value\": \"10\",\n        \"secure\": false,\n        \"description\": \"StartDate offset in days.\"\n      }\n    ]","schema":{"type":"string","pattern":"([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))","example":"2022-01-31"}}],"responses":{"200":{"$ref":"#/components/responses/getTransactionsResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getScheduledTransactions":{"get":{"tags":["Account Management API"],"summary":"Returns all scheduled transactions for the given account and consumerId.","description":"Returns all scheduled transactions for the given account and consumerId (see __GetScheduledTransactionsResponsePayload__).\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"getScheduledTransactions","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/bankCodeParam"},{"$ref":"#/components/parameters/accountNumberParam"},{"$ref":"#/components/parameters/accountTypeParam"}],"responses":{"200":{"$ref":"#/components/responses/getScheduledTransactionsResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getAccountDetails":{"get":{"tags":["Account Management API"],"summary":"Returns detailed information for the given account and consumerId.","description":"Returns detailed information for the given account and consumerId (see __GetAccountDetailsResponsePayload__).\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"getAccountDetails","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/bankCodeParam"},{"$ref":"#/components/parameters/accountNumberParam"},{"$ref":"#/components/parameters/accountTypeParam"}],"responses":{"200":{"$ref":"#/components/responses/getAccountDetailsResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getStandingOrders":{"get":{"tags":["Standing Order API"],"summary":"Returns a list of standing orders for the given consumerId.","description":"Returns a list of standing orders for the given consumerId (see __GetStandingOrdersResponsePayload__).\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"getStandingOrders","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"responses":{"200":{"$ref":"#/components/responses/getStandingOrdersResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/createStandingOrder":{"post":{"tags":["Standing Order API"],"summary":"Create a standing order for the given account and consumerId.","description":"Create a standing order (recurring transfer) for the given account and consumerId. Returns a referenceId if the transfer was created successfully (see __CreateTransferResponsePayload__).\n\nThe transfer's source account must be owned by the customer with the given consumerId. Additionally a period for the recurring transaction must be specified (see __StandingOrderRequestPayload__).\n\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"createStandingOrder","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/standingOrderRequestBody"},"responses":{"200":{"$ref":"#/components/responses/createStandingOrderResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/updateStandingOrder":{"post":{"tags":["Standing Order API"],"summary":"Update an existing standing order by the given referenceId.","description":"Update a standing order with the given __referenceId__ (see __CreateTransferResponsePayload__).\n\nThe request body's __CryptoEnvelope__ carries the same payload as in a __/createStandingOrder__ request. The __referenceId__ parameter is used to identify and update the stored standing order. \n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"updateStandingOrder","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/referenceIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/standingOrderRequestBody"},"responses":{"200":{"$ref":"#/components/responses/updateStandingOrderResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/deleteStandingOrder":{"post":{"tags":["Standing Order API"],"summary":"Delete an existing standing order.","description":"Delete a standing order with the given __referenceID__ (see __referenceIdParam__).\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        }\n    }","operationId":"deleteStandingOrder","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/referenceIdParam"}],"responses":{"200":{"$ref":"#/components/responses/deleteStandingOrderResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/createCashout4Me":{"post":{"tags":["Prestaged Transaction API"],"summary":"Create a prestaged cashout (withdrawal) transaction.","description":"Create a prestaged cashout (withdrawal) transaction request. The server creates the transaction if the request can be validated and processed successfully. It is mapped to the consumerId and has a configurable lifetime  after which the transaction expires (via OCM). To execute the transaction at an ATM or with a contact-less  mobile application (see __/executePrestagedTransaction__) an accessCode is returned in the response.  Optionally this code can be sent by Email or SMS.\n\nThe request data payload is described by the __CreateCashout4MeRequestPayload__ schema.\n\nWhen the transaction was created successfully the server returns details about the transaction  (see __CreateCashout4MeResponsePayload__).\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"createCashout4Me","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/createCashout4MeRequestBody"},"responses":{"200":{"$ref":"#/components/responses/createCashout4MeResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/createCashout2You":{"post":{"tags":["Prestaged Transaction API"],"summary":"Create a prestaged cash out transaction request.","description":"Create a prestaged cashout (withdrawal) transaction request. The server creates the transaction if the request can be validated and processed successfully. It is mapped to the consumerId and has a configurable lifetime  after which the transaction expires (via OCM). To execute the transaction at an ATM or with a contact-less  mobile application (see __/executePrestagedTransaction__) an accessCode is created and sent to a  third party member. This step is __not__ optional for this request type.  The accessCode can be sent by Email or SMS.\n\nThe request data payload is described by the __CreateCashout2YouRequestPayload__ schema.\n\nWhen the transaction was created successfully the server returns details about the transaction  (see __CreateCashout2YouResponsePayload__).\n\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"createCashout2You","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/createCashout2YouRequestBody"},"responses":{"200":{"$ref":"#/components/responses/createCashout2YouResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/createDeposit":{"post":{"tags":["Prestaged Transaction API"],"summary":"Create a prestaged cashin/deposit transaction request.","description":"## Creating a prestaged cashin/deposit transaction request.\nThe __/createDeposit__ endpoint expects only one required property - besides the credentials - to form a valid request. The __targetAccount__ property is used to designate where the deposited money should be transferred. The optional __amount__ property is not required because the general assumption is that ahead of time, nobody knows which amount will be deposited. The currency for the deposited amount defaults to a configurable value on the server side, e.g. __USD__.\n\nIf the __targetAccount__ is a foreign currency account the optional __amount__ property should be used to designate the foreign currency, e.g. __EUR__. The __amount__ property's value cannot be __null__ but any other string encoded value like __\"20.00\"__ suffices to pass schema validation.\n\n    \"amount\": {\n        \"value\": \"20.00\",\n        \"currency\": \"EUR\"\n    }\n\nIn the server's response the amount will have the same value except for split deposits.\n## Split deposits\nThe pupose of split depoits is to transfer funds on different accounts owned by the client in one transaction. The intention to create a split deposit is indicated by the presence of the __splitData__ porperty in the request. The property is an array of __AccountWithAmount__ objects, each containg a __ShortAccountInfo__ and an __Amount__ object. They are not limited in numbers and may not contain negative amounts. When the transaction is executed the splits are handled first and in the order they were defined. See the following request body as example.\n### Example: default currency split request\n\n    {\n        \"targetAccount\": {\n            \"accountNumber\": \"78001\",\n            \"accountType\": \"CHECKING\",\n            \"bankCode\": \"12345678\"\n        },\n        \"splitData\": [\n            {\n                \"account\": {\n                    \"accountNumber\": \"780015\",\n                    \"accountType\": \"CHECKING\"\n                },\n                \"amount\": {\n                    \"value\": \"30.00\",\n                    \"currency\": \"USD\"\n                }\n            },\n                    {\n                \"account\": {\n                    \"accountNumber\": \"888805\",\n                    \"accountType\": \"CHECKING\"\n                },\n                \"amount\": {\n                    \"value\": \"20.00\",\n                    \"currency\": \"USD\"\n                }\n            }\n        ]\n    }\n\nFor the __targetAccount__ as in the previous example we don't need to specify an amount. The default currency will be used. This does not apply to the split amounts. The client must provide value and currency since he wants to split a specific amount from the otherwise unknown deposit amount. Furthermore the currency must match the __targetAccount__'s currency (or default currency).\nWhen a split deposit is indicated all split amounts will be summed up and added to the target account's amount. When no amount for the target account was specified the value will just represent the sum of all splits. The calculated sum is the total amount for that prestaged deposit and the value is assigned to the __targetAccount__'s __amount__ property. The value should be interpreted as the minimum amount that must be deposited to satisfy all transactions in the split deposit. See the following response body as example.\n### Example: default currency split response\n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null\n        },\n        \"prestagedTransactionInfo\": {\n            \"transactionId\": \"813984698b1542d18de24220b79ab011\",\n            \"amount\": {\n                \"value\": \"50.00\",\n                \"currency\": \"USD\"\n            },\n            \"isSplitDeposit\": false,\n            \"splitData\": [\n                {\n                    \"account\": {\n                        \"accountNumber\": \"780015\",\n                        \"accountType\": \"CHECKING\"\n                    },\n                    \"amount\": {\n                        \"value\": \"30.00\",\n                        \"currency\": \"USD\"\n                    }\n                },\n                {\n                    \"account\": {\n                        \"accountNumber\": \"888805\",\n                        \"accountType\": \"CHECKING\"\n                    },\n                    \"amount\": {\n                        \"value\": \"20.00\",\n                        \"currency\": \"USD\"\n                    }\n                }\n            ],\n            \"transactionType\": \"DEPOSIT\",\n            \"accessCode\": \"5169\",\n            \"dateCreated\": \"2020-09-15T14:59:30.857+02:00\",\n            \"dateValidFrom\": \"2020-09-15T14:59:30.857+02:00\",\n            \"dateValidTo\": \"2020-09-15T15:59:30.857+02:00\",\n            \"transactionState\": \"PENDING\"\n        }\n    }\n\nA split deposit can also be setup using foreign currencies but all amounts are required to use that foreign currency in the request.\n### Example: foreign currency split request\n\n    {\n        \"targetAccount\": {\n            \"accountNumber\": \"78001\",\n            \"accountType\": \"CHECKING\",\n            \"bankCode\": \"12345678\"\n        },\n        \"amount\": {\n            \"value\": \"70.00\",\n            \"currency\": \"EUR\"\n        },\n        \"splitData\": [\n            {\n                \"account\": {\n                    \"accountNumber\": \"780015\",\n                    \"accountType\": \"CHECKING\"\n                },\n                \"amount\": {\n                    \"value\": \"30.00\",\n                    \"currency\": \"EUR\"\n                }\n            },\n                    {\n                \"account\": {\n                    \"accountNumber\": \"888805\",\n                    \"accountType\": \"CHECKING\"\n                },\n                \"amount\": {\n                    \"value\": \"20.00\",\n                    \"currency\": \"EUR\"\n                }\n            }\n        ]\n    }\n\n### Example: foreign currency split response\n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null\n        },\n        \"prestagedTransactionInfo\": {\n            \"transactionId\": \"813984698b1542d18de24220b79ab011\",\n            \"amount\": {\n                \"value\": \"120.00\",\n                \"currency\": \"EUR\"\n            },\n            \"isSplitDeposit\": false,\n            \"splitData\": [\n                {\n                    \"account\": {\n                        \"accountNumber\": \"780015\",\n                        \"accountType\": \"CHECKING\"\n                    },\n                    \"amount\": {\n                        \"value\": \"30.00\",\n                        \"currency\": \"EUR\"\n                    }\n                },\n                {\n                    \"account\": {\n                        \"accountNumber\": \"888805\",\n                        \"accountType\": \"CHECKING\"\n                    },\n                    \"amount\": {\n                        \"value\": \"20.00\",\n                        \"currency\": \"EUR\"\n                    }\n                }\n            ],\n            \"transactionType\": \"DEPOSIT\",\n            \"accessCode\": \"5169\",\n            \"dateCreated\": \"2020-09-15T14:59:30.857+02:00\",\n            \"dateValidFrom\": \"2020-09-15T14:59:30.857+02:00\",\n            \"dateValidTo\": \"2020-09-15T15:59:30.857+02:00\",\n            \"transactionState\": \"PENDING\"\n        }\n    }\n\n## Executing the prestaged transaction\nWhen the prestaged transaction is executed and __splitData__ was not defined in the request, all deposited funds will be transferred to the __targetAccount__.\nWhen __splitData__ was defined in the request the split deposit transactions are handled first and in the order they were defined. From the __default currency split request__ example that would be\n1. __30__ __USD__ to account __780015__ 2. __20__ __USD__ to account __888805__ 3. Any additional funds to account __78001__\nIf the deposited funds are not sufficient to satisfy the split amounts they are skipped and step __3.__ is executed.\n\nWhen the transaction was created successfully the server returns details about the transaction  (see __CreateDepositResponsePayload__).\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"createDeposit","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/createDepositRequestBody"},"responses":{"200":{"$ref":"#/components/responses/createDepositResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/createBranchDeposit":{"post":{"tags":["Prestaged Transaction API"],"summary":"Create a prestaged deposit transaction request.","description":"Create a branch based prestaged deposit transaction request. The server creates the transaction if the request can be validated and processed successfully. It is mapped to the consumerId and has an __infinite__ lifetime. To execute the transaction at a Cash-Recycler ATM or with a contact-less  mobile application (see __/executePrestagedTransaction__) an accessCode is created and sent to a  third party member. This step is __not__ optional for this request type.  The accessCode can be sent by Email or SMS.\n\nWhen the transaction was created successfully the server returns details about the transaction  (see __CreateBranchDepositResponsePayload__).\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"createBranchDeposit","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/createBranchDepositRequestBody"},"responses":{"200":{"$ref":"#/components/responses/createBranchDepositResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/deletePrestagedTransaction":{"post":{"tags":["Prestaged Transaction API"],"summary":"Delete existing prestaged transactions.","description":"Delete a prestaged transaction with the given __referenceID__ (see __referenceIdParam__).  The transaction can be of any kind of the supported prestaged transactions.\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        }\n    }","operationId":"deletePrestagedTransaction","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/referenceIdParam"}],"responses":{"200":{"$ref":"#/components/responses/deletePrestagedTransactionResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getPrestagedTransactions":{"get":{"tags":["Prestaged Transaction API"],"summary":"Returns a list of all prestaged transactions for the given consumerId.","description":"Returns a list of all prestaged transactions for the given consumerId  (see __GetPrestagedTransactionsResponsePayload__).      \n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        },\n        \"cryptoEnvelope\": {\n            \"keyParams\": null,\n            \"payload\": \"1Dbp80MYqQ/z3+dzIVqxBhHXg6Awu/S1XVbK7OcbHZCw5ubyMrv4TjZLq5+U6bvtiRBWFeitgcWWb8Ng+TjOWQ==\"\n        }\n    }\n\n\n__Using RSA/AES:__\nThe server generates an AES key (256 bit) and iv (128 bit) to encrypt the response payload. After the payload encryption the key parameters are encrypted with the client's public RSA key (see __clientSecretparam__). The encrypted key parameters and payload are stored in a __CryptoEnvelope__ entity that is attached to the response body.\n\n__Using ECIES:__\nThe server uses the client's EC public key (see __clientSecretParam__) to encrypt the response payload. The encrypted payload is stored in a __CryptoEnvelope__ entity that is attached to the response body.","operationId":"getPrestagedTransactions","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/bankCodeParam"},{"$ref":"#/components/parameters/accountNumberParam"},{"$ref":"#/components/parameters/accountTypeParam"}],"responses":{"200":{"$ref":"#/components/responses/getPrestagedTransactionsResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/executePrestagedTransaction":{"post":{"tags":["Prestaged Transaction API"],"summary":"Execute a prestaged transaction at an ATM with an accessCode.","description":"Execute a prestaged transaction at an ATM with an accessCode. When the customer creates a prestaged transaction  or receives an accessCode from a third party member, the transaction (deposit/withdrawal)  tied to that accessCode can be executed contact-less at an ATM supporting the feature. The ATM presents a  QR-Code that must be scanned by the mobile application. It contains a JSON Web Token (JWT) with information  like the ATM's __nodeId__ and a __tokenUUID__ which both have to be provided in the request together with the  __accessCode__ (see __ExecutePrestagedTransactionRequestPayload__).\n\nWhen two-step-verification is enabled (via OCM) the first request is denied with a  RESUBMIT / TWO_STEP_ATM_VALIDATION_REQUIRED response. The ATM will flash lights or play a sound to indicate  that the transaction is going to be executed at the ATM next to the customer. The customer then verifies by  setting the __additionalSecurity__ property to true. Ideally the customer is guided through the process by his mobile banking application.\n### Example Response: \n\n    {\n        \"responseStatus\": {\n            \"success\": true,\n            \"error\": null                      \n        }\n    }","operationId":"executePrestagedTransaction","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/bankCodeParam"}],"requestBody":{"$ref":"#/components/requestBodies/executePrestagedTransactionRequestBody"},"responses":{"200":{"$ref":"#/components/responses/executePrestagedTransactionResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getLocations":{"post":{"tags":["Miscellaneous API"],"summary":"Get all ATM locations.","description":"Returns all locations of ATMs within a given radius.","operationId":"getLocations","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/getLocationsRequestBody"},"responses":{"200":{"$ref":"#/components/responses/getLocationsResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/createDispute":{"post":{"tags":["Account Management API"],"summary":"File a dispute","description":"File a dispute for the transaction with the given transactionId. An email with the textual content provided by the user is send to the bank authorities to handle the issue.","operationId":"createDispute","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/referenceIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/createDisputeRequestBody"},"responses":{"200":{"$ref":"#/components/responses/createDisputeResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getCreditors":{"get":{"tags":["Miscellaneous API"],"summary":"Get a list of system wide defined payees.","description":"Retrieves a list of payees. Just to make it clear once and for all, the workflow is as follows: First the mobile app calls 'getCreditors' to get a list of all system wide available creditors. This list is displayed to the customer, using the provided data (CreditorData), to enable the customer to choose the right one creditor. The customer selects the creditor from this list to whom he wishes to pay an invoice. The app uses the provided data from the response of the call \"getCreditors\" to show the customer (already) fields with which he can further limit the invoice to be paid if necessary. Thereafter the app calls 'getSinglePaymentOrderData' again with the 'creditorId' of the selected creditor and - if there was any input from the customer - a pre-filled object of SinglePaymentOrderRequestData. The server answers again with a SinglePaymentOrderResponseData object, which contains the PaymentOrderData, which was found in the servers database. The returned PaymentOrderData should uniquely identify a certain payment transaction of the customer. The mobile app presents the payment data to the customer and the customer fills in or corrects - any - missing transaction data/fields. Finally the app calls 'createTransfer' using the whole (entered or corrected) data for a transfer transaction.","operationId":"getCreditors","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/bankCodeParam"}],"responses":{"200":{"$ref":"#/components/responses/getCreditorsResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getSinglePaymentOrderData":{"get":{"tags":["Miscellaneous API"],"summary":"Get the details of a system wide defined creditor as returned in the getCreditorsResponse of a getCreditors call.","description":"Retrieve creditor details.","operationId":"getSinglePaymentOrderData","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/referenceIdParam"}],"responses":{"200":{"$ref":"#/components/responses/getSinglePaymentOrderDataResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getPreferences":{"get":{"tags":["Miscellaneous API"],"summary":"Get a list of user defined parameters.","description":"Retrieves a list of parameters.","operationId":"getPreferences","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/bankCodeParam"},{"$ref":"#/components/parameters/panParam"},{"$ref":"#/components/parameters/scopeParam"}],"responses":{"200":{"$ref":"#/components/responses/getPreferencesResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/setPreferences":{"post":{"tags":["Miscellaneous API"],"summary":"Set a list of user defined parameters, which can be used to store any information.","description":"Set a list of parameters.","operationId":"setPreferences","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/bankCodeParam"}],"requestBody":{"$ref":"#/components/requestBodies/setPreferencesRequestBody"},"responses":{"200":{"$ref":"#/components/responses/setPreferencesResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getClientBranding":{"get":{"tags":["Miscellaneous API"],"summary":"Get the client branding file.","description":"Retrieves the base64 encoded client branding data.","operationId":"getClientBranding","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"responses":{"200":{"$ref":"#/components/responses/getClientBrandingResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/updateAccountNickName":{"post":{"tags":["Account Management API"],"summary":"Update the account nickname.","description":"Update the account nickname.","operationId":"updateAccountNickName","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/bankCodeParam"}],"requestBody":{"$ref":"#/components/requestBodies/updateAccountNickNameRequestBody"},"responses":{"200":{"$ref":"#/components/responses/updateAccountNickNameResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/getGenericTransactionOrders":{"get":{"tags":["Miscellaneous API"],"summary":"Get a list of system defined generic transaction orders.","description":"Returns a list of generic transaction orders.","operationId":"getGenericTransactionOrders","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"responses":{"200":{"$ref":"#/components/responses/getGenericTransactionOrdersResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/executeGenericTransactionOrder":{"post":{"tags":["Miscellaneous API"],"summary":"Set a list of user defined parameters, which can be used to store any information.\n","description":"Set a list of parameters.","operationId":"executeGenericTransactionOrder","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/executeGenericTransactionOrderRequestBody"},"responses":{"200":{"$ref":"#/components/responses/executeGenericTransactionOrderResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/registerForRemoteNotifications":{"post":{"tags":["Miscellaneous API"],"summary":"Register a mobile device - either iOS or Android - for remote notifications.","description":"The /registerForRemoteNotifications API endpoint can be used to Register a mobile device - either iOS or  Android - for remote notifications using Apple Push Notifictions or Google Cloud Messages.\n","operationId":"registerForRemoteNotifications","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/manageRemoteNotificationsRequestBody"},"responses":{"200":{"$ref":"#/components/responses/manageRemoteNotificationsResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/unregisterForRemoteNotifications":{"post":{"tags":["Miscellaneous API"],"summary":"Register a mobile device - either iOS or Android - for remote notifications.","description":"The /registerForRemoteNotifications API endpoint can be used to Register a mobile device - either iOS or  Android - for remote notifications using Apple Push Notifictions or Google Cloud Messages.\n","operationId":"unregisterForRemoteNotifications","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/manageRemoteNotificationsRequestBody"},"responses":{"200":{"$ref":"#/components/responses/manageRemoteNotificationsResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/sepa-instant/pushPayment":{"get":{"tags":["SEPA Credit Transfer Instant API"],"summary":"Get the status of a SEPA Instant credit transfer","description":"Get the status of a SEPA instant credit transfer inititated by the payer\n","operationId":"getPushPayment","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"},{"$ref":"#/components/parameters/referenceIdParam"}],"responses":{"200":{"$ref":"#/components/responses/getPushPaymentResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}},"post":{"tags":["SEPA Credit Transfer Instant API"],"summary":"Create a SEPA instant payment request","description":"Create a push payment to transfer credits.\n","operationId":"createPushPayment","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/createPushPaymentRequestBody"},"responses":{"200":{"$ref":"#/components/responses/createPushPaymentResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}},"delete":{"tags":["SEPA Credit Transfer Instant API"],"summary":"Cancel a SEPA instant payment request","description":"Cancel a push payment.\n","operationId":"cancelPushPayment","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"responses":{"200":{"$ref":"#/components/responses/cancelPushPaymentResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}},"/sepa-instant/pullPayment":{"get":{"tags":["SEPA Credit Transfer Instant API"],"summary":"Get the status of a SEPA instant pull payment","description":"When a merchant (payee) issues a payment on the clients (payer) behalf a notification is sent to the client. By using a HTTP GET the client can review the status and details of the (pending) transaction.\n","operationId":"getPullPayment","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"responses":{"200":{"$ref":"#/components/responses/getPullPaymentResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}},"post":{"tags":["SEPA Credit Transfer Instant API"],"summary":"Authorize a pending SEPA instant payment request (pull payment)","description":"When a merchant (payee) issues a payment on the clients (payer) behalf a notification is sent to the client. By unsing a HTTP POST the client authorizes the pending transaction for further processing.\n","operationId":"authorizePullPayment","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/authorizePullPaymentRequestBody"},"responses":{"200":{"$ref":"#/components/responses/authorizePullPaymentResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}},"delete":{"tags":["SEPA Credit Transfer Instant API"],"summary":"Cancel a pending SEPA instant payment request (pull payment)","description":"When a merchant (payee) issues a payment on the clients (payer) behalf a notification is sent to the client. By unsing a HTTP DELETE the client cancels the pending transaction.\n","operationId":"cancelPullPayment","parameters":[{"$ref":"#/components/parameters/clientSecretParam"},{"$ref":"#/components/parameters/sessionTokenParam"},{"$ref":"#/components/parameters/consumerIdParam"}],"responses":{"200":{"$ref":"#/components/responses/cancelPullPaymentResponse"},"400":{"$ref":"#/components/responses/badRequestResponse"},"401":{"$ref":"#/components/responses/unauthorizedResponse"},"404":{"$ref":"#/components/responses/notFoundResponse"},"default":{"$ref":"#/components/responses/defaultResponse"}}}}},"components":{"securitySchemes":{"bearerAuth":{"description":"When using the bearer authentication method an access token has to be provided in the HTTP authorization header. When using openIdConnect as security scheme the access token has to be provided in the Authorization header with the bearer scheme while the id token has to be provided in the __consumerIdParam__ which must also be encrypted.","type":"http","scheme":"bearer"}},"parameters":{"sessionTokenParam":{"name":"Dn-Tm-Omapi-Session-Token","in":"header","description":"A unique identifier of a consumer session (within an external system), which is required to validate the consumer session. The default implementation expects in the sessionToken parameter a valid openId Connect id_token. Moreover, the default implementation expects in the authorization header of the http request the authorization schema \"Bearer\" followed by a valid openId Connect access token. This parameter should be encrypted and encoded in base64.","required":true,"schema":{"type":"string","minLength":1}},"consumerIdParam":{"name":"Dn-Tm-Omapi-Consumer-Id","in":"header","description":"A unique identifier of a consumer (within an external system), which is required to identify the consumer. Maybe the consumerId is moreover/also used to authorize the consumer against an external system. This parameter should be encrypted and encoded in base64.","required":true,"schema":{"type":"string","minLength":1}},"referenceIdParam":{"name":"Dn-Tm-Omapi-Reference-Id","in":"header","description":"A unique identifier referring to a transaction in TM. This parameter should be encrypted and encoded in base64.","required":true,"schema":{"type":"string","minLength":1}},"panParam":{"name":"Dn-Tm-Omapi-Pan","in":"header","description":"The PAN of the card to get the preferences for. This parameter should be encrypted and encoded in base64.","required":true,"schema":{"type":"string","pattern":"^\\d+$","format":"PAN","minLength":13,"maxLength":19,"example":"4761739028380180"}},"scopeParam":{"name":"Dn-Tm-Omapi-Scope","in":"header","required":true,"description":"The 'scope' of the preferences. If the scope is not given, all preferences are returned without taking any certain scope into account.","schema":{"type":"string","minLength":1,"maxLength":255}},"accountNumberParam":{"name":"Dn-Tm-Omapi-Account-Number","in":"header","required":true,"description":"The account number. The length varies greatly. In Europe defined by ISO 13616/2007 See also: https://en.wikipedia.org/wiki/International_Bank_Account_Number This parameter should be encrypted and encoded in base64.\n","schema":{"type":"string","minLength":2,"maxLength":32,"example":"DE19123412341234123412"}},"bankCodeParam":{"name":"Dn-Tm-Omapi-Bankcode","in":"header","required":false,"description":"Contains the BIC (aka. bank identifier code)\n  The BIC - also known as SWIFT-code - as defined by ISO 9362 is required in/for cross border transfers/transactions.\n  Please see: https://en.wikipedia.org/wiki/ISO_9362\n  This field can also be used to send/receive an ABA RTN (ABA routing transit number) or Canadian TN(Canadian transit number).\n  See also: https://en.wikipedia.org/wiki/Routing_transit_number\n  This parameter should be encrypted and encoded in base64.\n","schema":{"type":"string","pattern":"^[A-Za-z0-9]*$","minLength":8,"maxLength":11}},"accountTypeParam":{"name":"Dn-Tm-Omapi-Account-Type","in":"header","required":true,"description":"The default account type is 820000 (NOT_SPECIFIED). Please see: /getAccountTypes for all possible values. This parameter should be encrypted and encoded in base64.\n","schema":{"type":"string","minLength":1,"maxLength":64}},"clientSecretParam":{"name":"Dn-Tm-Omapi-Client-Secret","in":"header","required":true,"description":"Depending on the crypto scheme (RSA/AES or ECIES) the client intends to use the corresponding properties of the __CryptoParams__ schema defined by OM-API should be filled accordingly and sent back to the server as stringified JSON. For example:\n\n__Using RSA/AES:__\n\n        cryptoParams: {\n            aesKeyParams: {\n                key: \"uMSlxHYT+ttxz0T+nL+A344iP6ujJdodCn6k5MmjWDC0T+MFCXcs1OjXK1DaYFaP3v1mqN9+uh58FE0VxcwFGaRSp6uDfbl9Oaji7v0vDS9mMFa4hzMoiiYBmRKUemTNkJOcgCpDi7kDNHPB+gpqYyc4dMFfPvSCG/SYv7CFXTA=\",\n                iv: \"FgZ/HdtOhroVzRd802X3NgHCuiqBjCM+6Q/6PS0lUrROBe8T+me444KpKt112gLwHck7nmOVkZJPznWf7bpX6dh+mcIQ/3B7PJ3xGEsHbmSXEAK10C+AKwXpI9Sdig8feP2QT+Hd0d1qGk0X93OFaJ/zfqs/MNIesNTVAY2YBIw=\"\n            },\n            rsaPublicKey:\"-----BEGIN PUBLIC KEY-----\\nMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCeB05D31/zFICpf9JJWDo1ZVXt\\npYwvJa6ka0g0EHN95C8fvMguNDmprslmsOqaJYplmknWpWjbHAtIPpqrtY3H6eWP\\nELkBN2hitJlQQjf1y2jsWHsSH7BsVY5z1hCzJySFE7Q1ae9WuYj3RTsq+4ZZpEk7\\nCjRdjA26emVkCR3vWwIDAQAB\\n-----END PUBLIC KEY-----\"\n            }\n\nThe property __rsaPublicKey__ is used to send the client's public key to the server in order to create encrypted responses. It is recommended to use __rsaPublicKey__ key size of  - at least - 1024 bit.\nThe property __aesKeyParams__ is used to send the client's AES key (256bit) and iv (128bit) to the server. Both values __must__ be encrypted with the servers public RSA key (see __/getRsaKey__).\n\n__Using ECIES:__\n\n        cryptoParams: {\n            \"ecPublicKey\":{\n                \"publicKeyPem\":\"-----BEGIN PUBLIC KEY-----\\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEHPMaBu6d0BR6QFw3VKwPipuAdDPL\\nG36/aoyTx7iTK1xgoi7X9aMmT1x3Qh1+S1zVhBh2LDDEljHkkVyHrl4bOg==\\n-----END PUBLIC KEY-----\\n\"\n                }\n            }\n\nThe property __ecPublicKey__ is used to send the client's public key to the server in order to create encrypted responses.","schema":{"type":"string","minLength":1}}},"requestBodies":{"createTransferRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransferRequest"}}},"description":"The request body used for /createTransfer requests","required":true},"createDisputeRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDisputeRequest"}}},"description":"The request body used for /createDispute requests","required":true},"standingOrderRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandingOrderRequest"}}},"description":"The request body used for /createStandingOrder and /updateStandingOrder requests","required":true},"updateAccountNickNameRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountNickNameRequest"}}},"description":"The request body used for /updateAccountNickName requests","required":true},"executeGenericTransactionOrderRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteGenericTransactionOrderRequest"}}},"description":"The request body used for /executeGenericTransactionOrder requests","required":true},"setPreferencesRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPreferencesRequest"}}},"description":"The request body used for /setPreferences requests","required":true},"getSinglePaymentOrderDataRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SinglePaymentOrderRequest"}}},"description":"The request body used for /getSinglePaymentOrderData requests","required":true},"getLocationsRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLocationsRequest"}}},"description":"The request body used for /getLocations requests","required":true},"createBranchDepositRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBranchDepositRequest"}}},"description":"The request body used for /createBranchDeposit requests","required":true},"createDepositRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDepositRequest"}}},"description":"The request body used for /createDeposit requests","required":true},"createCashout2YouRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCashout2YouRequest"}}},"description":"The request body used for /createCashout2You requests","required":true},"createCashout4MeRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCashout4MeRequest"}}},"description":"The request body used for /createCashout4Me requests","required":true},"executePrestagedTransactionRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePrestagedTransactionRequest"}}},"description":"The request body used for /executePrestagedTransaction requests","required":true},"manageRemoteNotificationsRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManageRemoteNotificationsRequest"}}},"description":"The request body used for /executeProcess requests\n","required":true},"createPushPaymentRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePushPaymentRequest"}}},"description":"The request body used for CreatePushPaymentRequest","required":true},"authorizePullPaymentRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizePullPaymentRequest"}}},"description":"The request body used for AuthorizePullPaymentRequest","required":true}},"responses":{"getRsaKeyResponse":{"description":"Returns the API's public RSA key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRsaKeyResponse"}}}},"getEcKeyResponse":{"description":"Returns the API's public EC key as PEM.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEcKeyResponse"}}}},"getVersionResponse":{"description":"Returns the API's version information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVersionResponse"}}}},"checkAccountResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAccountResponse"}}}},"createBranchDepositResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBranchDepositResponse"}}}},"createCashout2YouResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCashout2YouResponse"}}}},"createCashout4MeResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCashout4MeResponse"}}}},"createDepositResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDepositResponse"}}}},"createDisputeResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDisputeResponse"}}}},"createStandingOrderResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransferResponse"}}}},"createTransferResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransferResponse"}}}},"deletePrestagedTransactionResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePrestagedTransactionResponse"}}}},"deleteStandingOrderResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteStandingOrderResponse"}}}},"executePrestagedTransactionResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePrestagedTransactionResponse"}}}},"getAccountDetailsResponse":{"description":"Returns numerous details regarding the given account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountDetailsResponse"}}}},"getAccountsResponse":{"description":"Returns a list of accounts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountsResponse"}}}},"getAccountTypesResponse":{"description":"Returns a fixed list of available account types.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountTypesResponse"}}}},"getCreditorsResponse":{"description":"Returns the list of pending prestaged transactions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCreditorsResponse"}}}},"getClientBrandingResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetClientBrandingResponse"}}}},"getGenericTransactionOrdersResponse":{"description":"Returns the list of generic transaction orders.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGenericTransactionOrdersResponse"}}}},"getLocationsResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLocationsResponse"}}}},"getPreferencesResponse":{"description":"Returns the preferences key-value map.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPreferencesResponse"}}}},"getPrestagedTransactionsResponse":{"description":"Returns a list of prestaged transactions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPrestagedTransactionsResponse"}}}},"getScheduledTransactionsResponse":{"description":"Returns an array of transactions for the given account, which are scheduled to be executed in the future.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetScheduledTransactionsResponse"}}}},"getSinglePaymentOrderDataResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSinglePaymentOrderDataResponse"}}}},"getStandingOrdersResponse":{"description":"Returns a list of standing orders.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStandingOrdersResponse"}}}},"getTransactionsResponse":{"description":"Returns an array of transactions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTransactionsResponse"}}}},"executeGenericTransactionOrderResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteGenericTransactionOrderResponse"}}}},"setPreferencesResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPreferencesResponse"}}}},"updateAccountNickNameResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountNickNameResponse"}}}},"updateStandingOrderResponse":{"description":"No further data are returned in case of a successful call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransferResponse"}}}},"manageRemoteNotificationsResponse":{"description":"Returns the response status when subscribing/unsubscribing for remote notifications.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManageRemoteNotificationsResponse"}}}},"getPushPaymentResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPushPaymentResponse"}}}},"createPushPaymentResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePushPaymentResponse"}}}},"cancelPushPaymentResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelPushPaymentResponse"}}}},"getPullPaymentResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPullPaymentResponse"}}}},"authorizePullPaymentResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizePullPaymentResponse"}}}},"cancelPullPaymentResponse":{"description":"Returns the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelPullPaymentResponse"}}}},"authErrorResponse":{"description":"The authentication failed. A redirect URL is returned where the client can get a new valid open ID Connect id_token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"unauthorizedResponse":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"badRequestResponse":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"notFoundResponse":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"defaultResponse":{"description":"Unexpected error. Please see/inspect 'code' and 'message' properties of the error for more/detailed informations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","description":"The error property is optional. It is set only if an error has been detected. <p> Each request has its number range used for error codes (see ResponseBase schema). This is the list of the actual error codes for each request: <br>\n  | Request Name  | Error | Error Code  |\n  |---------------|-------|-------------|\n  | *Account Management API*\n  | &nbsp; | | |\n  | getAccounts | SERVER_FAILURE | 2870000 |\n  |               | SYSTEM_ERROR | 2870001 |\n  |               | REQUEST_DATA_INVALID | 2870002 |\n  |               | NO_RESULT | 2870003 |\n  |               | HOST_OFFLINE | 2870004 |\n  |               | HOST_COMMUNICATION_ERROR | 2870005 |\n  |               | VERIFICATION_FAILED | 2870015 |\n  | &nbsp; | | |\n  | getAccountTypes | SERVER_FAILURE | 2870100 |\n  |               | VERIFICATION_FAILED | 2870115 |\n  | &nbsp; | | |\n  | getAccountDetails | SERVER_FAILURE | 2870200 |\n  |               | SYSTEM_ERROR | 2870201 |\n  |               | REQUEST_DATA_INVALID | 2870202 |\n  |               | NO_RESULT | 2870203 |\n  |               | HOST_OFFLINE | 2870204 |\n  |               | HOST_COMMUNICATION_ERROR | 2870205 |\n  |               | VERIFICATION_FAILED | 2870215 |\n  | &nbsp; | | |\n  | getTransactions | SERVER_FAILURE | 2870300 |\n  |               | SYSTEM_ERROR | 2870301 |\n  |               | REQUEST_DATA_INVALID | 2870302 |\n  |               | NO_RESULT | 2870303 |\n  |               | HOST_OFFLINE | 2870304 |\n  |               | HOST_COMMUNICATION_ERROR | 2870305 |\n  |               | VERIFICATION_FAILED | 2870315 |\n  | &nbsp; | | |\n  | getScheduledTransactions | SERVER_FAILURE | 2870400 |\n  |               | SYSTEM_ERROR | 2870401 |\n  |               | REQUEST_DATA_INVALID | 2870402 |\n  |               | NO_RESULT | 2870403 |\n  |               | HOST_OFFLINE | 2870404 |\n  |               | HOST_COMMUNICATION_ERROR | 2870405 |\n  |               | VERIFICATION_FAILED | 2870415 |\n  | &nbsp; | | |\n  | checkAccount | SERVER_FAILURE | 2870500 |\n  |               | SYSTEM_ERROR | 2870501 |\n  |               | REQUEST_DATA_INVALID | 2870502 |\n  |               | NO_RESULT | 2870503 |\n  |               | HOST_OFFLINE | 2870504 |\n  |               | HOST_COMMUNICATION_ERROR | 2870505 |\n  |               | VERIFICATION_FAILED | 2870515 |\n  | &nbsp; | | |\n  | createTransfer | SERVER_FAILURE | 2870600 |\n  |               | SYSTEM_ERROR | 2870601 |\n  |               | REQUEST_DATA_INVALID | 2870602 |\n  |               | NO_RESULT | 2870603 |\n  |               | HOST_OFFLINE | 2870604 |\n  |               | HOST_COMMUNICATION_ERROR | 2870605 |\n  |               | LIMIT_EXCEEDED | 2870606 |\n  |               | INSUFFICIENT_FUNDS | 2870607 |\n  |               | ACCOUNT_TYPE_INVALID | 2870608 |\n  |               | VERIFICATION_FAILED | 2870615 |\n  | &nbsp; | | |\n  | createDispute | SERVER_FAILURE | 2870700 |\n  |               | SYSTEM_ERROR | 2870701 |\n  |               | MESSAGE_NOT_SENT | 2870700 |\n  |               | REQUEST_DATA_INVALID | 2870703 |\n  |               | VERIFICATION_FAILED | 2870715 |\n  | &nbsp; | | |\n  | *Standing Order API*\n  | &nbsp; | | |\n  | getStandingOrders | SERVER_FAILURE | 2871000 |\n  |               | REQUEST_DATA_INVALID | 2871002 |\n  |               | CONSUMER_NOT_FOUND | 2871012 |\n  |               | VERIFICATION_FAILED | 2871015 |\n  | &nbsp; | | |\n  | createStandingOrder | SERVER_FAILURE | 2871100 |\n  |               | REQUEST_DATA_INVALID | 2871102 |\n  |               | VERIFICATION_FAILED | 2871115 |\n  | &nbsp; | | |\n  | updateStandingOrder | SERVER_FAILURE | 2871200 |\n  |               | SYSTEM_ERROR | 2871201 |\n  |               | REQUEST_DATA_INVALID | 2871202 |\n  |               | STANDINGORDER_NOT_FOUND | 2871209 |\n  |               | VERIFICATION_FAILED | 2871215 |\n  | &nbsp; | | |\n  | deleteStandingOrder | SERVER_FAILURE | 2871300 |\n  |               | REQUEST_DATA_INVALID | 2871302 |\n  |               | STANDINGORDER_NOT_FOUND | 2871309 |\n  |               | VERIFICATION_FAILED | 2871315 |\n  | &nbsp; | | |\n  | updateAccountNickname | SERVER_FAILURE | 2871400 |\n  |               | SYSTEM_ERROR | 2871401 |\n  |               | REQUEST_DATA_INVALID | 2871402 |\n  |               | NO_RESULT | 2871403 |\n  |               | HOST_OFFLINE | 2871404 |\n  |               | HOST_COMMUNICATION_ERROR | 2871405 |\n  |               | SERVICE_NOT_SUPPORTED | 2871413 |\n  |               | EXT_RESPONSE_NO_MATCHING_RECORD_FOUND | 2871414 |\n  |               | VERIFICATION_FAILED | 2871415 |\n  | &nbsp; | | |\n  | *Prestaged Transaction API*\n  | &nbsp; | | |\n  | createCashout4Me | SERVER_FAILURE | 2872000 |\n  |               | SYSTEM_ERROR | 2872001 |\n  |               | REQUEST_DATA_INVALID | 2872002 |\n  |               | NO_RESULT | 2872003 |\n  |               | HOST_OFFLINE | 2872004 |\n  |               | HOST_COMMUNICATION_ERROR | 2872005 |\n  |               | VERIFICATION_FAILED | 2872015 |\n  | &nbsp; | | |\n  | createCashout2You | SERVER_FAILURE | 2872100 |\n  |               | SYSTEM_ERROR | 2872101 |\n  |               | REQUEST_DATA_INVALID | 2872102 |\n  |               | NO_RESULT | 2872103 |\n  |               | HOST_OFFLINE | 2872104 |\n  |               | HOST_COMMUNICATION_ERROR | 2872105 |\n  |               | VERIFICATION_FAILED | 2872115 |\n  | &nbsp; | | |\n  | createDeposit | SERVER_FAILURE | 2872200 |\n  |               | SYSTEM_ERROR | 2872201 |\n  |               | REQUEST_DATA_INVALID | 2872202 |\n  |               | NO_RESULT | 2872203 |\n  |               | HOST_OFFLINE | 2872204 |\n  |               | HOST_COMMUNICATION_ERROR | 2872205 |\n  |               | VERIFICATION_FAILED | 2872215 |\n  | &nbsp; | | |\n  | createBranchDeposit | SERVER_FAILURE | 2872300 |\n  |               | SYSTEM_ERROR | 2872301 |\n  |               | REQUEST_DATA_INVALID | 2872302 |\n  |               | NO_RESULT | 2872303 |\n  |               | HOST_OFFLINE | 2872304 |\n  |               | HOST_COMMUNICATION_ERROR | 2872305 |\n  |               | VERIFICATION_FAILED | 2872315 |\n  | &nbsp; | | |\n  | deletePrestagedTransaction | SERVER_FAILURE | 2872400 |\n  |               | RESERVED | 2872400 |\n  |               | REQUEST_DATA_INVALID | 2872402 |\n  |               | VERIFICATION_FAILED | 2872415 |\n  | &nbsp; | | |\n  | getPrestagedTransactions | SERVER_FAILURE | 2872500 |\n  |               | SYSTEM_ERROR | 2872501 |\n  |               | REQUEST_DATA_INVALID | 2872502 |\n  |               | NO_RESULT | 2872503 |\n  |               | HOST_OFFLINE | 2872504 |\n  |               | HOST_COMMUNICATION_ERROR | 2872505 |\n  |               | VERIFICATION_FAILED | 2872515 |\n  | &nbsp; | | |\n  | executePrestagedTransaction | SERVER_FAILURE | 2872600 |\n  |               | SYSTEM_ERROR | 2872601 |\n  |               | REQUEST_DATA_INVALID | 2872602 |\n  |               | VERIFICATION_FAILED | 2872615 |\n  | &nbsp; | | |\n  | *Miscellaneous API*\n  | &nbsp; | | |\n  | getCreditors | SERVER_FAILURE | 2874000 |\n  |               | SYSTEM_ERROR | 2874001 |\n  |               | REQUEST_DATA_INVALID | 2874002 |\n  |               | VERIFICATION_FAILED | 2874015 |\n  | &nbsp; | | |\n  | getSinglePaymentOrderData | SERVER_FAILURE | 2874100 |\n  |               | RESERVED | 2874100 |\n  |               | REQUEST_DATA_INVALID | 2874102 |\n  |               | CONSUMER_NOT_FOUND | 2874112 |\n  |               | VERIFICATION_FAILED | 2874115 |\n  | &nbsp; | | |\n  | getPreferences | SERVER_FAILURE | 2874200 |\n  |               | RESERVED | 2874200 |\n  |               | REQUEST_DATA_INVALID | 2874202 |\n  |               | RESPONSE_NO_CONSUMER_ID_AVAILABLE | 2874210 |\n  |               | RESPONSE_NO_PREFERENCES_AVAILABLE | 2874211 |\n  |               | VERIFICATION_FAILED | 2874215 |\n  | &nbsp; | | |\n  | setPreferences | SERVER_FAILURE | 2874300 |\n  |               | RESERVED | 2874300 |\n  |               | REQUEST_DATA_INVALID | 2874302 |\n  |               | VERIFICATION_FAILED | 2874315 |\n  | &nbsp; | | |\n  | getClientBranding | SERVER_FAILURE | 2874400 |\n  |               | RESERVED | 2874400 |\n  |               | REQUEST_DATA_INVALID | 2874402 |\n  |               | VERIFICATION_FAILED | 2874415 |\n  | &nbsp; | | |\n  | getGenericTransactionOrders | SERVER_FAILURE | 2874500 |\n  |               | RESERVED | 2874500 |\n  |               | REQUEST_DATA_INVALID | 2874502 |\n  |               | VERIFICATION_FAILED | 2874515 |\n  | &nbsp; | | |\n  | executeGenericTransactionOrder | SERVER_FAILURE | 2874600 |\n  |               | RESERVED | 2874600 |\n  |               | REQUEST_DATA_INVALID | 2874602 |\n  |               | VERIFICATION_FAILED | 2874615 |\n  | &nbsp; | | |\n  | getLocations | SERVER_FAILURE | 2873000 |\n  |               | SYSTEM_ERROR | 2873001 |\n  |               | REQUEST_DATA_INVALID | 2873002 |\n  |               | NO_RESULT | 2873003 |\n  |               | VERIFICATION_FAILED | 2873015 |\n  | &nbsp; | | |\n  | *Accessibility API*\n  | &nbsp; | | |\n  | getRsaKey | SERVER_FAILURE | 2875000 |\n  |               | VERIFICATION_FAILED | 2875015 |\n  | &nbsp; | | |\n  | getEcKey | SERVER_FAILURE | 2875100 |\n  |               | VERIFICATION_FAILED | 2875115 |\n  | &nbsp; | | |\n  | getVersion | SERVER_FAILURE | 2875200 |\n  |               | VERIFICATION_FAILED | 2875215 |","required":["code"],"properties":{"code":{"description":"An error code as outlined in the PC/E documentation.","type":"integer","format":"int32","minimum":0,"example":850004},"message":{"description":"An optional, additional message which describes the error.","type":"string","maxLength":255,"example":"Internal server error. A database connection could not be established."}}},"ResponseBase":{"description":"Every number used by OM-API is within a certain number range.<br> The OM-API V4 number range is 2870000 - 2879999.<br> Within that range, every requests group has its number range of 1000: <br>\n  | Request Group | Number Range                       |\n  |---------------|------------------------------------|\n  | Account Management API          | 2870000-2870999  |\n  | Standing Order API              | 2871000-2871999  |\n  | Prestaged Transaction API       | 2872000-2872999  |\n  | Miscellaneous API               | 2873000-2873999  |\n  | Accessibility API               | 2874000-2874999  |\nWithin each group range, every belonging request has its number range of 100:\n  <br>\n  | Request Name  | Number Range                       |\n  |---------------|------------------------------------|\n  | *Account Management API*\n  | getAccounts                     | 2870000-2870099  |\n  | getAccountTypes                 | 2870100-2870199  |\n  | getAccountDetails               | 2870200-2870299  |\n  | getTransactions                 | 2870300-2870399  |\n  | getScheduledTransactions        | 2870400-2870499  |\n  | checkAccount                    | 2870500-2870599  |\n  | createTransfer                  | 2870600-2870699  |\n  | createDispute                   | 2870700-2870799  |\n  | &nbsp;\n  | *Standing Order API*\n  | getStandingOrders               | 2871000-2871099  |\n  | createStandingOrder             | 2871100-2871199  |\n  | updateStandingOrder             | 2871200-2871299  |\n  | deleteStandingOrder             | 2871300-2871399  |\n  | updateAccountNickname           | 2871400-2871499  |\n  | &nbsp;\n  | *Prestaged Transaction API*\n  | createCashout4Me                | 2872000-2872099  |\n  | createCashout2You               | 2872100-2872199  |\n  | createDeposit                   | 2872200-2872299  |\n  | createBranchDeposit             | 2872300-2872399  |\n  | deletePrestagedTransaction      | 2872400-2872499  |\n  | getPrestagedTransactions        | 2872500-2872599  |\n  | executePrestagedTransaction     | 2872600-2872699  |\n  | &nbsp;\n  | *Miscellaneous API*\n  | getCreditors                    | 2874000-2874099  |\n  | getSinglePaymentOrderData       | 2874100-2874199  |\n  | getPreferences                  | 2874200-2874299  |\n  | setPreferences                  | 2874300-2874399  |\n  | getClientBranding               | 2874400-2874499  |\n  | getGenericTransactionOrders     | 2874500-2874599  |\n  | performGenericTransactionOrder  | 2874600-2874699  |\n  | getLocations                    | 2874700-2874799  |\n  | &nbsp;\n  | *Accessibility API*\n  | getRsaKey                       | 2875000-2875099  |\n  | getEcKey                        | 2875100-2875199  |\n  | getVersion                      | 2875200-2875299  |\n  <br>\n  The numbers in the ranges are used primarily for the error codes (see Error schema).","type":"object","required":["success"],"properties":{"success":{"description":"Returns True or False to indicate the success of the API call.\nThe The error property is optional.\nIt is set only if an error has been detected.\n","type":"boolean","example":true},"error":{"$ref":"#/components/schemas/Error"}}},"Credentials":{"description":"Schema to easily generate a Credentials object for server side validation of the user credentials. The Credentials object contains the sessionToken and the consumerId.","type":"object","required":["sessionToken","consumerId"],"properties":{"sessionToken":{"type":"string","description":"A unique identifier of a consumer (within an external system) which is required to authorize access to the system.","example":"46CAADAB87D847B08B0A4F46973EA2E8"},"consumerId":{"type":"string","minLength":1,"description":"A unique identifier of a consumer (within an external system) which is required to identify the consumer and authorize access to the system.","example":"46CAADAB87D847B08B0A4F46973EA2E8"}}},"KeyValuePair":{"description":"A key value pair to store/retrieve a key and a value as strings in a generic way. Used in some API calls/objects.","type":"object","required":["key","value"],"properties":{"key":{"description":"A unique key which identifies a certain value.","type":"string","minimum":1,"maximum":255,"example":"this-is-a-sample-key"},"value":{"description":"The assigned value of the key. It contains a maximum of 1MB data.","type":"string","minLength":0,"maxLength":1048576,"example":"this-is-a-sample-value"}}},"OmApiSupplementaryData":{"type":"object","description":"/ Represents supplementary data as a collection of TM facets.<br> It is assumed, that the TM facets can be obtained from the request data in the following way...<br> <b>FacetContainer container = FacetContainerMapperUtil.fromJsonMap(facets);</b>","properties":{"facets":{"type":"object"}},"additionalProperties":false},"OmapiDate":{"type":"string","pattern":"([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))","description":"The date pattern is defined \"YYYY-MM-DD\", with YYYY as 4-digit year, MM as 2-digit month and DD as 2-digit day of month.\nDate string as defined by date-time - RFC3339\nPlease see: https://tools.ietf.org/html/rfc3339\n","example":"2020-01-31"},"MsisdnString":{"type":"string","format":"^\\+(?:[0-9]\\x20?){6,14}[0-9]$","description":"The numbers must start with a plus sign, followed by the country code and national number regarding ITU-T E.123 and ITU-T E.164 Phone numbers cannot contain more than 15 digits. The shortest international phone numbers in use contain seven digits."},"MSISDN":{"type":"object","required":["MSISDN"],"properties":{"MSISDN":{"$ref":"#/components/schemas/MsisdnString"}}},"MailAddressString":{"type":"string","format":"^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$","description":"A valid eMail addressas defined by RFC5322."},"MailAddress":{"type":"object","required":["MailAddress"],"properties":{"MailAddress":{"$ref":"#/components/schemas/MailAddressString"}}},"NotificationReceiver":{"type":"object","required":["destinationOfNotification"],"properties":{"name":{"type":"string","minLength":1,"example":"Mary-Jane"},"surname":{"type":"string","minLength":1,"example":"Blunt"},"title":{"type":"string","minLength":1,"example":"Mrs."},"destinationOfNotification":{"$ref":"#/components/schemas/SendToSpec"}}},"SendToSpec":{"oneOf":[{"$ref":"#/components/schemas/MSISDN"},{"$ref":"#/components/schemas/MailAddress"}]},"RsaPublicKey":{"allOf":[{"$ref":"#/components/schemas/PublicKeyPem"}]},"EcPublicKey":{"allOf":[{"$ref":"#/components/schemas/PublicKeyPem"}]},"PublicKeyPem":{"description":"A holder object for PEM formatted public keys","type":"object","required":["publicKeyPem"],"properties":{"publicKeyPem":{"type":"string","minLength":1,"example":"\"-----BEGIN PUBLIC KEY-----\\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEt0 GMNz1Geam/Jw4lbIoPcspDbWt2\\n84U+yYZqnqMIa5gQZyJNsTRdvDfb2jdP3MUVBJM UoOeuGTF/cJy4uQ587w==\\n-----END PUBLIC KEY-----\\n\""}}},"AesKeyParams":{"description":"A holder object for AES symmetric key params.","required":["key","iv"],"properties":{"key":{"description":"The Base64 encoded (and encrypted) AES key (256bit).","type":"string","example":"MTI4MzI1Mjc2NTI="},"iv":{"description":"The Base64 encoded (and encrypted) AES iv (128bit).","type":"string","example":"MTI4MzI1Mjc2NTI="}}},"AesKeyByteParams":{"description":"A holder object for AES symmetric key params. For encryption of the AES key params the public RSA key of the server must be used for requests. In the response the server will use the clients public RSA key.","required":["key","iv"],"properties":{"key":{"description":"The Base64 encoded (and encrypted) AES key.","type":"string","format":"byte","example":"MTI4MzI1Mjc2NTI="},"iv":{"description":"The Base64 encoded (and encrypted) AES iv.","type":"string","format":"byte","example":"MTI4MzI1Mjc2NTI="}}},"CryptoParams":{"type":"object","properties":{"rsaPublicKey":{"$ref":"#/components/schemas/RsaPublicKey"},"ecPublicKey":{"$ref":"#/components/schemas/EcPublicKey"},"aesKeyParams":{"$ref":"#/components/schemas/AesKeyParams"}}},"CryptoEnvelope":{"type":"object","required":["payload"],"description":"Object holding a cryptographically secured request properties.","properties":{"keyParams":{"$ref":"#/components/schemas/AesKeyParams"},"payload":{"type":"string","minLength":1,"example":"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+"}}},"AccountNumber":{"description":"The account number. The length varies greatly. In Europe defined by ISO 13616/2007\nSee also:\nhttps://en.wikipedia.org/wiki/International_Bank_Account_Number\n","type":"string","minLength":2,"maxLength":32,"example":"DE19123412341234123412"},"AccountWarning":{"description":"Warnings regarding the bank account of a user.","type":"object","properties":{"effectiveDate":{"description":"Date since the warning is active.","type":"string","maxLength":255,"example":"Thu Nov 28 10:40:41 CET 2019"},"expirationDate":{"description":"Date where the warning will expire.","type":"string","maxLength":255,"example":"Thu Nov 28 10:40:41 CET 2019"},"warningCode":{"description":"A warning code.","type":"string","maxLength":255,"example":"A3056-XT"},"warningText":{"description":"Warning description text.","type":"string","maxLength":255,"example":"Too much money in the bank"},"category":{"description":"The warning category","type":"string","maxLength":255,"example":"SEVERE_WARNINGS"}}},"SwiftCode":{"description":"Contains the BIC (aka. bank identifier code)\nThe BIC - also known as SWIFT-code - as defined by ISO 9362 is required in/for cross border transfers/transactions.\nPlease see: https://en.wikipedia.org/wiki/ISO_9362\n\nThis field can also be used to send/receive an ABA RTN (ABA routing transit number) or Canadian TN (Canadian transit number).\nSee also: https://en.wikipedia.org/wiki/Routing_transit_number\nThe bank code is NOT required!\n","type":"string","pattern":"^[A-Z0-9]+$","minLength":8,"maxLength":11},"AdditionalCreditorFieldDescription":{"description":"A key value pair to store/retrieve a key and a value as strings in a generic way. Used in some API calls/objects.","type":"object","required":["fieldName","minFieldLength","maxFieldLength"],"properties":{"fieldName":{"description":"A unique key which identifies a certain value.","type":"string","minimum":1,"maximum":255,"example":"invoice number"},"minFieldLength":{"description":"Conatains the minimum length of the input field.","type":"integer","example":10},"maxFieldLength":{"description":"Conatains the maximum length of the input field.","type":"integer","example":55}}},"Currency":{"description":"The currency code as defined by ISO 20022, ActiveCurrencyCode\nSee also: https://en.wikipedia.org/wiki/ISO_4217\n","type":"string","minLength":3,"maxLength":3,"pattern":"[A-Z]{3,3}","example":"USD"},"Amount":{"description":"The basic type of an amount.","type":"object","required":["value","currency"],"properties":{"value":{"description":"The amount value of the given currency. As defined by ISO 20022, CurrencyAndAmount.","type":"string","pattern":"[0-9]{1,13}\\.[0-9]{1,3}","minimum":0,"example":345.67},"currency":{"$ref":"#/components/schemas/Currency"}}},"TypedAmount":{"description":"An enhanced type of amount carrying additional type data.","allOf":[{"$ref":"#/components/schemas/Amount"}],"type":"object","properties":{"amounttype":{"type":"string"}}},"TransactionComment":{"type":"string","minimum":1,"maximum":255,"description":"A comment field to provide more context to the transaction","example":"A very important transaction"},"Recipient":{"type":"string","minimum":1,"maximum":255,"description":"A field to provide more context about the transaction recipient","example":"Mr. Smith"},"MediaType":{"type":"string","enum":["CASH","CHECK","MIXED"]},"WorkstationType":{"type":"string","enum":["TYPE_INVALID","TYPE_ATM","TYPE_STP","TYPE_SST","TYPE_POS","TYPE_CRS","TYPE_CCDM"],"description":"The type of the device at the location, such as Automated Teller Machine (ATM), Self Service Terminal (SST), Statement Printer (SP)\n\n  | Symbolic name | Comment                            |\n  |---------------|------------------------------------|\n  | TYPE_INVALID  | Invalid type information/Unknown   |\n  | TYPE_ATM      | Automated Teller Machine (CashOut) |\n  | TYPE_STP      | Statement printer                  |\n  | TYPE_SST      | Self Service Terminal              |\n  | TYPE_POS      | Point of Sales                     |\n  | TYPE_CRS      | Cash Recycler (Cash in/Cash out)   |\n  | TYPE_CCDM     | Check/Cash Deposit Module          |\n  <br>\n","example":"TYPE_ATM"},"WorkstationStatus":{"type":"string","enum":["UNKNOWN","OPEN_CONSUMER","OPEN_CONSUMER_WITH_RESTRICTIONS","GREEN_IT","CLOSE_CONSUMER"],"description":"The required current state of the the device(s) near to the given location, such as\n  Online, Online with restrictions, ...\n  If the array is empty, all states of devices are considered.\n\n  | Symbolic name                    | Comment                                                                                              |\n  |----------------------------------|------------------------------------------------------------------------------------------------------|\n  | UNKNOWN                          | The device status is unknown or not one of the following states.                                     |\n  | OPEN_CONSUMER                    | The device (e.g. the ATM) is ready to serve customers.                                               |\n  | OPEN_CONSUMER_WITH_RESTRICTIONS  | The device is ready, but has (some) limitations, e.g. not all transactions are supported right now.  |\n  | GREEN_IT                         | The device is in GeenIT mode.                                                 |\n  | CLOSE_CONSUMER                   | The device is NOT ready to serve customers. However this does not seem to make sense.                 |","example":"OPEN_CONSUMER"},"RequiredTransactions":{"type":"object","required":["transactions"],"properties":{"transactions":{"type":"array","items":{"type":"string","description":"The type of transactions supported by the machine.\n","example":["WITHDRAWAL","DEPOSIT","CHECK_DEPOSIT"]}}}},"SupportedTransactions":{"type":"object","required":["transactions"],"properties":{"transactions":{"type":"array","items":{"type":"string","description":"The type of transactions supported by the machine.\n","example":["WITHDRAWAL","DEPOSIT","CHECK_DEPOSIT"]}}}},"GetLocationsTransactionConstants":{"type":"string","enum":["WITHDRAWAL","DEPOSIT","CHECK_DEPOSIT","CHECK_CASHING","CASH_PAYMENT","PSWITHDRAWAL","PSDEPOSIT"],"description":"GetLocationsTransactionConstants are mapped to TM transaction constants or service transaction constants. These must be specified in the workstation profile to get a match.\n| Symbolic name     | Comment                                                | TM Transaction Constant       | |-------------------|--------------------------------------------------------|-------------------------------| | WITHDRAWAL        | The machine supports cash out transactions             | WITHDRAWAL                    | | DEPOSIT           | The machine supports cash in transactions              | DEPOSIT & MIXED_MEDIA_PAYMENT | | CHECK_DEPOSIT     | The machine supports check deposit transactions        | CHECK_DEPOSIT                 | | CHECK_CASHING     | The machine supports check cashing transactions        | CHECK_CASHING                 | | CASH_PAYMENT      | The machine supports cash payment transactions         | CASH_PAYMENT                  | | PSWITHDRAWAL      | The machine supports prestaged cash out transactions   | PRESTAGED_WITHDRAWAL          | | PSDEPOSIT         | The machine supports prestaged cash in transactions    | PRESTAGED_DEPOSIT             |\n"},"OmapiAccountType":{"type":"string","enum":["NOT_SPECIFIED","GIRO","LOAN","SAVINGS","SECURITIES_DEPOSIT","SAVINGS_SECURITIES_DEPOSIT","GIRO_SECURITIES_DEPOSIT","FIXED_TERM_DEPOSIT","CREDIT_CARD","MORTGAGE","FOREIGN_CURRENCY","EXTERNAL","CHECKING","UNIVERSAL","SPENDING_POWER","FEE_COLLECTION_ACCOUNT","ATM","VENDOR","SHAREHOLDER","GENERAL_LEDGER","CASH_RESERVE","LOAN_DENIAL","LEASE","CONSUMER_LOAN","COMMERCIAL_LOAN","RETIREMENT_LOAN","EXTERNAL_LOAN","SHARE","INDIVIDUAL_RETIREMENT","CARD_PAN","HEALTH_SAVINGS","CREDIT","CREDIT_LINE","CERTIFIED_DEPOSIT","INSTALLMENT"],"example":"GIRO","description":"The default account type is 820000 (NOT_SPECIFIED). Please see: /getAccountTypes for all possible values."},"ShortAccountInfo":{"description":"An object used to hold only essential account data which is used in the context of API requests, e.g. prestaged transactions.","type":"object","required":["accountNumber","accountType"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"bankCode":{"$ref":"#/components/schemas/SwiftCode"},"accountType":{"$ref":"#/components/schemas/OmapiAccountType"}}},"AccountInfo":{"type":"object","required":["accountNumber","accountType"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"accountType":{"$ref":"#/components/schemas/OmapiAccountType"},"bankCode":{"$ref":"#/components/schemas/SwiftCode"},"accountName":{"type":"string","maxLength":255,"description":"The account name which is displayed to the user.","example":"Personal Checking Account"},"accountOwnerName":{"type":"string","maxLength":255,"description":"The name of the account owner.","example":"Betty Adams"},"accountStatus":{"type":"string","maxLength":255,"description":"Status description of the account."},"accountOwnership":{"type":"string","maxLength":255,"minLength":1,"description":"Ownership description of the account.","example":"Betty Adams"},"accountWarnings":{"type":"array","items":{"$ref":"#/components/schemas/AccountWarning"}},"accountCurrency":{"$ref":"#/components/schemas/Currency"},"amounts":{"type":"array","items":{"$ref":"#/components/schemas/TypedAmount"}},"possibleTransactions":{"description":"A list of possible transactions, which can be used on this account.","type":"array","items":{"type":"string","description":"Transaction name"},"example":"WITHDRAWAL,CASH_IN,LOAD_PREPAID"},"properties":{"description":"A list of addtional account properties.","type":"array","items":{"$ref":"#/components/schemas/KeyValuePair"}}}},"OmApiAccountRef":{"type":"object","required":["accountNumber","accountType"],"properties":{"accountNumber":{"$ref":"#/components/schemas/AccountNumber"},"accountType":{"$ref":"#/components/schemas/OmapiAccountType"}}},"Address":{"type":"object","required":["street","streetno","city","zipcode"],"properties":{"street":{"type":"string","maxLength":255,"description":"The name of the street.","example":"Mainstreet"},"streetno":{"type":"string","maxLength":255,"description":"The street number of this address.","example":"119"},"city":{"type":"string","maxLength":255,"description":"The name of the city.","example":"New York"},"zipcode":{"type":"string","maxLength":255,"description":"The zip code of this city.","example":"NY 5467"},"countrycode":{"type":"string","maxLength":255,"description":"The ISO 3166 (alpha-3) country code of this address.\nSee also: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3\n","example":"USA"}}},"AccountWithAmount":{"type":"object","required":["account","amount"],"properties":{"account":{"$ref":"#/components/schemas/ShortAccountInfo"},"amount":{"$ref":"#/components/schemas/Amount"},"transactionComment":{"$ref":"#/components/schemas/TransactionComment"}}},"DenominationAlgorithm":{"type":"object","required":["algorithm"],"properties":{"algorithm":{"type":"string","enum":["EVENLY_MIXED","HIGH_NOTES_PREFERED","LOW_NOTES_PREFERED"],"description":"The denomination algorithm determines the number and type of notes to be output at the ATM for that cashout transaction.\n| Symbolic name       | Comment | |---------------------|------------------------------------------------------------------------------------------------------| | EVENLY_MIXED        | The denomination mix is based on thresholds and the available cassettes. The amount is decreased by  | |                     | the highest possible note as long as the remaining amount is lower as the threshold for this note.   | |                     | This is to be continued with lower notes until the remaining amount is 0.                            | | HIGH_NOTES_PREFERED | As few notes as possible are extracted from the cash units, i.e. the cash units with notes of high   | |                     | value are preferred. | | LOW_NOTES_PREFERED  | Here the MANY_UNITS algorithm is used. However if one kind of denomination accumulate to more than   | |                     | 66% of the requested amount one of this notes is divided into lower denominations until the sum of   | |                     | values of that denomination is below 66% of the complete amount.                                     |","example":"EVENLY_MIXED"}}},"PaymentType":{"type":"object","required":["paymentType"],"properties":{"paymentType":{"type":"string","enum":["LOAN","CREDIT_CARD","BILL","SEPA","NOT_SPECIFIED"],"description":"The payment type of a transfer transaction.\n| Symbolic name | Comment                                                        | |---------------|----------------------------------------------------------------| | LOAN          | Payment to/from Loan account.                                  |  | CREDIT_CARD   | Payment from Credit card account.                              | | BILL          | Payment to/from Bill account.                                  |  | SEPA          | Payment to/from SEPA account.                                  |  | NOT_SPECIFIED | The payment type has not been specified or is simply unknown.  | \n  <br>\n","example":"LOAN"}}},"PaymentSubType":{"type":"object","required":["paymentSubType"],"properties":{"paymentSubType":{"type":"string","enum":["PRINCIPAL","REGULAR","PAYOFF","INST","NOT_SPECIFIED"],"description":"The payment sub type (especially for loan payment) of a transfer transaction.\n| Symbolic name | Comment                                                            | |---------------|--------------------------------------------------------------------| | NOT_SPECIFIED | The payment sub type has not been specified or is simply unknown.  |  | REGULAR       | Payment sub type regular/common payment.                           |  | PRINCIPAL     | Payment type sub type is PRINCIPAL.                                |  | PAYOFF        | Paying Off the Loan Balance.                                       | | INST          | SEPA Instant paymen. Only valid with PaymentType == SEPA.          |\n  <br>\n","example":"REGULAR"}}},"GenericTransactionOrderField":{"type":"object","required":["fieldId","fieldOrderNo","active","textId"],"properties":{"fieldId":{"type":"string","maxLength":32,"description":"A unique identifier (UUID) for a field in a generic transaction order. It should not be displayed to the customer but used to identifiy a certain field","example":"228A57E6FCE947BCB26A7DD516A24959"},"fieldOrderNo":{"type":"integer","description":"Defines order id of that field. Each field have a unique field order id. The mobile client or web view should arrange the fields according to their field numbers.","example":1},"active":{"type":"boolean","description":"Defines if the field is 'active'.","example":true},"textId":{"type":"string","maxLength":50,"description":"Contains the text id, which is used to get the correct translatio out of the languageProperties of the  generic transaction order the field belongs to.","example":"no_of_checkbooks"},"inputType":{"type":"integer","enum":[1,2,3],"description":"The input type of the input field as specified | Value | meaning       | |   1   | NUMERIC       | |   2   | ALPHA_NUMERIC | |   3   | OPTION        |","example":1},"selectOptions":{"type":"string","maxLength":250,"description":"'Contains the possible, selectable options of an options field as json object (array). This a value should only be used as long as the inputType is 3 (OPTION). The language specific value has to be picked up by the UI according the users UI language from the language properties of the generic order.'","example":"[\"shipping_option_Home_address\",\"shipping_option_Branch_pickup\"]"}}},"GenericTransactionOrderRequestField":{"type":"object","required":["fieldId","fieldValue"],"properties":{"fieldId":{"type":"string","maxLength":32,"description":"A unique identifier (UUID) for a field in a generic transaction order. It should not be displayed to the customer but used to identifiy a certain field","example":"228A57E6FCE947BCB26A7DD516A24959"},"fieldValue":{"type":"string","maxLength":255,"description":"Contains the (user input) value of that field. Allowed characters are: ^([\\s]*[a-zA-Z0-9]*[\\s_.'-ßöÖäÄüÜ$€?!:;@]?[,]?)*$","example":"1"}}},"GenericTransactionOrder":{"type":"object","required":["genericTransactionOrderId","genericTransactionOrderTypeId","shippingAddress","languageProperties","fields"],"properties":{"genericTransactionOrderId":{"type":"string","maxLength":32,"description":"A unique identifier (UUID) for generic transaction order type. It should not be displayed to the customer but used to identifiy a certain generic transaction order type","example":"228A57E6FCE947BCB26A7DD516A24959"},"genericTransactionOrderTypeId":{"type":"string","maxLength":50,"description":"A symbolic name for that generic transaction order type.","example":"Checkbook"},"shippingAddress":{"type":"string","maxLength":100,"description":"The address where the result/outcome of that generic transaction order should be shipped to.","example":"26 Shelly Lane, Bella Vista, Arkansas, USA"},"languageProperties":{"type":"string","maxLength":2000,"description":"A JSON object, which contains the language properties.","example":"{\"de\":{\"shipping_option_Home_address\":\"Postanschift\",\"no_of_checks\":\"Anzahl Schecks pro Buch\",\"shipping_option_Branch_pickup\":\"Filialabholung\",\"Checkbook\":\"Scheck-Buch\",\"no_of_checkbooks\":\"Anzahl Scheckbücher\",\"shipping_option\":\"Versandoptionen\"},\"en\":{\"shipping_option_Home_address\":\"Home address\",\"no_of_checks\":\"No of checks per book\",\"shipping_option_Branch_pickup\":\"Branch pickup\",\"Checkbook\":\"Checkbook\",\"no_of_checkbooks\":\"No of checkbooks\",\"shipping_option\":\"Shipping options\"}}"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/GenericTransactionOrderField"},"description":"The fields of that order type."}}},"CreditorData":{"type":"object","required":["paymentCode","paymentSubCode","paymentType","creditorId"],"properties":{"paymentCode":{"type":"string","maxLength":20,"description":"A unique identifier for the payment code","example":"32435545"},"paymentSubCode":{"type":"string","maxLength":20,"description":"A unique identifier for the payment sub code","example":"32435545"},"description":{"type":"string","maxLength":255,"description":"A description","example":"A description of a creditor."},"paymentType":{"$ref":"#/components/schemas/PaymentType"},"billerNetworkId":{"type":"string","maxLength":20,"description":"The biller network Id.","example":"32435545"},"institution":{"type":"string","maxLength":40,"description":"Institution of the creditor.","example":"32435545"},"partialPaymentsAllowed":{"type":"boolean","description":"Is set to true, if partial payments are allowed for this creditor.","example":false},"active":{"type":"boolean","description":"Is set to true, if this creditor is active/can be used.","example":true},"paymentGroup":{"type":"string","maxLength":70,"description":"The payment group of the creditor.","example":"Payment group"},"creditorId":{"type":"string","maxLength":255,"description":"A unique identifier for the creditor","example":"32435545"},"additionalFields":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalCreditorFieldDescription"}}}},"SinglePaymentOrderResponseData":{"type":"object","properties":{"sourceAccount":{"$ref":"#/components/schemas/ShortAccountInfo"},"targetAccount":{"$ref":"#/components/schemas/ShortAccountInfo"},"requestedAmount":{"$ref":"#/components/schemas/Amount"},"paymentType":{"$ref":"#/components/schemas/PaymentType"},"paymentSubType":{"$ref":"#/components/schemas/PaymentSubType"},"usageText":{"type":"string","maxLength":255,"description":"The usage text message.","example":"Invoice# 2273355A"},"senderName":{"type":"string","maxLength":255,"description":"The name of the sender.","example":"A. Rich. Guy"},"receiverName":{"type":"string","maxLength":255,"description":"The name of the receiver.","example":"A. Poor Guy"},"orderId":{"type":"string","maxLength":255,"description":"An optional field for an orderId or somethimg like that.","example":"Order# 9832327A565"},"referenceNumber":{"type":"string","maxLength":255,"description":"An optional field for an reference num,ber or somethimg like that.","example":"Reference# 935546655"},"scheduledDate":{"$ref":"#/components/schemas/OmapiDate"}}},"Location":{"type":"object","required":["locationId","status","latitude","longitude"],"properties":{"locationId":{"type":"string","maxLength":255,"description":"A unique identifier for a ATM, Branch, ...","example":"32435545"},"type":{"$ref":"#/components/schemas/WorkstationType"},"status":{"$ref":"#/components/schemas/WorkstationStatus"},"address":{"$ref":"#/components/schemas/Address"},"latitude":{"type":"number","format":"double","minimum":-90,"maximum":90,"description":"The latitude of the location. Format: DD.dddd. Range form -90.000000 to +90.000000","example":51.367043},"longitude":{"type":"number","format":"double","minimum":-180,"maximum":180,"description":"The longitude of the location. Format: DDD.dddd. Range form -180.000000 to +180.000000","example":12.481767},"supportedTransactions":{"type":"array","items":{"$ref":"#/components/schemas/GetLocationsTransactionConstants"}}}},"Transaction":{"type":"object","required":["amount","transactionDate","transactionComments"],"properties":{"amount":{"$ref":"#/components/schemas/Amount"},"sourceAccount":{"$ref":"#/components/schemas/OmApiAccountRef"},"targetAccount":{"$ref":"#/components/schemas/OmApiAccountRef"},"referenceId":{"type":"string","maxLength":255,"description":"The reference Id, if there is any aka. <b>primanota</b>","example":"87536789"},"transactionID":{"type":"string","maxLength":255,"description":"The transaction Id, if there is any.","example":"97536789"},"transactionDate":{"type":"string","pattern":"([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))","description":"The date when the transaction was executed, if the transaction is part of a getTransactionsResponse.\nThe date at which the transaction should be executed, if the transaction is part of the response to a getScheduledTransactionsRequest.\nThe date pattern is defined \"YYYY-MM-DD\", with YYYY as 4-digit year, MM as 2-digit month and DD as 2-digit day of month.\nAs defined by date-time - RFC3339\nPlease see: https://tools.ietf.org/html/rfc3339\nAn example of a valid date is: 2017-01-31\n","example":"2017-01-31"},"transactionComments":{"type":"string","maxLength":255,"example":"Thanks for your credit."}}},"ScheduledTransaction":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"fromAccountNumber":{"$ref":"#/components/schemas/AccountNumber"},"fromAccountType":{"type":"string","maxLength":255,"description":"The source account type."},"toAccountNumber":{"$ref":"#/components/schemas/AccountNumber"},"toAccountType":{"type":"string","maxLength":255,"description":"The beneficiary account type."},"referenceId":{"type":"string","maxLength":255,"description":"The reference Id, if there is any aka. <b>primanota</b>","example":"87536789"},"transactionID":{"type":"string","maxLength":255,"description":"The transaction Id, if there is any.","example":"97536789"},"transactionType":{"type":"string","maxLength":255,"description":"The type of the transaction (Fiserv and Fiserv DNA only)"},"nextTransactionDate":{"type":"string","pattern":"([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))","description":"The date at which the transaction should be executed.\nThe date pattern is defined \"YYYY-MM-DD\", with YYYY as 4-digit year, MM as 2-digit month and DD as 2-digit day of month.\nAs defined by date-time - RFC3339\nPlease see: https://tools.ietf.org/html/rfc3339\nAn example of a valid date is: 2017-01-31\n","example":"2017-01-31"},"lastTransactionDate":{"type":"string","pattern":"([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))","description":"The date at which the transaction was last executed.\nThe date pattern is defined \"YYYY-MM-DD\", with YYYY as 4-digit year, MM as 2-digit month and DD as 2-digit day of month.\nAs defined by date-time - RFC3339\nPlease see: https://tools.ietf.org/html/rfc3339\nAn example of a valid date is: 2017-01-31\n","example":"2017-01-31"},"transactionComments":{"type":"string","maxLength":255,"example":"Thanks for your credit."},"frequency":{"type":"string","maxLength":255}}},"PrestagedTransactionData":{"description":"Data of a prestaged transaction as returned when an overdraft confirmation is requested","type":"object","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"fromAccountNumber":{"$ref":"#/components/schemas/AccountNumber"},"fromAccountType":{"type":"string","maxLength":255,"description":"The source account type."},"transactionID":{"type":"string","maxLength":255,"description":"The transaction Id, if there is any.","example":"97536789"},"validFromDate":{"type":"string","pattern":"([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))","description":"The date from which the prestaged transaction is valid.\nThe date pattern is defined \"YYYY-MM-DD\", with YYYY as 4-digit year, MM as 2-digit month and DD as 2-digit day of month.\nAs defined by date-time - RFC3339\nPlease see: https://tools.ietf.org/html/rfc3339\nAn example of a valid date is: 2017-01-31\n","example":"2017-01-31"},"validToDate":{"type":"string","pattern":"([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))","description":"The date until the prestaged transaction is valid.\nThe date pattern is defined \"YYYY-MM-DD\", with YYYY as 4-digit year, MM as 2-digit month and DD as 2-digit day of month.\nAs defined by date-time - RFC3339\nPlease see: https://tools.ietf.org/html/rfc3339\nAn example of a valid date is: 2017-01-31\n","example":"2017-01-31"}}},"RequestedTransactionData":{"description":"Data of a requested scheduled transactions (formerly known as turnover position) from backend host as returned when an overdraft confirmation is requested","type":"object","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"fromAccountNumber":{"$ref":"#/components/schemas/AccountNumber"},"fromAccountType":{"type":"string","maxLength":255,"description":"The source account type."},"referenceId":{"type":"string","maxLength":255,"description":"The reference Id, if there is any aka. <b>primanota</b>","example":"87536789"},"valueDate":{"type":"string","pattern":"([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))","description":"The transaction date.\nThe date pattern is defined \"YYYY-MM-DD\", with YYYY as 4-digit year, MM as 2-digit month and DD as 2-digit day of month.\nAs defined by date-time - RFC3339\nPlease see: https://tools.ietf.org/html/rfc3339\nAn example of a valid date is: 2017-01-31\n","example":"2017-01-31"},"entryText":{"type":"string","maxLength":255,"example":"Thanks."}}},"StandingOrder":{"description":"The StandingOrder model object","type":"object","required":["orderId","amount","sourceAccount","beneficiaryAccount","receiverName","recurrenceType","startDate","endAfter"],"properties":{"orderId":{"type":"string"},"amount":{"$ref":"#/components/schemas/Amount"},"sourceAccount":{"$ref":"#/components/schemas/ShortAccountInfo"},"beneficiaryAccount":{"$ref":"#/components/schemas/ShortAccountInfo"},"receiverName":{"type":"string","minLength":1,"maxLength":255},"transactionComment":{"type":"string","minLength":1,"maxLength":255},"recurrenceType":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"]},"firstExecutionDate":{"$ref":"#/components/schemas/OmapiDate"},"lastExecutionDate":{"$ref":"#/components/schemas/OmapiDate"},"lastExecutionState":{"type":"string"},"nextExecutionDate":{"$ref":"#/components/schemas/OmapiDate"},"endAfter":{"type":"string","description":"This string can contain different values:<br> 1.) The parameter contains \"NO_END\". In this case the execution will happen as long as the standing order exists. Pay attention to the capitalization! 2.) The parameter contains a positive and integer number. The standing order is executed as often as defined by this positive, integer number in the parameter \"endAfter\". 3.) The parameter contains a values which matches a date with the pattern like '([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))'. In this case the date defines the latest execution date.","example":"1"}}},"PrestagedTransactionType":{"type":"string","enum":["CASHOUT","DEPOSIT","SPLIT","BRANCH_DEPOSIT"],"description":"The type of a prestaged transaction.\n| Symbolic name  | Comment                                                  | |----------------|----------------------------------------------------------| | CASHOUT        | It was a cashout (credit) transaction.                   | | DEPOSIT        | It was a cashin (debit/deposit) transaction.             | | BRANCH_DEPOSIT | It was a cashin (debit/deposit) transaction in a branch. | | SPLIT          | It was a split deposit as part of a cashin transaction.  |\n  <br>\n","example":"CASHOUT, DEPOSIT, SPLIT or BRANCH_DEPOSIT"},"PrestagedTransactionState":{"type":"string","enum":["FAILED","CREATED","PENDING","PAYED","EXPIRED"],"description":"The state of a prestaged transaction.\n| Symbolic name | Comment                                                                                            | |---------------|----------------------------------------------------------------------------------------------------| | FAILED        | The pending transaction failed for whatever reason, e.g. expired or so. It's a final state.        | | CREATED       | The pending transaction has been created. State will asynchronously change to PENDING immediately. | | PENDING       | The transaction is valid and pending.                                                              | | PAYED         | The transaction has been executed and is in a final state.                                         | | EXPIRED       | The transaction is expired. This is a final state too.                                             |\n\n  <br>\n","example":"PENDING"},"CardlessModeEnum":{"type":"string","enum":["SELF","OTHER","MEANINGLESS"],"description":"The type of a prestaged transaction.\n| Symbolic name | Comment                                                                              | |---------------|--------------------------------------------------------------------------------------| | SELF          | It was a cashout (credit) transaction for the customer himself.                      | | OTHER         | It was a cashout (credit) transaction for a different person. Not for the customer.  | | MEANINGLESS   | It wasn't a cashout (credit) transaction, so the the 'cardlessMode' is meaningless.  |\n","example":"SELF"},"CommonPrestagedTransactionInfo":{"type":"object","discriminator":{"propertyName":"modelType"},"required":["transactionId","transactionType","accessCode","dateValidFrom","transactionState"],"properties":{"modelType":{"type":"string"},"transactionId":{"type":"string","minLength":1,"description":"The transaction ID of the newly created prestaged transaction.","example":"5c2af6a642984309b4f094671824c730"},"businessCorrelationId":{"$ref":"#/components/schemas/BusinessCorrelationId"},"amount":{"$ref":"#/components/schemas/Amount"},"transactionType":{"$ref":"#/components/schemas/PrestagedTransactionType"},"transactionComment":{"$ref":"#/components/schemas/TransactionComment"},"dateCreated":{"type":"string","format":"yyyy-MM-dd HH:mm:ssZ","description":"The date when the prestaged transaction was created. As defined by date-time - RFC3339. Please see: https://tools.ietf.org/html/rfc3339","example":"2017-10-02T15:00:00.05Z"},"dateValidFrom":{"type":"string","format":"yyyy-MM-dd HH:mm:ssZ","description":"The date from which the prestaged transaction is valid. As defined by date-time - RFC3339. Please see: https://tools.ietf.org/html/rfc3339","example":"2017-10-02T15:00:00.05Z"},"dateValidTo":{"type":"string","format":"yyyy-MM-dd HH:mm:ssZ","description":"The date until the prestaged transaction is valid. As defined by date-time - RFC3339. Please see: https://tools.ietf.org/html/rfc3339","example":"2017-10-01T18:00:00.00Z"},"transactionState":{"$ref":"#/components/schemas/PrestagedTransactionState"}}},"PrestagedCashoutTransactionInfo":{"allOf":[{"$ref":"#/components/schemas/CommonPrestagedTransactionInfo"}],"type":"object","required":["denominationAlgorithm"],"properties":{"accessCode":{"type":"string","minLength":1,"description":"The access code of the newly created prestaged transaction.","example":"0815"},"cardlessMode":{"$ref":"#/components/schemas/CardlessModeEnum"},"denominationAlgorithm":{"$ref":"#/components/schemas/DenominationAlgorithm"},"msisdn":{"$ref":"#/components/schemas/MsisdnString"},"mailAddress":{"$ref":"#/components/schemas/MailAddressString"},"recipient":{"$ref":"#/components/schemas/Recipient"}}},"PrestagedDepositTransactionInfo":{"allOf":[{"$ref":"#/components/schemas/CommonPrestagedTransactionInfo"}],"type":"object","properties":{"intendedMediaType":{"$ref":"#/components/schemas/MediaType"},"accessCode":{"type":"string","minLength":1,"description":"The access code of the newly created prestaged transaction.","example":"0815"},"isSplitDeposit":{"type":"boolean","description":"Indicates if a deposit transaction is part of a split deposit. This additional indicator is necessary since split deposits are embedded into the context of their parent deposit transaction when queried with __/getPrestagedTransactions__."},"splitData":{"type":"array","items":{"$ref":"#/components/schemas/AccountWithAmount"},"description":"If the request contains the member splitData, the prestaged cashin will be processed as a split cashin."}}},"PrestagedSplitDepositTransactionInfo":{"allOf":[{"$ref":"#/components/schemas/CommonPrestagedTransactionInfo"}],"type":"object","properties":{"isSplitDeposit":{"type":"boolean","description":"Indicates if a deposit transaction is part of a split deposit. This additional indicator is necessary since split deposits are embedded into the context of their parent deposit transaction when queried with __/getPrestagedTransactions__."}}},"PrestagedBranchDepositTransactionInfo":{"allOf":[{"$ref":"#/components/schemas/CommonPrestagedTransactionInfo"}],"type":"object","properties":{"intendedMediaType":{"$ref":"#/components/schemas/MediaType"},"accessCode":{"type":"string","minLength":1,"description":"The access code of the newly created prestaged transaction.","example":"0815"},"description":{"type":"string","minLength":0,"maxLength":255,"description":"An optional description text, to provide more context for the /createBranchDeposit request."},"transferText":{"type":"string","minLength":0,"maxLength":255,"description":"An optional transfer text, to provide more context for the /createBranchDeposit request."}}},"MobileDeviceType":{"type":"string","enum":["APPLE","ANDROID"],"description":"This enum defines which type of mobile device will receive the remote notifications."},"PushPaymentData":{"allOf":[{"$ref":"#/components/schemas/Transaction"}]},"BusinessCorrelationId":{"type":"string","minLength":1,"description":"The businessCorrelationId of the newly created prestaged transaction. The businessCorrelationId is used for logging and tracing purposes inside Transaction Middleware. \nFor example, when a client creates a prestaged cash out transaction which is to be executed later, those two otherwise distinct calls can be \"correlated\" together using the businessCorrelationId. The id generated on transaction creation must be provided to the /executePrestagedTransaction endpoint to make use of this feature.","example":"886aaaf82a3d4e4ebe4667a2402592c9"},"CreateBranchDepositRequestPayload":{"type":"object","required":["targetAccount","destinationOfAccessCode"],"description":"Schema to easily generate a crypto payload for /createBranchDeposit requests","properties":{"targetAccount":{"$ref":"#/components/schemas/ShortAccountInfo"},"intendedMediaType":{"$ref":"#/components/schemas/MediaType"},"owner":{"type":"string","description":"The owner of the account. ","maxLength":128,"example":"Bill Gates"},"description":{"type":"string","description":"An optional description of the deposit request.","example":"It is always nice to put more money to my account."},"transactionComment":{"$ref":"#/components/schemas/TransactionComment"},"destinationOfAccessCode":{"$ref":"#/components/schemas/SendToSpec"},"notificationReceiver":{"$ref":"#/components/schemas/NotificationReceiver"}}},"CreateCashout2YouRequestPayload":{"type":"object","required":["amount","sourceAccount","destinationOfAccessCode","secureCode","overdraftConfirmed"],"description":"Schema to easily generate a crypto payload for /createCashout2You requests","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"sourceAccount":{"$ref":"#/components/schemas/ShortAccountInfo"},"transactionComment":{"$ref":"#/components/schemas/TransactionComment"},"recipient":{"$ref":"#/components/schemas/Recipient"},"destinationOfAccessCode":{"$ref":"#/components/schemas/SendToSpec"},"secureCode":{"type":"string","minLength":1,"pattern":"^\\d+$","description":"The secure code of the prestaged tranasction. This code must be transmitted from the initiator to the receiver of the cashout transaction for authorization purpose, e.g. by a phone call or SMS.","example":"0815"},"denominationAlgorithm":{"$ref":"#/components/schemas/DenominationAlgorithm"},"overdraftConfirmed":{"type":"boolean","description":"Check for overdraft situation. If a overdraft situation occurs a special error code is sent back to the client to inform the client regarding this situation.","example":true},"notificationReceiver":{"$ref":"#/components/schemas/NotificationReceiver"},"SupplementaryData":{"$ref":"#/components/schemas/OmApiSupplementaryData"}}},"CreateCashout4MeRequestPayload":{"type":"object","required":["amount","sourceAccount","overdraftConfirmed"],"description":"Schema to easily generate a crypto payload for /createCashout4Me requests","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"sourceAccount":{"$ref":"#/components/schemas/ShortAccountInfo"},"transactionComment":{"$ref":"#/components/schemas/TransactionComment"},"denominationAlgorithm":{"$ref":"#/components/schemas/DenominationAlgorithm"},"overdraftConfirmed":{"type":"boolean","description":"Check for overdraft situation. If a  overdraft situation occurs a special error code is send back to the client to inform the client regarding this situation.","example":true},"destinationOfAccessCode":{"$ref":"#/components/schemas/SendToSpec"},"notificationReceiver":{"$ref":"#/components/schemas/NotificationReceiver"},"SupplementaryData":{"$ref":"#/components/schemas/OmApiSupplementaryData"}}},"CreateDepositRequestPayload":{"type":"object","required":["targetAccount"],"description":"Schema to easily generate a crypto payload for /createDeposit requests","properties":{"targetAccount":{"$ref":"#/components/schemas/ShortAccountInfo"},"amount":{"$ref":"#/components/schemas/Amount"},"intendedMediaType":{"$ref":"#/components/schemas/MediaType"},"splitData":{"type":"array","items":{"$ref":"#/components/schemas/AccountWithAmount"},"description":"If the request contains the member splitData, the prestaged cashin will be processed as a split cashin."},"transactionComment":{"$ref":"#/components/schemas/TransactionComment"},"destinationOfAccessCode":{"$ref":"#/components/schemas/SendToSpec"},"notificationReceiver":{"$ref":"#/components/schemas/NotificationReceiver"}}},"CreateDisputeRequestPayload":{"type":"object","required":["dispute"],"description":"Schema to easily generate a crypto payload for /createDispute requests","properties":{"dispute":{"type":"string","minLength":1,"description":"The dispute message sent to the institute","example":"I did not buy this!"}}},"CreateTransferRequestPayload":{"type":"object","required":["amount","sourceAccount","targetAccount","receiverName"],"description":"Schema to easily generate a crypto payload for /createTransfer requests","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"sourceAccount":{"$ref":"#/components/schemas/ShortAccountInfo"},"targetAccount":{"$ref":"#/components/schemas/ShortAccountInfo"},"paymentType":{"$ref":"#/components/schemas/PaymentType"},"paymentSubType":{"$ref":"#/components/schemas/PaymentSubType"},"receiverName":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the receiver","example":"John D. Rockefeller"},"transactionComments":{"type":"string","maxLength":255,"example":"Thanks for your credit."}}},"ExecutePrestagedTransactionRequestPayload":{"type":"object","required":["nodeId","accessCode","tokenUUID"],"description":"Schema to easily generate a crypto payload for /executePrestagedTransaction requests.","properties":{"businessCorrelationId":{"$ref":"#/components/schemas/BusinessCorrelationId"},"tokenUUID":{"type":"string","minLength":1,"description":"The tokenUUID of the QR-Code encoded JWT that is scanned from the ATM. The tokenUUID resides in the JWT's claimSet as __tokenClaim__.","example":"6d1b8551-6e7b-49c1-a540-00b0b8fc8a15"},"nodeId":{"type":"string","minLength":1,"description":"The nodeId of the device where the QR-Code encoded JWT was obtained from. The nodeId resides in the JWT's claimSet as __nodeIdClaim__.","example":273645},"accessCode":{"type":"string","minLength":1,"description":"The accessCode that was provided in the response when the prestaged transaction was created.","example":6680},"latitude":{"type":"string","minLength":1,"pattern":"^[+-]?(([1-8]\\d|[0-9])(\\.\\d{1,6})?|90(\\.0{1,6})?)$","description":"Optional latitude of the customer's location when executing the prestaged transaction. Valid range: -90 to +90 degrees with up to 6 decimal places (e.g. 51.367000).","example":"51.367000"},"longitude":{"type":"string","minLength":1,"pattern":"^[+-]?((1[0-7]\\d|[1-9]\\d|[0-9])(\\.\\d{1,6})?|180(\\.0{1,6})?)$","description":"Optional longitude of the customer's location when executing the prestaged transaction. Valid range: -180 to +180 degrees with up to 6 decimal places (e.g. 12.481500).","example":"12.481500"},"additionalSecurity":{"type":"boolean","description":"When additionalSecurity is used (true) the ATM which provided the QR-Code encoded JWT will make itself recognizable to the customer according to it's capabilities e.g. blink indicator lights or play audible sounds. The parameter is optional but may be required from the server side with an appropriate response."},"SupplementaryData":{"$ref":"#/components/schemas/OmApiSupplementaryData"}}},"GetLocationsRequestPayload":{"type":"object","required":["latitude","longitude","radius","wkstStates","requiredTransactions"],"description":"Schema to easily generate a crypto payload for /getLocations requests.","properties":{"latitude":{"type":"number","format":"double","description":"The latitude of the location. Format: DD.dddd. Range form -90.0000 to +90.0000","example":51.367},"longitude":{"type":"number","format":"double","description":"The longitude of the location. Format: DDD.dddd. Range form -180.0000 to +180.0000","example":12.4815},"radius":{"type":"integer","minimum":0,"maximum":1000,"description":"The radius in kilometer to search for locations.","example":15},"wkstStates":{"type":"array","items":{"$ref":"#/components/schemas/WorkstationStatus"}},"requiredTransactions":{"type":"array","items":{"$ref":"#/components/schemas/GetLocationsTransactionConstants"}}}},"ExecuteGenericTransactionOrderRequestPayload":{"type":"object","required":["genericTransactionOrderId","fields"],"description":"Schema to easily generate a crypto payload for /executeGenericTransactionOrder requests.","properties":{"genericTransactionOrderId":{"type":"string","maxLength":32,"description":"A unique identifier (UUID) for generic transaction order type. It should not be displayed to the customer but used to identifiy a certain generic transaction order type","example":"228A57E6FCE947BCB26A7DD516A24959"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/GenericTransactionOrderRequestField"},"description":"The fields of that generic order transaction."}}},"AuthorizePullPaymentRequestPayload":{"type":"object","required":["transactionId","end2endId","iban"],"description":"Schema to easily generate a crypto payload for /sepa/confirmInstantPayment requests.","properties":{"transactionId":{"type":"string","minLength":1},"end2endId":{"type":"string","minLength":1},"iban":{"type":"string","minLength":1}}},"CreatePushPaymentRequestPayload":{"type":"object","required":["sourceAccount","targetAccount","requestedAmount","paymentType","paymentSubType","senderName","receiverName"],"description":"Schema to easily generate a crypto payload for /getSinglePaymentOrderData requests.","properties":{"sourceAccount":{"$ref":"#/components/schemas/ShortAccountInfo"},"targetAccount":{"$ref":"#/components/schemas/ShortAccountInfo"},"requestedAmount":{"$ref":"#/components/schemas/Amount"},"paymentType":{"$ref":"#/components/schemas/PaymentType"},"paymentSubType":{"$ref":"#/components/schemas/PaymentSubType"},"usageText":{"type":"string","maxLength":255,"description":"The usage text message.","example":"Invoice# 2273355A"},"senderName":{"type":"string","maxLength":255,"description":"The name of the sender.","example":"A. Rich. Guy"},"senderCountry":{"type":"string","maxLength":2,"description":"The country of the sender.","example":"DE"},"receiverName":{"type":"string","maxLength":255,"description":"The name of the receiver.","example":"A. Poor Guy"},"receiverCountry":{"type":"string","maxLength":2,"description":"The country of the sender.","example":"DE"},"orderId":{"type":"string","maxLength":255,"description":"An optional field for an orderId or something like that.","example":"Order# 9832327A565"},"referenceNumber":{"type":"string","maxLength":255,"description":"An optional field for a reference number or something like that.","example":"Reference# 935546655"},"scheduledDate":{"$ref":"#/components/schemas/OmapiDate"}}},"SetPreferencesRequestPayload":{"type":"object","required":["pan"],"description":"Schema to easily generate a crypto payload for /setPreferences requests.","properties":{"pan":{"type":"string","pattern":"^\\d+$","minLength":13,"maxLength":19,"description":"The PAN of the card to get the preferences for.","example":"4761739028380180"},"scope":{"type":"string","minLength":1,"description":"If given, the 'scope' will be used to set the given preferences. If the scope is not given, the default scope will be used.","example":"defaultInvoiceRecipient"},"preferences":{"type":"array","items":{"$ref":"#/components/schemas/KeyValuePair"}}}},"SinglePaymentOrderRequestPayload":{"type":"object","description":"Schema to easily generate a crypto payload for /getSinglePaymentOrderData requests.","properties":{"sourceAccount":{"$ref":"#/components/schemas/OmApiAccountRef"},"targetAccount":{"$ref":"#/components/schemas/OmApiAccountRef"},"requestedAmount":{"$ref":"#/components/schemas/Amount"},"paymentType":{"$ref":"#/components/schemas/PaymentType"},"paymentSubType":{"$ref":"#/components/schemas/PaymentSubType"},"usageText":{"type":"string","maxLength":255,"description":"The usage text message.","example":"Invoice# 2273355A"},"senderName":{"type":"string","maxLength":255,"description":"The name of the sender.","example":"A. Rich. Guy"},"receiverName":{"type":"string","maxLength":255,"description":"The name of the receiver.","example":"A. Poor Guy"},"orderId":{"type":"string","maxLength":255,"description":"An optional field for an orderId or something like that.","example":"Order# 9832327A565"},"referenceNumber":{"type":"string","maxLength":255,"description":"An optional field for a reference number or something like that.","example":"Reference# 935546655"},"scheduledDate":{"$ref":"#/components/schemas/OmapiDate"}}},"StandingOrderRequestPayload":{"type":"object","required":["createTransferRequest","recurrenceType","startDate","endAfter"],"description":"Schema to easily generate a crypto payload for /createStandingOrder and /updateStandingOrder requests.\nThe __createTransferRequest__ property uses the same schema as the __CreateTransferRequestPayload__ but should be used __unencrypted__ in this context. It will be encrypted with the __StandingOrderRequestPayload__.","properties":{"createTransferRequest":{"$ref":"#/components/schemas/CreateTransferRequestPayload"},"recurrenceType":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"],"description":"The recurrence of a standing order transaction defines the execution frequency regarding the next possible transactions.","example":"MONTHLY"},"startDate":{"$ref":"#/components/schemas/OmapiDate"},"endAfter":{"type":"string","description":"This string can contain different values:<br> 1.) The parameter contains \"NO_END\". In this case the execution will happen as long as the standing order exists. Pay attention to the capitalization! 2.) The parameter contains a positive and integer number. The standing order is executed as often as defined by this positive, integer number in the parameter \"endAfter\". 3.) The parameter conatins a values which matches a date with the pattern like '([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))'. In this case the date defines the latest execution date.","example":"1"}}},"UpdateAccountNickNameRequestPayload":{"type":"object","required":["account","accountName"],"description":"Schema to easily generate a crypto payload for /updateAccountNickName requests.","properties":{"account":{"$ref":"#/components/schemas/OmApiAccountRef"},"accountName":{"type":"string","minLength":1,"maxLength":255,"description":"The new name of the account","example":"FastCashAccount"}}},"GetAccountsResponsePayload":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/AccountInfo"}}}},"GetCreditorsResponsePayload":{"type":"object","properties":{"creditors":{"type":"array","items":{"$ref":"#/components/schemas/CreditorData"}}}},"GetSinglePaymentOrderDataResponsePayload":{"type":"object","properties":{"singlePaymentOrderData":{"$ref":"#/components/schemas/CreditorData"}}},"GetPreferencesResponsePayload":{"type":"object","properties":{"preferences":{"type":"array","items":{"$ref":"#/components/schemas/KeyValuePair"}}}},"GetClientBrandingResponsePayload":{"type":"object","properties":{"clientBranding":{"type":"string","minLength":0,"description":"The returned client branding data is <font color='red'>ALWAYS base64 encoded</font>"}}},"GetAccountTypesResponsePayload":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/OmapiAccountType"},"example":["GIRO","SAVINGS","SECURITIES_DEPOSIT"]}}},"GetTransactionsResponsePayload":{"type":"object","properties":{"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}}}},"GetScheduledTransactionsResponsePayload":{"type":"object","properties":{"transactions":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledTransaction"}}}},"GetAccountDetailsResponsePayload":{"type":"object","required":["accountDetails"],"properties":{"accountDetails":{"$ref":"#/components/schemas/AccountInfo"}}},"CreateCashout4MeResponsePayload":{"type":"object","required":["prestagedTransactionInfo"],"properties":{"prestagedTransactionInfo":{"$ref":"#/components/schemas/PrestagedCashoutTransactionInfo"},"lastScheduledTransactions":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledTransaction"}},"prestagedTransactions":{"type":"array","items":{"$ref":"#/components/schemas/PrestagedTransactionData"}},"requestedTransactions":{"type":"array","items":{"$ref":"#/components/schemas/RequestedTransactionData"}}}},"CreateCashout2YouResponsePayload":{"type":"object","required":["prestagedTransactionInfo"],"properties":{"prestagedTransactionInfo":{"$ref":"#/components/schemas/PrestagedCashoutTransactionInfo"},"lastScheduledTransactions":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledTransaction"}},"prestagedTransactions":{"type":"array","items":{"$ref":"#/components/schemas/PrestagedTransactionData"}},"requestedTransactions":{"type":"array","items":{"$ref":"#/components/schemas/RequestedTransactionData"}}}},"CreateDepositResponsePayload":{"type":"object","required":["prestagedTransactionInfo"],"properties":{"prestagedTransactionInfo":{"$ref":"#/components/schemas/PrestagedDepositTransactionInfo"}}},"CreateBranchDepositResponsePayload":{"type":"object","required":["prestagedTransactionInfo"],"properties":{"prestagedTransactionInfo":{"$ref":"#/components/schemas/PrestagedBranchDepositTransactionInfo"}}},"GetPrestagedTransactionsResponsePayload":{"type":"object","properties":{"accountInfo":{"$ref":"#/components/schemas/ShortAccountInfo"},"transactions":{"type":"array","items":{"type":"object"}}}},"GetStandingOrdersResponsePayload":{"type":"object","properties":{"standingOrders":{"type":"array","items":{"$ref":"#/components/schemas/StandingOrder"}}}},"GetLocationsResponsePayload":{"type":"object","properties":{"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"}}}},"GetGenericTransactionOrdersResponsePayload":{"type":"object","properties":{"genericTransactionOrders":{"type":"array","items":{"$ref":"#/components/schemas/GenericTransactionOrder"}}}},"CreateTransferResponsePayload":{"type":"object","required":["referenceId"],"properties":{"referenceId":{"type":"string","description":"The unique identifier of the create transfer transaction. ","example":"46CAADAB-87D8-47B0-8B0A-4F46973EA2E8"}}},"ManageRemoteNotificationsPayload":{"type":"object","required":["mobileDeviceType","deviceToken","applicationId","displayName","locale"],"properties":{"mobileDeviceType":{"$ref":"#/components/schemas/MobileDeviceType"},"deviceToken":{"type":"string","minLength":8,"description":"The base64 encoded device identifier, which is send to Apple Push Notification Service (APNS) or Google Cloud Messaging Service (Firebase/GCM). <br> If the device is an Android device, please see: https://firebase.google.com/docs/cloud-messaging/android/client<br>\n For Apple devices, please see: https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/HandlingRemoteNotifications.html#//apple_ref/doc/uid/TP40008194-CH6-SW1<br>\n The deviceToken is expected to be a base64-encoded string, since the native deviceToken on a mobile device, such as Apple devices, is a bunch of binary data.","example":"hNpl+kKYBLZl1JMGOCiKxBK/lzRDasJkRVSp6D81hqk="},"applicationId":{"type":"string","minLength":6,"description":"Please provide a unique device and application specific identifier. <br> This identifier is used to identify __this__ device and the coresponding application on __that__ device in the TM database.  The applicationId sould be the same in all calls of a certain mobile device and the coresponding application.  For iOS it is the bundle identifier, such as de.wincor.MobileBankingDemoApp, which you can get by calling [[NSBundle mainBundle] bundleIdentifier];","example":"de.wincor.MobileBankingDemoApp"},"displayName":{"type":"string","minLength":6,"description":"This string is used to display a human readable form of the applicationId.<br> This is useful, for example, when notifications are to be assigned to this application on this device in an administrative, manual process.","example":"Mobile Banking Demo App"},"welcomeMessage":{"type":"string","description":"This string is used - __if set__ - to send an initial message to the customers phone, right after receiving the registerForRemoteNotifications call.<br>","example":"Welcome to your Mobile Banking Demo App. We'll keep you informed regarding important events of your account."},"locale":{"type":"string","minLength":2,"description":"An ISO 639 alpha-2 or alpha-3 language code maybe with an appended \"-\" or \"_\" and an ISO 3166 alpha-2 or alpha-3 country code. Example: de_DE, en_US\n"}}},"GetPushPaymentResponsePayload":{"type":"object","required":["pushPaymentData"],"description":"Bla bla bla, Mr. Freeman","properties":{"pushPaymentData":{"$ref":"#/components/schemas/PushPaymentData"}}},"CreateBranchDepositRequest":{"type":"object","required":["cryptoEnvelope"],"description":"With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __CreateBranchDepositRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"CreateCashout2YouRequest":{"type":"object","required":["cryptoEnvelope"],"description":"With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __CreateCashout2YouRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"CreateCashout4MeRequest":{"type":"object","required":["cryptoEnvelope"],"description":"With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __CreateCashout4MeRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"CreateDepositRequest":{"type":"object","required":["cryptoEnvelope"],"description":"With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __CreateDepositRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"CreateDisputeRequest":{"type":"object","required":["cryptoEnvelope"],"description":"With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __CreateDisputeRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"CreateTransferRequest":{"type":"object","required":["cryptoEnvelope"],"description":"With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __CreateTransferRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"ExecutePrestagedTransactionRequest":{"type":"object","required":["cryptoEnvelope"],"description":"With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __ExecutePrestagedTransactionRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"GetLocationsRequest":{"type":"object","required":["cryptoEnvelope"],"description":"With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __GetLocationsRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"ExecuteGenericTransactionOrderRequest":{"type":"object","required":["cryptoEnvelope"],"description":"With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __ExecuteGenericTransactionOrderRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"ManageRemoteNotificationsRequest":{"type":"object","required":["cryptoEnvelope"],"description":"The request body only holds one property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request/response properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __ManageRemoteNotificationsPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"CreatePushPaymentRequest":{"type":"object","required":["cryptoEnvelope"],"description":"The request body only holds one property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request/response properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by the schema __CreatePushPaymentRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"AuthorizePullPaymentRequest":{"type":"object","required":["cryptoEnvelope"],"description":"The request body only holds one property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request/response properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by the schema __AuthorizePullPaymentRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"SetPreferencesRequest":{"type":"object","required":["cryptoEnvelope"],"description":"With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __SetPreferencesRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"SinglePaymentOrderRequest":{"type":"object","required":["cryptoEnvelope"],"description":"With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __SinglePaymentOrderRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"StandingOrderRequest":{"type":"object","required":["cryptoEnvelope"],"description":"With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __StandingOrderRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"UpdateAccountNickNameRequest":{"type":"object","required":["cryptoEnvelope"],"description":"With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the __CryptoEnvelope__:\n\n  CryptoEnvelope:\n    type: object\n    required:\n      - payload\n    description: >-\n      Object holding cryptographically secured request properties.\n    properties:\n      payload:\n        type: string\n        minLength: 1\n        example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\n\nThe __CryptoEnvelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object which is specified by  the schema __UpdateAccountNickNameRequestPayload__.","properties":{"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"CheckAccountResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"CreateDisputeResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"DeletePrestagedTransactionResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"DeleteStandingOrderResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"ExecutePrestagedTransactionResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"GetAccountsResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetAccountsResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"GetEcKeyResponse":{"type":"object","required":["responseStatus","ecKeyAsPem"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"ecPublicKey":{"$ref":"#/components/schemas/EcPublicKey"}}},"GetRsaKeyResponse":{"type":"object","required":["responseStatus","rsaPublicKey"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"rsaPublicKey":{"$ref":"#/components/schemas/RsaPublicKey"}}},"GetVersionResponse":{"type":"object","required":["encryptionRequired","responseStatus"],"properties":{"encryptionRequired":{"type":"boolean","description":"true, if enrcryption of request and response payloads is required.","example":true},"versionInfo":{"type":"array","items":{"type":"string","minLength":1},"description":"OM-API version info"},"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"GetCreditorsResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetCreditorsResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"GetSinglePaymentOrderDataResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetSinglePaymentOrderDataResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"GetPreferencesResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetPreferencesResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"GetClientBrandingResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetClientBrandingResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"GetAccountTypesResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetAccountTypesResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"GetTransactionsResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetTransactionsResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"GetScheduledTransactionsResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetScheduledTransactionsResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"GetAccountDetailsResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetAccountDetailsResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"CreateCashout4MeResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __CreateCashout4MeResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"CreateCashout2YouResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema CreateCashout2YouResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"CreateDepositResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __CreateDepositResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"CreateBranchDepositResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __CreateBranchDepositResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"GetPrestagedTransactionsResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetPrestagedTransactionsResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"GetStandingOrdersResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetStandingOrdersResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"CreateTransferResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __CreateTransferResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"GetGenericTransactionOrdersResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetGenericTransactionOrdersResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"GetLocationsResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetLocationsResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"ExecuteGenericTransactionOrderResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"GetPushPaymentResponse":{"type":"object","required":["responseStatus"],"description":"The response data is contained in the __CryptoEnvelope__'s property __payload__ as encrypted and stringified JSON object using the schema __GetPushPaymentResponsePayload__","properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"},"cryptoEnvelope":{"$ref":"#/components/schemas/CryptoEnvelope"}}},"CreatePushPaymentResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"CancelPushPaymentResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"GetPullPaymentResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"AuthorizePullPaymentResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"CancelPullPaymentResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"SetPreferencesResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"UpdateAccountNickNameResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}},"ManageRemoteNotificationsResponse":{"type":"object","required":["responseStatus"],"properties":{"responseStatus":{"$ref":"#/components/schemas/ResponseBase"}}}}},"security":[{"bearerAuth":[]}]}