How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Deutsche Bank Forms API

The Forms API contains endpoints to initialize a form service interaction. It allows the merchant to redirect the customer to a customizable frontend page where the customer may enter sensitive payment data. After receipt of the necessary information, the frontend will carry out the transaction and redirect the customer back to the merchant’s page.

Deutsche Bank Forms API is one of 50 APIs that Deutsche Bank publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Forms. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 17 operations across 17 paths, and defines 96 schemas. It is described by OpenAPI 3.2.0, at version v2.1.

Requests are made against a single base URL, https://testmerch.directpos.de/rest-api/services/v2.1/.

17 operations 17 paths 96 schemas 17 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2.1
Base URL
https://api.db.com/gw/dbapi
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Deutsche Bank Forms API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 17

Across 17 paths, the API surfaces 17 operations — 17 POST. Each is listed below with its method, path, parameters, and response codes.

Forms 17

The Forms API contains endpoints to initialize a form service interaction. It allows the merchant to redirect the customer to a customizable frontend page where the customer may e…

POST
/form/alias/bankaccount
Creates a form to enter bank account data and create an alias for it
formAliasBankAccountPost 1 param body → 400401200
POST
/form/alias/creditcard
Creates a form to enter credit card data and create an alias for it
formAliasCreditCardPost 1 param body → 400401200
POST
/form/alias/klarna
Creates an authorization form for a Klarna payment alias
formAliasKlarnaPost 1 param body → 400401200
POST
/form/event/{event_id}/checkout/{tx_action}
Creates a redirect to a checkout page where the customer may choose one of the…
formCheckoutPost 3 params body → 400401200
POST
/form/event/{event_id}/creditcard/{tx_action}
Creates a form to enter credit card data and then proceed with the transaction…
formCreditCardPost 3 params body → 400401200
POST
/form/event/{event_id}/directdebit/{tx_action}
Creates a form to enter bank account data and then proceed with an SDD…
formDirectDebitPost 3 params body → 400401200
POST
/form/event/{event_id}/giropay/{tx_action}
Initializes a giropay transaction (payment, avs, or avspayment)
formGiropayInitPost 3 params body → 400401200
POST
/form/event/{event_id}/klarna/{tx_action}
Initializes a Klarna transaction (pre-authorization or authorization)
formKlarnaInitPost 3 params body → 400401200
POST
/form/event/{event_id}/p24
Initializes a Request to P24 transaction (authorization)
formP24Post 2 params body → 400401200
POST
/form/event/{event_id}/psd2/authorization
Initializes a PSD2 payment transaction (authorization)
formPSD2AuthorizationPost 2 params body → 400401200
POST
/form/event/{event_id}/psd2/reversal
Initializes a cancellation (reversal) of a PSD2 future dated payment
formPSD2ReversalPost 2 params body → 400401200
POST
/form/event/{event_id}/paypal/{tx_action}
Initializes a PayPal transaction (pre-authorization or authorization)
formPayPalInitPost 3 params body → 400401200
POST
/form/event/{event_id}/paydirekt/{tx_action}
Initializes a paydirekt transaction (pre-authorization, authorization)
formPaydirektInitPost 3 params body → 400401200
POST
/form/event/{event_id}/psd2/account_info
Initializes a PSD2 account information transaction
formPsd2AccountInfoPost 2 params body → 400401200
POST
/form/event/{event_id}/credittransfer
Initializes a Request to Pay transaction (authorization)
formRequestToPayPost 2 params body → 400401200
POST
/form/event/{event_id}/sofort
Initializes a Sofortüberweisung transaction (authorization)
formSofortUeberweisungInitPost 2 params body → 400401200
POST
/form/event/{event_id}/wechatpay
Initializes a Request to WeChat Pay transaction (authorization)
formWeChatPayPost 2 params body → 400401200

Schemas 96

The contract defines 96 schemas that model the data the API accepts and returns. The most detailed are RiskmanagementInfoResponse (28 properties), AccountInformation (18 properties), FormCheckoutRequest (18 properties), FormCreditCardRequest (17 properties). Each schema is shown below with its type and property counts.

FormLabel
object
Custom label to be displayed in the form instead of the standard text.
2 properties 2 required
PhoneContact
object
A means of contacting a customer by phone.
2 properties 2 required
FormPayPalRequest
object
11 properties 1 required
FormCreditCardData
object
Base credit card for a form service interaction.
5 properties
RiskCheckTravelInformation
object
Travel information of the order.
7 properties
FormResponse
object
Values required to initialize a form interaction. Contains a reference to the created transaction.
4 properties 2 required
FormDirectDebitRequest
object
Request data to initialize a form service direct debit interaction.
17 properties 1 required
RiskCheckMerchantDefinedInformation
object
Merchant defined information of the order. This must not be used to capture personally identifying information.
2 properties
AliasAction
object
Specifies an alias and an operation to perform on it.
2 properties 1 required
TransactionCreditCardInfo
object
5 properties
BankAccount
object
Information about a bank account.
4 properties 1 required
FormSofortUeberweisungRequest
object
10 properties 1 required
CreditCardInfo
object
Information about a credit card.
5 properties 2 required
ErrorModel
object
Includes data returned in case of an error.
2 properties 2 required
RiskmanagementTravelInformationLeg
object
Information about a leg of the complete journey.
4 properties
BasketItemKlarnaData
object
Service specific basket item fields for Klarna related use cases.
3 properties
RiskmanagementTravelInformationPassenger
object
Information about a passenger.
2 properties
Callback
object
Data for the shop notification.
3 properties
FormCheckoutRequest
object
Request data that is being used after selecting a payment method on the checkout page.
18 properties 1 required
FormPSD2ReversalRequest
object
Request data to initialize a form service interaction.
9 properties 1 required
FormPSD2AuthorizationRequest
object
Request data to initialize a form service interaction.
10 properties 1 required
FormKlarnaRequest
object
11 properties 1 required
Basket
object
A generalized shopping basket.
8 properties
AlternativeAddressData
object
Alternative address fields.
2 properties
RiskCheckPassenger
object
A (plane) passenger as modelled from the point of view of a risk check service.
8 properties
TDS20Data
object
3-D Secure data. Activates 3-D Secure processing if values are set.
5 properties
WeChatPayResponse
object
13 properties 2 required
FormPSD2PaymentData
object
Data to initialize a PSD2 payment form service interaction.
4 properties
FormCustomerContinuation
object
Includes data for redirecting a customer after a form service payment.
4 properties 1 required
TransactionBankAccountInfo
object
1 property
AddressPaydirektData
object
Paydirekt specific address fields.
1 property
MerchantInformationExtensions
object
Service specific merchant information fields.
1 property
FormData
object
Data to customize forms with labels, theme, style properties etc.
4 properties
KlarnaProductIdentifier
object
Klarna specific unique identification attributes of a product.
4 properties
PaymentResponse
object
12 properties 5 required
PSD2TransactionFilter
object
Contains properties to filter the transactions if requesteddetails includes TRANSACTIONS. If bookingstatus is not submitted BOOKED transactions will be request…
3 properties
FormThemeProperty
object
Custom theme property to be displayed in the form instead of the standard presentation.
2 properties 2 required
FormRegisterAliasKlarnaRequest
object
10 properties 4 required
BasketExtensions
object
Service specific basket fields.
1 property
BasketItemRiskCheckData
object
Service specific basket item fields for riskcheck related use cases.
7 properties
EnhancedMandate
object
12 properties 2 required
FormRequestToPayRequest
object
10 properties 1 required
FormCreditCardRequest
object
Request data to initialize a form service interaction.
17 properties 1 required
BasketPayPalData
object
Service specific basket fields for PayPal.
1 property
FormPaydirektData
object
Data to initialize a paydirekt form service interaction.
3 properties
FormPSD2AccountInfoRequest
object
Includes data to find a customer's bank account details.
8 properties 1 required
Quantity
object
A quantity.
2 properties 2 required
BasketItem
object
A purchasable item that is part of a shopping basket's list of items.
7 properties
FormGiropayData
object
Data to initialize a giropay form service interaction.
2 properties
PersonalIdentification
object
Customer's legal ID data.
3 properties
MerchantInformation
object
5 properties
CommonAddress
object
Address data as applicable to most use cases.
14 properties
CustomerExtensionPayPalData
object
PayPal specific customer information fields.
2 properties
CustomerInformation
object
Details of a customer.
7 properties
DeviceInformation
object
Technical details of a client.
14 properties
CustomerInformationExtensions
object
Service specific customer information fields.
1 property
AccountInformation
object
Information on a user's account usage, payment history, transaction statistics.
18 properties
AmountCurrency
object
An amount and a currency.
2 properties 2 required
FormDirectDebitData
object
Data to initialize a direct debit form service interaction.
5 properties 1 required
FormPaydirektRequest
object
10 properties 1 required
FormNoTxResponse
object
Values required to initialize a form interaction.
3 properties 2 required
ExpiryDate
object
The credit card expiry date.
2 properties 2 required
RiskCheckAdditionalInformation
object
Additional information for calculation of the risk of a transaction.
1 property
CommonAddressExtensions
object
Service specific address fields.
2 properties
GiropayLabelledText
object
Additional line of text that will be included into the giropay login page.
2 properties 2 required
FormRegisterAliasRequest
object
Request data to register a means of payment alias using the form service.
4 properties 1 required
TaxInfo
object
Legal tax information of the payer.
2 properties 2 required
Contacts
object
Means of contacting the customer.
1 property
FormGiropayRequest
object
11 properties 1 required
AliasInfo
object
Contains information about the created or updated alias. This field is null if the there was no 'aliasinfo' in the request.
4 properties
TDS20Address
object
Address data for 3DS 2.0 transactions.
8 properties 4 required
RiskmanErrorFieldInformation
object
Field name and reason why the request was rejected.
2 properties
MerchantInformationKlarnaData
object
Klarna specific MerchantInformation fields.
1 property
MandateResponse
object
2 properties 1 required
FormCheckoutConfiguration
object
Contains required and optional data for each payment method that should be offered.
11 properties 1 required
TDS20PhoneNumber
object
Phone number with country code.
2 properties
TDSInfo
object
Contains 3-D Secure response data. The use of this field requires an explicit activation. Please contact customer support.
16 properties
TDS20CustomerData
object
8 properties
FormPayPalData
object
Data to initialize a PayPal form service interaction.
1 property
TransactionInfo
object
6 properties
FormKlarnaData
object
Data to initialize a Klarna form service interaction. Currently contains no fields. See the user guide for when to generate this object.
TaxedAmountCurrency
object
Net and gross money amount accompanied by a tax percentage and currency.
4 properties 4 required
FormRequestToPayData
object
Data to initialize a request to pay form service interaction.
3 properties
FormP24Request
object
Request data that is being used for P24 transaction init.
10 properties 1 required
FormCheckoutCreditCardData
object
Base credit card data to initialize a form checkout service interaction.
5 properties
BasketItemExtensions
object
Service specific basket item fields.
3 properties
RiskmanErrorInformation
object
Detailed error information including fields which had been the reasons for unsuccessful processing.
4 properties
BasketItemPayPalData
object
Service specific basket item fields for PayPal.
1 property 1 required
TDS20CardHolderAccountInfo
object
17 properties
TDS20CommunicationData
object
2 properties
TDS20TransactionAttributes
object
4 properties
FormWeChatPayRequest
object
Request data that is being used for WeChat Pay transaction init.
10 properties 1 required
FormPSD2ReversalResponse
object
6 properties 3 required
FormSofortUeberweisungData
object
Data to initialize a Sofortüberweisung form service interaction.
1 property
MerchantRiskIndicators
object
9 properties
RiskmanagementInfoResponse
object
28 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deutsche-bank-forms-api-openapi.yml Raw ↑

Other APIs Deutsche Bank publishes across the network.

Deutsche Bank Alias API
Deutsche Bank Apple Pay API
Deutsche Bank Authorization API
Deutsche Bank Callback API
Deutsche Bank Cancel SEPA Credit Transfers API
Deutsche Bank Cancel SEPA Instant Credit Transfers API
Deutsche Bank Cash account opening status API
Deutsche Bank Cash Account Openings API
Deutsche Bank Cash Accounts API
Deutsche Bank Create SEPA Credit Transfers API
Deutsche Bank Create SEPA Instant Credit Transfers API
Deutsche Bank Employee Share Plan Securities Account Opening API
Where this information came from

This is an independent, third-party profile of Deutsche Bank Forms 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.