DN Open Backend API
Public REST API of Diebold Nixdorf for banking core system integration — authentication, account information, consumer information and account processing operations used by Vynamic Transaction Middleware to connect self-service channels to a bank core. 62 paths across four tag groups; OpenAPI 3.0.1, version 4.3.0.
This API exposes 62 operations across 62 paths, organized into 5 resource areas, and defines 289 schemas. It is described by OpenAPI 3.0.1, at version 4.3.0.
Requests are made against a single base URL, https://localhost:8080/OB-API-REST/v2.
62 operations
62 paths
289 schemas
3 GET59 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
DN Open Backend API declares
3 security schemes
for authenticating requests.
It accepts HTTP basic authentication (basic).
It accepts HTTP bearer tokens (Any string) (bearer).
It accepts HTTP bearer tokens (Any string) (jweBearer).
By default, every request must be authenticated.
basic— Authorization will contain base 64 encoded userName:password stringbearer— Authorization will contain token received using getToken request as Bearer TokenjweBearer— Authorization will contain Bearer encryptedJWT. JWT will be encrypted with backend endpoint public key
Paths & Operations 62
Across 62 paths, the API surfaces 62 operations — 3 GET, 59 POST. They span 5 resource areas: Authentication API, Account Information API, Consumer Information API, Account Processing API, Authorization Processing API. Each is listed below with its method, path, parameters, and response codes.
Authentication API 4
Authentication request for a transaction.
GET
/getToken
Get Token for API requests
POST
/exchangeKey
Exchange Key with the Backend Host
POST
/zpkExchange
Zone PIN Key Exchange
GET
/keepAlive
Checks availability of OB-API backends
Account Information API 13
Fetches account information.
POST
/accountList
Get the account list of a consumer
POST
/accountInquiry
Returns detail information of an account
POST
/getAccountMovement
Returns the list of all the transactions processed in an account.
POST
/getAccountStopHold
Returns list of holds and stop payments on an account
POST
/getAccountWarnings
Returns list of Account Warnings on an account.
POST
/getAccountListWarnings
Returns list of Account Warnings on every account.
POST
/getBusinessDate
Returns the Business Date.
POST
/getCardList
Returns list of Cards of an account.
POST
/getCheckIssuerDetails
Returns details of a check.
POST
/getScheduledTransactions
Returns the list of all the transactions that are yet to be in an account.
POST
/accountHold
Creates a hold on an account
POST
/cancelAccountHold
Cancels the hold on an account
POST
/updateAccountNickName
update the account nickname
Consumer Information API 7
Fetches consumer information.
POST
/consumerIdentify
Returns detailed information of a consumer
POST
/getConsumerWarnings
Returns a list of consumer warnings on an account.
POST
/ofacSearch
Returns the list of all ofac accounts.
POST
/updateCardState
Updates the card state
POST
/getPreferences
Retrieves the list of customer preferences
POST
/setPreferences
Saves the list of customer preferences
GET
/getMemberBankList
Retrieves the list of member banks
Account Processing API 7
Performs a transaction.
POST
/credit
performs credit operation
POST
/debit
performs debit operation
POST
/pinCheck
Verify pin.
POST
/transfer
performs transfer operation
POST
/reversal
Performs reversal for a transaction.
POST
/transferReversal
Performs reversal for a transfer transaction.
POST
/currencyTransactionReporting
performs transactions that consists of cash deposits, check deposits, cash withdrawals and cash checks
Authorization Processing API 31
POST
/login
Performs a login
POST
/logout
Performs a logout
POST
/cassCounterChanged
Lists changes to cassette counters
POST
/pinChangeAuthorize
Authorizes a pin change operation
POST
/pinChangeFinalize
Finalizes a pin change operation
POST
/withdrawalAuthorize
Authorizes a withdrawal transaction
POST
/withdrawalFinalize
Finalizes a withdrawal transaction
POST
/transferAuthorize
Authorizes a transfer transaction
POST
/transferFinalize
Finalizes a transfer transaction
POST
/depositAuthorize
Authorizes a deposit transaction
POST
/depositValidate
Validates a deposit transaction
POST
/depositFinishValidation
Finishes the validation of a deposit transaction
POST
/depositProcessClearing
Processes the clearing of a deposit transaction
POST
/depositFinalize
Finalizes a deposit transaction
POST
/mixedMediaPaymentAuthorize
Authorizes a mixed media payment transaction
POST
/mixedMediaPaymentValidate
Validates a mixed media payment transaction
POST
/mixedMediaPaymentFinishValidation
Finishes the validation a mixed media payment transaction
POST
/mixedMediaPaymentProcessClearing
Processes the clearing of a mixed media payment transaction
POST
/mixedMediaPaymentFinalizeCashOut
Finalizes the cashout of a mixed media payment transaction
POST
/mixedMediaPaymentFinalize
Finalizes a mixed media payment transaction
POST
/checkCashingAuthorize
Authorizes a check cashing transaction
POST
/checkCashingValidate
Validates a check cashing transaction
POST
/checkCashingFinishValidation
Finishes the validation of a check cashing transaction
POST
/checkCashingProcessClearing
Processes the clearing of a check cashing transaction
POST
/checkCashingAuthorizeCashOut
Authorizes the cashout of a check cashing transaction
POST
/checkCashingFinalizeCashOut
Finalizes the cashout of a check cashing transaction
POST
/checkCashingFinalize
Finalizes a check cashing transaction
POST
/currencyExchangeRates
Retrieves the exchange rates for a given pair of currencies
POST
/addCash
Adds details of cash added to the transaction
POST
/addCheck
Adds details of the check added to the transaction
POST
/updateChecks
Updates details of the check added to the transaction
Schemas 289
The contract defines 289 schemas that model the data the API accepts and returns. The most detailed are CheckDetails (25 properties), DenomCounter (14 properties), CheckIssuerDetails (13 properties), ConsumerProfile (13 properties). Each schema is shown below with its type and property counts.
ServiceResponse
object
2 properties
1 required
tokenResponse
object
getMemberBankListResponse
object
keepAliveResponse
object
accountInquiryRequest
object
3 properties
3 required
consumerIdentifyRequest
object
3 properties
3 required
accountInquiryResponse
object
creditRequest
object
3 properties
3 required
debitRequest
object
3 properties
3 required
transferRequest
object
3 properties
3 required
currencyTransactionReportingRequest
object
3 properties
3 required
currencyTransactionReportingResponse
object
updateCardStateRequest
object
3 properties
3 required
accountHoldRequest
object
3 properties
3 required
getAccountStopHoldRequest
object
3 properties
3 required
getAccountStopHoldResponse
object
cancelAccountHoldRequest
object
3 properties
3 required
getAccountWarningsRequest
object
3 properties
3 required
getAccountWarningsResponse
object
getAccountListWarningsRequest
object
3 properties
3 required
getAccountListWarningsResponse
object
getConsumerWarningsRequest
object
3 properties
3 required
getConsumerWarningsResponse
object
getCardListRequest
object
3 properties
3 required
getCardListResponse
object
updateAccountNickNameRequest
object
3 properties
3 required
getBusinessDateRequest
object
3 properties
3 required
getBusinessDateResponse
object
getAccountMovementRequest
object
3 properties
3 required
getAccountMovementResponse
object
getOfacSearchRequest
object
3 properties
3 required
getOfacSearchResponse
object
getScheduledTransactionsRequest
object
3 properties
3 required
getScheduledTransactionsResponse
object
getCheckIssuerDetailsRequest
object
3 properties
3 required
getCheckIssuerDetailsResponse
object
reversalRequest
object
3 properties
3 required
transferReversalRequest
object
3 properties
3 required
transferReversalResponse
object
pinCheckRequest
object
3 properties
3 required
login.request
object
3 properties
3 required
login.response
object
logout.request
object
3 properties
3 required
logout.response
object
cassCounterChanged.request
object
3 properties
3 required
cassCounterChanged.response
object
pinChange.authorize.Request
object
3 properties
3 required
pinChange.authorize.response
object
pinChange.finalize.request
object
3 properties
3 required
pinchange.finalize.response
object
withdrawal.authorize.request
object
3 properties
3 required
withdrawal.authorize.response
object
withdrawal.finalize.request
object
3 properties
3 required
withdrawal.finalize.response
object
transfer.authorize.request
object
3 properties
3 required
transfer.authorize.response
object
transfer.finalize.request
object
3 properties
3 required
transfer.finalize.response
object
deposit.authorize.request
object
3 properties
3 required
deposit.authorize.response
object
addCash.request
object
3 properties
3 required
addCash.response
object
addCheck.request
object
3 properties
3 required
addCheck.response
object
updateChecks.request
object
3 properties
3 required
updateChecks.response
object
deposit.validate.request
object
3 properties
3 required
deposit.validate.response
object
deposit.finishValidation.request
object
3 properties
3 required
deposit.finishValidation.response
object
deposit.processClearing.request
object
3 properties
3 required
deposit.processClearing.response
object
deposit.finalize.request
object
3 properties
3 required
deposit.finalize.response
object
mmp.authorize.request
object
3 properties
3 required
mmp.authorize.response
object
mmp.finalize.request
object
3 properties
3 required
mmp.finalize.response
object
mmp.processclearing.request
object
3 properties
3 required
mmp.processclearing.response
object
mmp.finishvalidation.request
object
3 properties
3 required
mmp.finishvalidation.response
object
mmp.finalizecashout.request
object
3 properties
3 required
mmp.finalizecashout.response
object
mmp.validate.request
object
3 properties
3 required
mmp.validate.response
object
checkcashing.authorize.request
object
3 properties
3 required
checkcashing.authorize.response
object
checkcashing.validate.request
object
3 properties
3 required
checkcashing.validate.response
object
checkcashing.finishvalidation.request
object
3 properties
3 required
checkcashing.finishvalidation.response
object
checkcashing.processclearing.request
object
3 properties
3 required
checkcashing.processclearing.response
object
checkcashing.authorizecashout.request
object
3 properties
3 required
checkcashing.authorizecashout.response
object
checkcashing.finalizecashout.request
object
3 properties
3 required
checkcashing.finalizecashout.response
object
checkcashing.finalize.request
object
3 properties
3 required
checkcashing.finalize.response
object
zpk.exchange.request
object
2 properties
2 required
zpk.exchange.response
object
getPreferencesRequest
object
3 properties
3 required
getPreferencesResponse
object
setPreferencesRequest
object
3 properties
3 required
setPreferencesResponse
object
currencyExchangeRates.request
object
3 properties
3 required
currencyExchangeRates.response
object
ExtendedResponse
object
2 properties
1 required
ResponseCode
string
ExtendedResponseCode
string
Extended Response Code Mapping
ExtendedResponseMessage
string
Extended Response Message
PointOfInteraction
object
11 properties
Card
object
4 properties
1 required
CardPan
object
7 properties
1 required
BestMatchedElement
string
Best matched element for Consumer Identification
EMVTagData
object
2 properties
EMVTags
string
Check
object
5 properties
1 required
Pin
object
3 properties
1 required
CheckIssuerDetails
object
13 properties
OfacSearch
object
12 properties
1 required
AccountMovements
object
9 properties
3 required
Cards
array
AccountHold
object
7 properties
6 required
AccountStop
object
8 properties
7 required
AccountRef
object
The account on which the transaction is to be performed.
4 properties
2 required
AccountRefFee
object
The account in which fee transactions are to be performed.
4 properties
1 required
AccountRefConsumerIdentify
object
4 properties
Amount
object
The basic type of an amount. Always an unsigned value. The host must perform operations on this value as per the context of the transaction. e.g. For a withdra…
2 properties
2 required
AmountForeign
object
The basic type of an amount.
2 properties
2 required
ConsumerId
string
A unique identifier of a consumer
accountListRequest
object
3 properties
3 required
transactionConfirmationResponse
object
transactionConfirmationResponseUpdatedBalance
object
transferConfirmationResponseUpdatedBalance
object
accountListResponse
object
consumerIdentifyResponse
object
ConsumerLevel
string
The consumer level
PhoneNumber
object
2 properties
2 required
ConsumerType
string
Type of the consumer
ConsumerProfile
object
13 properties
3 required
AccountType
string
| Symbolic name | Comment | |----------------------------|----------------------------------------------------------------| | UNSPECIFIED | Default value for u…
AccountSubType
string
Represents the SubType of an account for AccountType
AccountScopeInformation
string
The scope from where the the account list has to be returned in response
AccountOwnership
string
AccountStatus
string
The status of the account
AccountName
string
The account name which is displayed to the user
CheckType
string
The Check Type value of the check
AccessPermission
string
The Access permission of the Account
AccountPermissions
object
2 properties
Conductor
object
6 properties
2 required
Amounts
array
AccountAmount
object
3 properties
AccountAmountType
string
Amount types for account
PaymentType
string
Payment type
PaymentSubType
string
Payment subtype
LoanType
string
All the possible account types for LOAN Accounts
Loan
object
Loan balance to be represented in amounts as LOANBALANCE, INTERESTAMOUNT, REGULARPAYMENTAMOUNT, REGULARPAYMENTDUE, PRINCIPLEBALANCE, MINIMUMAMOUNTDUE, LASTPAYM…
2 properties
Credit
object
Credit amounts to be represnted in amounts as CREDITLIMIT, AVAILABLECREDIT, LASTCHARGEDUE, INTERESTPAIDYEARTODATE, INTERESTPAIDPREVIOUSYEARTODATE, INTERESTAMOU…
1 property
Payment
object
Payment amounts to be represnted in amounts as REGULARPAYMENTAMOUNT, REGULARPAYMENTDUE, PRINCIPALBALANCE, PAYOFFAMOUNT, LASTPAYMENTAMOUNT
4 properties
AccountListWarning
object
4 properties
3 required
Warning
object
5 properties
2 required
AccountInfo
object
AccountInformationBase
object
8 properties
3 required
PreferencesMap
object
3 properties
AdditionalProperties
object
Additional properties can be provided within this object
SupplementaryData
object
Additional information incorporated as an extension to the message by mixins based on the transaction type
Date
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 date of month
ValueDate
string
Refers to some future point in time at which the value of an account or transaction becomes effective
MaxRecords
integer
Maximum number of records to fetch
Address
object
5 properties
TransactionMetaData
object
9 properties
1 required
TransactionTypes
string
Type of Transaction or BusinessCase performed
TransactionFee
object
5 properties
4 required
TransactionFeeAmountOnly
object
1 property
1 required
FeeType
string
FeeState
string
Channel
string
Channel through which transaction is initiated.
Device
object
ATM Device
2 properties
1 required
AccountingState
string
Outcome of the transaction at the acceptor
MediaStates
array
MediaState
string
The state of the media
HoldType
string
Type of Hold on Account
StopHoldType
string
Specifies if this is a hold or a stop payment
MediaType
string
The type of media
CancelReason
string
Reason for cancellation
DenomCounter
object
Denomination Counter
14 properties
PhysicalType
string
Type of documents
DeviceChangeType
string
Device Change type
CassCounter
object
3 properties
CassCounterChangeReason
string
CardHandlingIndicator
string
Card Handling Indicator
AlternateAmounts
object
2 properties
ClearingType
string
Clearing Type
ClearingState
string
Clearing State of the inserted media
HostResponseData
object
Host Response details
3 properties
TransactionId
string
Unique transaction identifier
SplitDeposit
object
Account and Amount data for Split Deposit processing
2 properties
2 required
CheckDetailsWithImage
object
CheckImage
object
Check Image
2 properties
1 required
ImageType
string
ImageType of the check
CheckDetails
object
Details of checks
25 properties
1 required
HostSumAmount
object
The amount set by the host system if some checks are denied and the total amount is decreased by this decision
HostCashBackAmount
object
The amount set by the host system if some checks are denied and the cashback amount is decreased by this decision
HostCheckAmount
object
The amount set by the host system if some checks are denied and the total check amount is decreased by this decision
CheckLimit
object
Amount limit for check in the transaction
CashInLimit
object
Amount limit for cash in the transaction
CheckAmount
object
The check amount of the transaction
CashInAmount
object
The cash amount of the transaction
PayableAmount
object
The amount which may be payed on this check
UserAmount
object
The amount which is entered by the User
ValidatedAmount
object
Amount which has been validated
MICRAmount
object
Amount read from the MICR line
CourtesyAmount
object
Amount read by Optical Character Recognition (OCR) from the check image
CreditAmount
object
The balance amount of the transaction to be credited to the consumer
CreditAmountCC
object
The balance amount of the transaction to be credited to the consumer, calculated as (checkAmount - requestedAmount - feeAmount)
DebitAmount
object
The amount of the transaction to be debited from the consumer's account when the amount being paid is less than the payment amount being requested
DispensedAmount
object
The total dispensed amount
CashBackAmount
object
The amount to be encashed from the check
RequestedAmount
object
The amount requested for this transaction
RequestedAmountFinalizeCashOut
object
The amount that was authorized for cashout
CheckValidationTransactionId
string
Identifier for check validation
RejectedBy
string
Indicates who has rejected the check
Deleted
boolean
Flag to indicate that the check is rejected or must be returned to the consumer
CheckState
string
State of the check
ScheduledDate
string
Date when the transaction is scheduled
ProcessClearingResponseCheck
object
Details of checks
4 properties
1 required
ValidateResponseCheck
object
TargetAccount
object
The account to which the amount has to be credited
SourceAccount
object
The account from which the payment amount has to be deducted
AccountForUndispensedAmount
object
The account to which the undispensed amount has to be credited in case of a) Dispense failure (identified through mediaStates) b) Partial dispense
AccountCC
object
The account to which the creditAmount has to be credited
AccountMMP
object
The account to which the creditAmount has to be credited or the debitAmount has to be debited
KeyZoneId
string
Zone-id for which the key is requested
KeyType
string
Type of the key requested
KeyName
string
Name of the key requested
KeyCheckValue
string
Key check value
KeyGenerationIndex
string
Key generation Index
KeyData
string
Hex Encoded value of key
Currency
string
Currency code
BaseCurrency
string
Currency code of the base currency
SourceCurrency
string
Currency code of the source currency
CurrencyForeign
string
Currency code of the foreign currency
RequestedCurrency
string
Currency code of the requested currency
ConsumerAccountCurrency
string
Currency code of the consumer account
TargetCurrency
string
Currency code of the target currency
CurrencyExchangeRate
object
Currency exchange rate
7 properties
4 required
ForeignCurrencyConversion
object
4 properties
4 required
DynamicCurrencyConversion
object
6 properties
4 required
DynamicCurrencyConversionState
string
In the request, this field defines whether DCC has been confirmed or declined by the consumer. In the response, this field defines whether dynamic currency con…
ForeignCurrencyConversionState
string
In the request, this field defines whether the consumer accepted or declined the FCC. In the response, this field defines whether a confirmation is required or…
IsStandin
boolean
Standin request indicator
TransactionBase
object
8 properties
3 required
TransactionWithStandin
object
AddressPOI
object
PreferenceScope
string
The scope for the list of customer preferences
ConsumerPreferences
object
Consumer preferences containing preferences for a specific scope
2 properties
2 required
ConsumerPreferencesLoad
object
Consumer preferences
1 property
1 required
PreferenceKeyValueType
object
Consumer preferences of simple-type stored in key-value-type format
3 properties
3 required
PreferenceKeyValueMap
object
Consumer preferences of complex type stored in key-value-type format. The type is HashMap and the value is a complex object.
3 properties
3 required
PreferenceKeyValueList
object
Consumer preferences of list type stored in key-value-type format. The type is ArrayList and the value is a list of objects
3 properties
3 required
PreferenceKey
string
The name of this preference
PreferenceTypeEnum
string
The type of this preference
ClientTransactionDate
string
In Local Timezone For 'selfService' channel, the local month and day the transaction takes place. For 'network' channel, data element DE13 - the local month an…
ClientTransactionTime
string
In Local Timezone For 'selfService' channel, the local time the transaction takes place. For 'network' channel, data element DE12 - the local time the transact…
PointOfInteractionSettlementDate
string
In Local Timezone For 'selfService' channel, ATM booking date for the transaction. For 'network' channel, data element DE15 - the month and day funds are trans…
ClearingCategoryCode
string
Defines type of transaction clearing IMED/MEMO
CurrencyExchangeRatePairs
object
3 properties
2 required
NotSupportedCurrencyExchangeRatePairs
object
The currency pairs for which exchange rates are requested but not supported. This field is always populated with requested currency pairs for which exchange ra…
CurrencyExchangeRateDefs
object
Currency exchange rate details for supported currencies
7 properties
7 required
CurrencyExchangeRateCategory
string
The category of this currency exchange
exchangeKeyRequest
object
signedJwt property represents the signed Jwt Token containing the TM public key
1 property
1 required
exchangeKeyResponse
object
EnvelopeRequest
object
The Envelope has a payload property which represents an encrypted JSON string of the actual request object.
1 property
1 required
EnvelopeResponse
object
The response data is contained in the Envelope's property payload as encrypted
1 property
1 required
Envelope
object
Object holding a cryptographically secured properties.
3 properties
3 required
AccountHoldResponse
object
FundTypeCode
string
CheckWithAmount
object
ConfirmationNumber
string
The unique identifier for the transaction
MemberBanks
object
2 properties
2 required
MemberBankId
string
Id of the member bank
ClientType
string
The type of the hardware terminal device
NetworkId
string
Id of the acquiring network (scheme specific)
DateTime
string
The date and time expressed in the pattern 'yyyy-MM-dd'T'HH:mm:ssZ', where yyyy is 4-digit year, MM is 2-digit month, dd is 2-digit date of month, HH is hours,…
MerchantCategory
string
Identifier representing the merchant's type of business product or service
TransactionResponse
object
Exact replica of the request 'transaction' object which must be returned by the host
AddCashTotalAmount
object
A sum of all level 3 and level 4 amounts
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Banking#Payments#ATM#Self-Service#Transaction Middleware#Vynamic#Core Banking#Open API
Where this information came from
This is an independent, third-party profile of DN Open Backend 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.