DN Online & Mobile API
Diebold Nixdorf Online & Mobile API — the Vynamic Transaction Middleware surface used by online and mobile banking channels for cardless and mobile-initiated self-service transactions. 35 paths, bearer/OpenID Connect authentication; OpenAPI 3.0.3, version 3.2.1.
This API exposes 39 operations across 35 paths, organized into 6 resource areas, and defines 152 schemas. It is described by OpenAPI 3.0.3, at version 3.2.1.
Requests are made against 2 base URLs: http://localhost:8080/tm-om-api/v4, https://localhost:8080/tm-om-api/v4.
39 operations
35 paths
152 schemas
2 DELETE18 GET19 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
DN Online & Mobile API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— When using the bearer authentication method an access token has to be provided in the HTTP authorization header. When using openIdConnect as security scheme th…
Paths & Operations 39
Across 35 paths, the API surfaces 39 operations — 2 DELETE, 18 GET, 19 POST. They span 6 resource areas: Accessibility API, Account Management API, Standing Order API, Prestaged Transaction API, Miscellaneous API, SEPA Credit Transfer Instant API. Each is listed below with its method, path, parameters, and response codes.
Accessibility API 3
GET
/getRsaKey
Returns the public key (RSA) for API request encryption.
GET
/getEcKey
Returns the public key (ECIES) of the server system.
GET
/getVersion
Returns API version info.
Account Management API 9
GET
/getAccounts
Returns a list of accounts for the given consumerId.
GET
/getAccountTypes
Returns a list of supported account types.
GET
/checkAccount
Check for account.
POST
/createTransfer
Create a transfer of funds request.
GET
/getTransactions
Returns all transactions for the given account and consumerId.
GET
/getScheduledTransactions
Returns all scheduled transactions for the given account and consumerId.
GET
/getAccountDetails
Returns detailed information for the given account and consumerId.
POST
/createDispute
File a dispute
POST
/updateAccountNickName
Update the account nickname.
Standing Order API 4
GET
/getStandingOrders
Returns a list of standing orders for the given consumerId.
POST
/createStandingOrder
Create a standing order for the given account and consumerId.
POST
/updateStandingOrder
Update an existing standing order by the given referenceId.
POST
/deleteStandingOrder
Delete an existing standing order.
Prestaged Transaction API 7
POST
/createCashout4Me
Create a prestaged cashout (withdrawal) transaction.
POST
/createCashout2You
Create a prestaged cash out transaction request.
POST
/createDeposit
Create a prestaged cashin/deposit transaction request.
POST
/createBranchDeposit
Create a prestaged deposit transaction request.
POST
/deletePrestagedTransaction
Delete existing prestaged transactions.
GET
/getPrestagedTransactions
Returns a list of all prestaged transactions for the given consumerId.
POST
/executePrestagedTransaction
Execute a prestaged transaction at an ATM with an accessCode.
Miscellaneous API 10
POST
/getLocations
Get all ATM locations.
GET
/getCreditors
Get a list of system wide defined payees.
GET
/getSinglePaymentOrderData
Get the details of a system wide defined creditor as returned in the getCreditorsResponse of a getCreditors call.
GET
/getPreferences
Get a list of user defined parameters.
POST
/setPreferences
Set a list of user defined parameters, which can be used to store any information.
GET
/getClientBranding
Get the client branding file.
GET
/getGenericTransactionOrders
Get a list of system defined generic transaction orders.
POST
/executeGenericTransactionOrder
Set a list of user defined parameters, which can be used to store any information.
POST
/registerForRemoteNotifications
Register a mobile device - either iOS or Android - for remote notifications.
POST
/unregisterForRemoteNotifications
Register a mobile device - either iOS or Android - for remote notifications.
SEPA Credit Transfer Instant API 6
GET
/sepa-instant/pushPayment
Get the status of a SEPA Instant credit transfer
POST
/sepa-instant/pushPayment
Create a SEPA instant payment request
DELETE
/sepa-instant/pushPayment
Cancel a SEPA instant payment request
GET
/sepa-instant/pullPayment
Get the status of a SEPA instant pull payment
POST
/sepa-instant/pullPayment
Authorize a pending SEPA instant payment request (pull payment)
DELETE
/sepa-instant/pullPayment
Cancel a pending SEPA instant payment request (pull payment)
Schemas 152
The contract defines 152 schemas that model the data the API accepts and returns. The most detailed are CreatePushPaymentRequestPayload (13 properties), AccountInfo (12 properties), StandingOrder (12 properties), ScheduledTransaction (12 properties). Each schema is shown below with its type and property counts.
Error
object
The error property is optional. It is set only if an error has been detected. Each request has its number range used for error codes (see ResponseBase schema).…
2 properties
1 required
ResponseBase
object
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…
2 properties
1 required
Credentials
object
Schema to easily generate a Credentials object for server side validation of the user credentials. The Credentials object contains the sessionToken and the con…
2 properties
2 required
KeyValuePair
object
A key value pair to store/retrieve a key and a value as strings in a generic way. Used in some API calls/objects.
2 properties
2 required
OmApiSupplementaryData
object
/ 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... F…
1 property
OmapiDate
string
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 -…
MsisdnString
string
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 mo…
MSISDN
object
1 property
1 required
MailAddressString
string
A valid eMail addressas defined by RFC5322.
MailAddress
object
1 property
1 required
NotificationReceiver
object
4 properties
1 required
SendToSpec
RsaPublicKey
EcPublicKey
PublicKeyPem
object
A holder object for PEM formatted public keys
1 property
1 required
AesKeyParams
object
A holder object for AES symmetric key params.
2 properties
2 required
AesKeyByteParams
object
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…
2 properties
2 required
CryptoParams
object
3 properties
CryptoEnvelope
object
Object holding a cryptographically secured request properties.
2 properties
1 required
AccountNumber
string
The account number. The length varies greatly. In Europe defined by ISO 13616/2007 See also: https://en.wikipedia.org/wiki/InternationalBankAccountNumber
AccountWarning
object
Warnings regarding the bank account of a user.
5 properties
SwiftCode
string
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…
AdditionalCreditorFieldDescription
object
A key value pair to store/retrieve a key and a value as strings in a generic way. Used in some API calls/objects.
3 properties
3 required
Currency
string
The currency code as defined by ISO 20022, ActiveCurrencyCode See also: https://en.wikipedia.org/wiki/ISO4217
Amount
object
The basic type of an amount.
2 properties
2 required
TypedAmount
object
An enhanced type of amount carrying additional type data.
1 property
TransactionComment
string
A comment field to provide more context to the transaction
Recipient
string
A field to provide more context about the transaction recipient
MediaType
string
WorkstationType
string
The type of the device at the location, such as Automated Teller Machine (ATM), Self Service Terminal (SST), Statement Printer (SP) | Symbolic name | Comment |…
WorkstationStatus
string
The required current state of the the device(s) near to the given location, such as Online, Online with restrictions, ... If the array is empty, all states of…
RequiredTransactions
object
1 property
1 required
SupportedTransactions
object
1 property
1 required
GetLocationsTransactionConstants
string
GetLocationsTransactionConstants are mapped to TM transaction constants or service transaction constants. These must be specified in the workstation profile to…
OmapiAccountType
string
The default account type is 820000 (NOTSPECIFIED). Please see: /getAccountTypes for all possible values.
ShortAccountInfo
object
An object used to hold only essential account data which is used in the context of API requests, e.g. prestaged transactions.
3 properties
2 required
AccountInfo
object
12 properties
2 required
OmApiAccountRef
object
2 properties
2 required
Address
object
5 properties
4 required
AccountWithAmount
object
3 properties
2 required
DenominationAlgorithm
object
1 property
1 required
PaymentType
object
1 property
1 required
PaymentSubType
object
1 property
1 required
GenericTransactionOrderField
object
6 properties
4 required
GenericTransactionOrderRequestField
object
2 properties
2 required
GenericTransactionOrder
object
5 properties
5 required
CreditorData
object
11 properties
4 required
SinglePaymentOrderResponseData
object
11 properties
Location
object
7 properties
4 required
Transaction
object
7 properties
3 required
ScheduledTransaction
object
12 properties
PrestagedTransactionData
object
Data of a prestaged transaction as returned when an overdraft confirmation is requested
6 properties
RequestedTransactionData
object
Data of a requested scheduled transactions (formerly known as turnover position) from backend host as returned when an overdraft confirmation is requested
6 properties
StandingOrder
object
The StandingOrder model object
12 properties
8 required
PrestagedTransactionType
string
The type of a prestaged transaction. | Symbolic name | Comment | |----------------|----------------------------------------------------------| | CASHOUT | It w…
PrestagedTransactionState
string
The state of a prestaged transaction. | Symbolic name | Comment | |---------------|----------------------------------------------------------------------------…
CardlessModeEnum
string
The type of a prestaged transaction. | Symbolic name | Comment | |---------------|-----------------------------------------------------------------------------…
CommonPrestagedTransactionInfo
object
10 properties
5 required
PrestagedCashoutTransactionInfo
object
6 properties
1 required
PrestagedDepositTransactionInfo
object
4 properties
PrestagedSplitDepositTransactionInfo
object
1 property
PrestagedBranchDepositTransactionInfo
object
4 properties
MobileDeviceType
string
This enum defines which type of mobile device will receive the remote notifications.
PushPaymentData
BusinessCorrelationId
string
The businessCorrelationId of the newly created prestaged transaction. The businessCorrelationId is used for logging and tracing purposes inside Transaction Mid…
CreateBranchDepositRequestPayload
object
Schema to easily generate a crypto payload for /createBranchDeposit requests
7 properties
2 required
CreateCashout2YouRequestPayload
object
Schema to easily generate a crypto payload for /createCashout2You requests
10 properties
5 required
CreateCashout4MeRequestPayload
object
Schema to easily generate a crypto payload for /createCashout4Me requests
8 properties
3 required
CreateDepositRequestPayload
object
Schema to easily generate a crypto payload for /createDeposit requests
7 properties
1 required
CreateDisputeRequestPayload
object
Schema to easily generate a crypto payload for /createDispute requests
1 property
1 required
CreateTransferRequestPayload
object
Schema to easily generate a crypto payload for /createTransfer requests
7 properties
4 required
ExecutePrestagedTransactionRequestPayload
object
Schema to easily generate a crypto payload for /executePrestagedTransaction requests.
8 properties
3 required
GetLocationsRequestPayload
object
Schema to easily generate a crypto payload for /getLocations requests.
5 properties
5 required
ExecuteGenericTransactionOrderRequestPayload
object
Schema to easily generate a crypto payload for /executeGenericTransactionOrder requests.
2 properties
2 required
AuthorizePullPaymentRequestPayload
object
Schema to easily generate a crypto payload for /sepa/confirmInstantPayment requests.
3 properties
3 required
CreatePushPaymentRequestPayload
object
Schema to easily generate a crypto payload for /getSinglePaymentOrderData requests.
13 properties
7 required
SetPreferencesRequestPayload
object
Schema to easily generate a crypto payload for /setPreferences requests.
3 properties
1 required
SinglePaymentOrderRequestPayload
object
Schema to easily generate a crypto payload for /getSinglePaymentOrderData requests.
11 properties
StandingOrderRequestPayload
object
Schema to easily generate a crypto payload for /createStandingOrder and /updateStandingOrder requests. The createTransferRequest property uses the same schema…
4 properties
4 required
UpdateAccountNickNameRequestPayload
object
Schema to easily generate a crypto payload for /updateAccountNickName requests.
2 properties
2 required
GetAccountsResponsePayload
object
1 property
1 required
GetCreditorsResponsePayload
object
1 property
GetSinglePaymentOrderDataResponsePayload
object
1 property
GetPreferencesResponsePayload
object
1 property
GetClientBrandingResponsePayload
object
1 property
GetAccountTypesResponsePayload
object
1 property
1 required
GetTransactionsResponsePayload
object
1 property
GetScheduledTransactionsResponsePayload
object
1 property
GetAccountDetailsResponsePayload
object
1 property
1 required
CreateCashout4MeResponsePayload
object
4 properties
1 required
CreateCashout2YouResponsePayload
object
4 properties
1 required
CreateDepositResponsePayload
object
1 property
1 required
CreateBranchDepositResponsePayload
object
1 property
1 required
GetPrestagedTransactionsResponsePayload
object
2 properties
GetStandingOrdersResponsePayload
object
1 property
GetLocationsResponsePayload
object
1 property
GetGenericTransactionOrdersResponsePayload
object
1 property
CreateTransferResponsePayload
object
1 property
1 required
ManageRemoteNotificationsPayload
object
6 properties
5 required
GetPushPaymentResponsePayload
object
Bla bla bla, Mr. Freeman
1 property
1 required
CreateBranchDepositRequest
object
With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the CryptoEnvelope: CryptoEnvelope: t…
1 property
1 required
CreateCashout2YouRequest
object
With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the CryptoEnvelope: CryptoEnvelope: t…
1 property
1 required
CreateCashout4MeRequest
object
With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the CryptoEnvelope: CryptoEnvelope: t…
1 property
1 required
CreateDepositRequest
object
With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the CryptoEnvelope: CryptoEnvelope: t…
1 property
1 required
CreateDisputeRequest
object
With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the CryptoEnvelope: CryptoEnvelope: t…
1 property
1 required
CreateTransferRequest
object
With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the CryptoEnvelope: CryptoEnvelope: t…
1 property
1 required
ExecutePrestagedTransactionRequest
object
With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the CryptoEnvelope: CryptoEnvelope: t…
1 property
1 required
GetLocationsRequest
object
With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the CryptoEnvelope: CryptoEnvelope: t…
1 property
1 required
ExecuteGenericTransactionOrderRequest
object
With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the CryptoEnvelope: CryptoEnvelope: t…
1 property
1 required
ManageRemoteNotificationsRequest
object
The request body only holds one property, the CryptoEnvelope: CryptoEnvelope: type: object required: - payload description: - Object holding cryptographically…
1 property
1 required
CreatePushPaymentRequest
object
The request body only holds one property, the CryptoEnvelope: CryptoEnvelope: type: object required: - payload description: - Object holding cryptographically…
1 property
1 required
AuthorizePullPaymentRequest
object
The request body only holds one property, the CryptoEnvelope: CryptoEnvelope: type: object required: - payload description: - Object holding cryptographically…
1 property
1 required
SetPreferencesRequest
object
With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the CryptoEnvelope: CryptoEnvelope: t…
1 property
1 required
SinglePaymentOrderRequest
object
With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the CryptoEnvelope: CryptoEnvelope: t…
1 property
1 required
StandingOrderRequest
object
With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the CryptoEnvelope: CryptoEnvelope: t…
1 property
1 required
UpdateAccountNickNameRequest
object
With OM-API v3 encryption is used for all endpoints. The request body is therefore specified to contain only on property, the CryptoEnvelope: CryptoEnvelope: t…
1 property
1 required
CheckAccountResponse
object
1 property
1 required
CreateDisputeResponse
object
1 property
1 required
DeletePrestagedTransactionResponse
object
1 property
1 required
DeleteStandingOrderResponse
object
1 property
1 required
ExecutePrestagedTransactionResponse
object
1 property
1 required
GetAccountsResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetAccountsResponsePayload
2 properties
1 required
GetEcKeyResponse
object
2 properties
2 required
GetRsaKeyResponse
object
2 properties
2 required
GetVersionResponse
object
3 properties
2 required
GetCreditorsResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetCreditorsResponsePayload
2 properties
1 required
GetSinglePaymentOrderDataResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetSinglePaymentOrderDataResp…
2 properties
1 required
GetPreferencesResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetPreferencesResponsePayload
2 properties
1 required
GetClientBrandingResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetClientBrandingResponsePayl…
2 properties
1 required
GetAccountTypesResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetAccountTypesResponsePayload
2 properties
1 required
GetTransactionsResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetTransactionsResponsePayload
2 properties
1 required
GetScheduledTransactionsResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetScheduledTransactionsRespo…
2 properties
1 required
GetAccountDetailsResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetAccountDetailsResponsePayl…
2 properties
1 required
CreateCashout4MeResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema CreateCashout4MeResponsePaylo…
2 properties
1 required
CreateCashout2YouResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema CreateCashout2YouResponsePayl…
2 properties
1 required
CreateDepositResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema CreateDepositResponsePayload
2 properties
1 required
CreateBranchDepositResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema CreateBranchDepositResponsePa…
2 properties
1 required
GetPrestagedTransactionsResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetPrestagedTransactionsRespo…
2 properties
1 required
GetStandingOrdersResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetStandingOrdersResponsePayl…
2 properties
1 required
CreateTransferResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema CreateTransferResponsePayload
2 properties
1 required
GetGenericTransactionOrdersResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetGenericTransactionOrdersRe…
2 properties
1 required
GetLocationsResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetLocationsResponsePayload
2 properties
1 required
ExecuteGenericTransactionOrderResponse
object
1 property
1 required
GetPushPaymentResponse
object
The response data is contained in the CryptoEnvelope's property payload as encrypted and stringified JSON object using the schema GetPushPaymentResponsePayload
2 properties
1 required
CreatePushPaymentResponse
object
1 property
1 required
CancelPushPaymentResponse
object
1 property
1 required
GetPullPaymentResponse
object
1 property
1 required
AuthorizePullPaymentResponse
object
1 property
1 required
CancelPullPaymentResponse
object
1 property
1 required
SetPreferencesResponse
object
1 property
1 required
UpdateAccountNickNameResponse
object
1 property
1 required
ManageRemoteNotificationsResponse
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Banking#Payments#ATM#Self-Service#Transaction Middleware#Vynamic#Mobile Banking#Digital Banking
Where this information came from
This is an independent, third-party profile of DN Online & Mobile API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.