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:
\n | Request Name | Error | Error Code |\n |---------------|-------|-------------|\n | *Account\
\ Management API*\n | | | |\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 | | | |\n | getAccountTypes | SERVER_FAILURE | 2870100 |\n\
\ | | VERIFICATION_FAILED | 2870115 |\n | | | |\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 | | | |\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 | | | |\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 | \
\ | | |\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 | | | |\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 | | | |\n | createDispute | SERVER_FAILURE\
\ | 2870700 |\n | | SYSTEM_ERROR | 2870701 |\n | | MESSAGE_NOT_SENT | 2870700 |\n |\
\ | REQUEST_DATA_INVALID | 2870703 |\n | | VERIFICATION_FAILED | 2870715 |\n | \
\ | | |\n | *Standing Order API*\n | | | |\n | getStandingOrders | SERVER_FAILURE | 2871000 |\n | \
\ | REQUEST_DATA_INVALID | 2871002 |\n | | CONSUMER_NOT_FOUND | 2871012 |\n | \
\ | VERIFICATION_FAILED | 2871015 |\n | | | |\n | createStandingOrder | SERVER_FAILURE | 2871100 |\n \
\ | | REQUEST_DATA_INVALID | 2871102 |\n | | VERIFICATION_FAILED | 2871115 |\n | \
\ | | |\n | updateStandingOrder | SERVER_FAILURE | 2871200 |\n | | SYSTEM_ERROR | 2871201 |\n | \
\ | REQUEST_DATA_INVALID | 2871202 |\n | | STANDINGORDER_NOT_FOUND | 2871209 |\n | \
\ | VERIFICATION_FAILED | 2871215 |\n | | | |\n | deleteStandingOrder | SERVER_FAILURE | 2871300\
\ |\n | | REQUEST_DATA_INVALID | 2871302 |\n | | STANDINGORDER_NOT_FOUND | 2871309 |\n\
\ | | VERIFICATION_FAILED | 2871315 |\n | | | |\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 | | | |\n | *Prestaged Transaction API*\n\
\ | | | |\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 | | | |\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 | | | |\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 | | | |\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 | | | |\n | deletePrestagedTransaction\
\ | SERVER_FAILURE | 2872400 |\n | | RESERVED | 2872400 |\n | | REQUEST_DATA_INVALID\
\ | 2872402 |\n | | VERIFICATION_FAILED | 2872415 |\n | | | |\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 | \
\ | | |\n | executePrestagedTransaction | SERVER_FAILURE | 2872600 |\n | | SYSTEM_ERROR | 2872601\
\ |\n | | REQUEST_DATA_INVALID | 2872602 |\n | | VERIFICATION_FAILED | 2872615 |\n \
\ | | | |\n | *Miscellaneous API*\n | | | |\n | getCreditors | SERVER_FAILURE | 2874000 |\n | \
\ | SYSTEM_ERROR | 2874001 |\n | | REQUEST_DATA_INVALID | 2874002 |\n | \
\ | VERIFICATION_FAILED | 2874015 |\n | | | |\n | getSinglePaymentOrderData | SERVER_FAILURE | 2874100 |\n\
\ | | RESERVED | 2874100 |\n | | REQUEST_DATA_INVALID | 2874102 |\n | \
\ | CONSUMER_NOT_FOUND | 2874112 |\n | | VERIFICATION_FAILED | 2874115 |\n | | | |\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 | | | |\n | setPreferences | SERVER_FAILURE\
\ | 2874300 |\n | | RESERVED | 2874300 |\n | | REQUEST_DATA_INVALID | 2874302 |\n |\
\ | VERIFICATION_FAILED | 2874315 |\n | | | |\n | getClientBranding | SERVER_FAILURE | 2874400\
\ |\n | | RESERVED | 2874400 |\n | | REQUEST_DATA_INVALID | 2874402 |\n | \
\ | VERIFICATION_FAILED | 2874415 |\n | | | |\n | getGenericTransactionOrders | SERVER_FAILURE | 2874500\
\ |\n | | RESERVED | 2874500 |\n | | REQUEST_DATA_INVALID | 2874502 |\n | \
\ | VERIFICATION_FAILED | 2874515 |\n | | | |\n | executeGenericTransactionOrder | SERVER_FAILURE |\
\ 2874600 |\n | | RESERVED | 2874600 |\n | | REQUEST_DATA_INVALID | 2874602 |\n | \
\ | VERIFICATION_FAILED | 2874615 |\n | | | |\n | getLocations | SERVER_FAILURE | 2873000 |\n\
\ | | SYSTEM_ERROR | 2873001 |\n | | REQUEST_DATA_INVALID | 2873002 |\n | \
\ | NO_RESULT | 2873003 |\n | | VERIFICATION_FAILED | 2873015 |\n | | | |\n | *Accessibility\
\ API*\n | | | |\n | getRsaKey | SERVER_FAILURE | 2875000 |\n | | VERIFICATION_FAILED | 2875015\
\ |\n | | | |\n | getEcKey | SERVER_FAILURE | 2875100 |\n | | VERIFICATION_FAILED | 2875115\
\ |\n | | | |\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.
The OM-API V4 number range is 2870000\
\ - 2879999.
Within that range, every requests group has its number range of 1000:
\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\
\
\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 | \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 | \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 | \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 | \n | *Accessibility API*\n | getRsaKey\
\ | 2875000-2875099 |\n | getEcKey | 2875100-2875199 |\n | getVersion\
\ | 2875200-2875299 |\n
\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.
The The error property is optional.
It is set only if an error has been detected.
'
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.
It is assumed, that the TM facets can
be obtained from the request data in the following way...
FacetContainer container = FacetContainerMapperUtil.fromJsonMap(facets);
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.
Date string as defined by date-time - RFC3339
Please see: https://tools.ietf.org/html/rfc3339
'
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
See also:
https://en.wikipedia.org/wiki/International_Bank_Account_Number
'
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)
The BIC - also known as SWIFT-code - as defined by ISO 9362 is required in/for cross border transfers/transactions.
Please see: https://en.wikipedia.org/wiki/ISO_9362
This field can also be used to send/receive an ABA RTN (ABA routing transit number) or Canadian TN (Canadian transit
number).
See also: https://en.wikipedia.org/wiki/Routing_transit_number
The bank code is NOT required!
'
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
See also: https://en.wikipedia.org/wiki/ISO_4217
'
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
\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.
'
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.
'
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.
| 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 |
'
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.
See also: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
'
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.
| 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
\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
\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. primanota
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.
The date at which the transaction should be executed, if the transaction is part of the response to a getScheduledTransactionsRequest.
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.
As defined by date-time - RFC3339
Please see: https://tools.ietf.org/html/rfc3339
An example of a valid date is: 2017-01-31
'
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. primanota
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.
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.
As defined by date-time - RFC3339
Please see: https://tools.ietf.org/html/rfc3339
An example of a valid date is: 2017-01-31
'
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.
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.
As defined by date-time - RFC3339
Please see: https://tools.ietf.org/html/rfc3339
An example of a valid date is: 2017-01-31
'
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.
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.
As defined by date-time - RFC3339
Please see: https://tools.ietf.org/html/rfc3339
An example of a valid date is: 2017-01-31
'
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.
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.
As defined by date-time - RFC3339
Please see: https://tools.ietf.org/html/rfc3339
An example of a valid date is: 2017-01-31
'
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. primanota
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.
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.
As defined by date-time - RFC3339
Please see: https://tools.ietf.org/html/rfc3339
An example of a valid date is: 2017-01-31
'
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:
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
\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
\n"
example: PENDING
CardlessModeEnum:
type: string
enum:
- SELF
- OTHER
- MEANINGLESS
description: 'The type of a prestaged transaction.
| 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. |
'
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.
The __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:
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 ALWAYS base64 encoded
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).
If the device is an Android device, please see: https://firebase.google.com/docs/cloud-messaging/android/client
\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
\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.
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.
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.
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
'
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: []