{ "openapi" : "3.0.1", "info" : { "title" : "Merchant-Server II REST Services API", "version" : "v2.1" }, "servers" : [ { "url" : "https://testmerch.directpos.de/rest-api/services/v2.1/" } ], "security" : [ { "bearerAuth" : [ ] } ], "tags" : [ { "name" : "Alias", "description" : "The alias API contains endpoints to add, update or delete aliases for means of payment." }, { "name" : "Apple Pay", "description" : "The Apple Pay™ API contains endpoints to initiate a payment session to perform credit card payment transactions based on Apple Pay™ payment information." }, { "name" : "eScore", "description" : "The eScore API contains endpoints to minimize non-payment risk." }, { "name" : "Forms", "description" : "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." }, { "name" : "Google Pay", "description" : "The Google Pay™ API contains endpoints to perform credit card payment transactions based on Google Pay™ payment information." }, { "name" : "Headless 3-D Secure", "description" : "The Headless 3-D Secure API contains endpoints to conduct headless 3-D Secure transactions." }, { "name" : "iFrame", "description" : "The iFrame API contains an endpoint to initialize an iFrame interaction. It allows the merchant to embed specific elements of a frontend page into their own web page. Entry of sensitive data is done in these elements so that they can be sent to the merchant without the merchant ever being in contact with it. After the API receives the entered data, it will inform the merchant who then calls the corresponding Payment API endpoint. " }, { "name" : "Info", "description" : "Information related operations." }, { "name" : "Managed Mandate", "description" : "The Managed Mandate API contains endpoints to work with managed mandates." }, { "name" : "Payment", "description" : "The Payment API contains endpoints to add or modify payment transactions. When using the API, the merchant is only integrated to the API at the backend. All use cases are triggered via an API call. It is the merchant's responsibility to collect all relevant payment data via their own frontend. " }, { "name" : "Payment Link", "description" : "The Payment Link API contains endpoints to prepare payments your customers can carry out later by using the provided link." }, { "name" : "Risk Management", "description" : "The Risk Management API contains endpoints to add and remove risk list entries and to calculate a risk score." } ], "paths" : { "/alias/bankaccount/{alias}" : { "get" : { "tags" : [ "Alias" ], "summary" : "Retrieves a bank account alias by its name.", "operationId" : "aliasBankAccountGet", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "alias", "in" : "path", "description" : "Name of the alias.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" }, "example" : "da2c9029-b180-42a7-b473-50d182a01f8a" } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, accompanied by information about the alias. Sensitive bank account data may be masked, depending on the configuration of the merchant's account. If the alias is unknown or in case of a known business or persistence error, only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AliasResponse" } } } } } }, "delete" : { "tags" : [ "Alias" ], "summary" : "Deletes a bank account alias.", "operationId" : "aliasBankAccountDelete", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "alias", "in" : "path", "description" : "Name of the alias.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" }, "example" : "da2c9029-b180-42a7-b473-50d182a01f8a" } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, indicating whether or not the operation was successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } } } } }, "patch" : { "tags" : [ "Alias" ], "summary" : "Updates the address attached to a bank account alias.", "description" : "In most SEPA countries, address data is not required for payment processing. However, some countries require addresses in addition to means of payment data for successful authorization. This endpoint provides functionality to update this address data.", "operationId" : "aliasBankAccountAddressPatch", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "alias", "in" : "path", "description" : "Name of the alias.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" }, "example" : "da2c9029-b180-42a7-b473-50d182a01f8a" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CommonAddress" }, "examples" : { "sample21" : { "summary" : "Sample SEPA address.", "description" : "Sample SEPA address.", "value" : { "address_line_1" : "Rohrteichstr 18", "postalCode" : "98765", "city" : "newCity", "country" : "DE" } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, accompanied by information about the updated alias. Sensitive bank account data may be masked, depending on the configuration of the merchant's account. If the alias was unknown or in case of a known business or persistence error, only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AliasResponse" } } } } } } }, "/alias/bankaccount" : { "post" : { "tags" : [ "Alias" ], "summary" : "Creates a new bank account alias.", "description" : "Clients may specify a bank account alias themselves by submitting the desired value in the alias field. If the alias field is left blank, an alias will be generated. Bank account aliases may also be created during payment processing. The bank account field of the request requires an iban to be present. All other fields are optional. In most SEPA countries, address data is not required for payment processing. However, some countries require addresses in addition to means of payment data for successful authorization. This is why this endpoint provides an option to specify additional address data which will be stored along with the new alias if present. Bank accounts and aliases have a 1:1 relation, that is if an alias is assigned to a bank account creating another alias for the same bank account results in an error, as does assigning an existing alias to another bank account.", "operationId" : "aliasBankAccountCreatePost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AliasBankAccountRequest" }, "example" : { "alias" : "example-dd-alias", "bank_account" : { "iban" : "DE39123456790009290701", "account_holder" : "Rene Holder" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, accompanied by information about the created alias. Sensitive bank account data may be masked, depending on the configuration of the merchant's account. In case of a known business or persistence error, only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AliasResponse" } } } } } } }, "/alias/bankaccount/get" : { "post" : { "tags" : [ "Alias" ], "summary" : "Retrieves a bank account alias by bank account data.", "description" : "Due to security reasons, this is a _GET with body payload_ (see https://opensource.zalando.com/restful-api-guidelines/#get-with-body) operation. No resources will be created.", "operationId" : "aliasBankAccountGetPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BankAccount" }, "example" : { "iban" : "DE39123456790009290701", "account_holder" : "Rene Holder" } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, accompanied by information about the alias. Sensitive bank account data may be masked, depending on the configuration of the merchant's account. In case of a known business or persistence error, only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AliasResponse" } } } } } } }, "/alias/creditcard" : { "post" : { "tags" : [ "Alias" ], "summary" : "Creates a new credit card alias.", "description" : "Clients may specify a card number alias themselves by submitting the desired value in the alias field. If the alias field is left blank, an alias will be generated. Card number aliases may also be created during payment processing. The credit card field of the request requires a number and an expiry date to be present. All other fields are optional. Credit cards and aliases have a 1:1 relation, that is if an alias is assigned to a credit card creating another alias for the same card results in an error, as does assigning an existing alias to another credit card.", "operationId" : "aliasCreditCardCreatePost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AliasCreditCardRequest" }, "example" : { "alias" : "example-cc-alias", "credit_card" : { "number" : "4111111111111111", "code" : "123", "cardHolder" : "Card T. Holder", "expiry_date" : { "year" : 2029, "month" : 11 } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, accompanied by information about the created alias. Sensitive credit card data may be masked, depending on the configuration of the merchant's account. In case of a known business or persistence error, only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AliasResponse" } } } } } } }, "/alias/creditcard/{alias}" : { "get" : { "tags" : [ "Alias" ], "summary" : "Retrieves a credit card alias by its name.", "operationId" : "aliasCreditCardGet", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "alias", "in" : "path", "description" : "Name of the alias.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" }, "example" : "da2c9029-b180-42a7-b473-50d182a01f8a" } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, accompanied by information about the alias. Sensitive credit card data may be masked, depending on the configuration of the merchant's account. In case of a known business or persistence error, only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AliasResponse" } } } } } }, "delete" : { "tags" : [ "Alias" ], "summary" : "Deletes a credit card alias.", "operationId" : "aliasCreditCardDelete", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "alias", "in" : "path", "description" : "Name of the alias.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" }, "example" : "da2c9029-b180-42a7-b473-50d182a01f8a" } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, indicating whether or not the operation was successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } } } } } }, "/alias/creditcard/get" : { "post" : { "tags" : [ "Alias" ], "summary" : "Retrieves a credit card alias by credit card data.", "description" : "Due to security reasons, this is a _GET with body payload_ (see https://opensource.zalando.com/restful-api-guidelines/#get-with-body) operation. No resources will be created.", "operationId" : "aliasCreditCardGetPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreditCard" }, "example" : { "number" : "4111111111111111", "code" : "123", "cardHolder" : "Card T. Holder", "expiry_date" : { "year" : 2029, "month" : 11 } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, accompanied by information about the alias. Sensitive credit card data may be masked, depending on the configuration of the merchant's account. If the credit card data did not match a known credit card or in case of a known business or persistence error, only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AliasResponse" } } } } } } }, "/alias/{alias}" : { "get" : { "tags" : [ "Alias" ], "summary" : "Retrieves a credit card or bank account alias by its name.", "description" : "This is a generalized variant of the other GET alias endpoints of this API. May be used by clients that cannot or do not want to decide on the type of alias to be retrieved.", "operationId" : "aliasGet", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "alias", "in" : "path", "description" : "Name of the alias.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" }, "example" : "da2c9029-b180-42a7-b473-50d182a01f8a" } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, accompanied by information about the alias. Depending on the type of means of payment this alias is connected to, the appropriate fields will be set in the response. Sensitive means of payment data may be masked, depending on the configuration of the merchant's account. If the alias is unknown or in case of a known business or persistence error, only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AliasResponse" } } } } } }, "delete" : { "tags" : [ "Alias" ], "summary" : "Deletes a credit card or bank account alias.", "description" : "This is a generalized variant of the other DELETE alias endpoints of this API. May be used by clients that cannot or do not want to decide on the type of alias to be deleted.", "operationId" : "aliasDelete", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "alias", "in" : "path", "description" : "Name of the alias.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" }, "example" : "da2c9029-b180-42a7-b473-50d182a01f8a" } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, indicating whether or not the operation was successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } } } } } }, "/applepay/paymentSession/{event_id}" : { "post" : { "tags" : [ "Apple Pay" ], "summary" : "Perform payment session requests based on Apple Pay™ data.", "operationId" : "applepayPaymentSessionPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApplePayPaymentSessionRequest" }, "examples" : { "ApplePayPaymentSessionRequest" : { "summary" : "Sample Apple Pay™ Payment Session Request", "description" : "ApplePayPaymentSessionRequest", "value" : { "merchant_id" : "merchant.processingpagateq.merchantsolution", "initiative" : "web", "initiative_context" : "testmerch.directpos.de" } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Information about the outcome of the transaction.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApplePayPaymentSessionResponse" }, "examples" : { "sample_response_to_session_request_-_session_created" : { "summary" : "Session has been created, no further actions required.", "description" : "Session has been created, no further actions required.", "value" : { "applepay_payment_session_token" : "eyJlcG9jaFRpbWVzdGFtcCI6MTY1OTUyODYxMzQ5MywiZXhwaXJlc0F0IjoxNjU5NTMyMjEzNDkzLCJtZXJjaGFudFNlc3Npb25JZGVudGlmaWVyIjoiU1NIRjUyNTM0MUM1OTY1NDE4ODkwMkZBRDM0RDA2NEQ0OTZfNTE2OTYyRkI1NUYyNEQ2NTU5RTg2MkU5Nzk5OTJCRDI5RENGQTVEMkJBOEFEOEQ0RDg5M0Y4Mzc1OTYwODNDQSIsIm5vbmNlIjoiNGEyMWYzZjAiLCJtZXJjaGFudElkZW50aWZpZXIiOiIyODczMkE0RjA1QUUwNTU1MDA3NzY0MkNDNkJBQkE4QzU5MjNFMzQ3QTA4MzgwM0MwQjdBODA4ODcxMEMzMUU0IiwiZG9tYWluTmFtZSI6InRlc3RtZXJjaC5kaXJlY3Rwb3MuZGUiLCJkaXNwbGF5TmFtZSI6IkRCLk1lcmNoYW50U29sdXRpb24uVGVzdE1lcmNoYW50Iiwic2lnbmF0dXJlIjoiMzA4MDA2MDkyYTg2NDg4NmY3MGQwMTA3MDJhMDgwMzA4MDAyMDEwMTMxMGYzMDBkMDYwOTYwODY0ODAxNjUwMzA0MDIwMTA1MDAzMDgwMDYwOTJhODY0ODg2ZjcwZDAxMDcwMTAwMDBhMDgwMzA4MjAzZTMzMDgyMDM4OGEwMDMwMjAxMDIwMjA4NGMzMDQxNDk1MTlkNTQzNjMwMGEwNjA4MmE4NjQ4Y2UzZDA0MDMwMjMwN2EzMTJlMzAyYzA2MDM1NTA0MDMwYzI1NDE3MDcwNmM2NTIwNDE3MDcwNmM2OTYzNjE3NDY5NmY2ZTIwNDk2ZTc0NjU2NzcyNjE3NDY5NmY2ZTIwNDM0MTIwMmQyMDQ3MzMzMTI2MzAyNDA2MDM1NTA0MGIwYzFkNDE3MDcwNmM2NTIwNDM2NTcyNzQ2OTY2Njk2MzYxNzQ2OTZmNmUyMDQxNzU3NDY4NmY3MjY5NzQ3OTMxMTMzMDExMDYwMzU1MDQwYTBjMGE0MTcwNzA2YzY1MjA0OTZlNjMyZTMxMGIzMDA5MDYwMzU1MDQwNjEzMDI1NTUzMzAxZTE3MGQzMTM5MzAzNTMxMzgzMDMxMzMzMjM1Mzc1YTE3MGQzMjM0MzAzNTMxMzYzMDMxMzMzMjM1Mzc1YTMwNWYzMTI1MzAyMzA2MDM1NTA0MDMwYzFjNjU2MzYzMmQ3MzZkNzAyZDYyNzI2ZjZiNjU3MjJkNzM2OTY3NmU1ZjU1NDMzNDJkNTA1MjRmNDQzMTE0MzAxMjA2MDM1NTA0MGIwYzBiNjk0ZjUzMjA1Mzc5NzM3NDY1NmQ3MzMxMTMzMDExMDYwMzU1MDQwYTBjMGE0MTcwNzA2YzY1MjA0OTZlNjMyZTMxMGIzMDA5MDYwMzU1MDQwNjEzMDI1NTUzMzA1OTMwMTMwNjA3MmE4NjQ4Y2UzZDAyMDEwNjA4MmE4NjQ4Y2UzZDAzMDEwNzAzNDIwMDA0YzIxNTc3ZWRlYmQ2YzdiMjIxOGY2OGRkNzA5MGExMjE4ZGM3YjBiZDZmMmMyODNkODQ2MDk1ZDk0YWY0YTU0MTFiODM0MjBlZDgxMWYzNDA3ZTgzMzMxZjFjNTRjM2Y3ZWIzMjIwZDZiYWQ1ZDRlZmY0OTI4OTg5M2U3YzBmMTNhMzgyMDIxMTMwODIwMjBkMzAwYzA2MDM1NTFkMTMwMTAxZmYwNDAyMzAwMDMwMWYwNjAzNTUxZDIzMDQxODMwMTY4MDE0MjNmMjQ5YzQ0ZjkzZTRlZjI3ZTZjNGY2Mjg2YzNmYTJiYmZkMmU0YjMwNDUwNjA4MmIwNjAxMDUwNTA3MDEwMTA0MzkzMDM3MzAzNTA2MDgyYjA2MDEwNTA1MDczMDAxODYyOTY4NzQ3NDcwM2EyZjJmNmY2MzczNzAyZTYxNzA3MDZjNjUyZTYzNmY2ZDJmNmY2MzczNzAzMDM0MmQ2MTcwNzA2YzY1NjE2OTYzNjEzMzMwMzIzMDgyMDExZDA2MDM1NTFkMjAwNDgyMDExNDMwODIwMTEwMzA4MjAxMGMwNjA5MmE4NjQ4ODZmNzYzNjQwNTAxMzA4MWZlMzA4MWMzMDYwODJiMDYwMTA1MDUwNzAyMDIzMDgxYjYwYzgxYjM1MjY1NmM2OTYxNmU2MzY1MjA2ZjZlMjA3NDY4Njk3MzIwNjM2NTcyNzQ2OTY2Njk2MzYxNzQ2NTIwNjI3OTIwNjE2ZTc5MjA3MDYxNzI3NDc5MjA2MTczNzM3NTZkNjU3MzIwNjE2MzYzNjU3MDc0NjE2ZTYzNjUyMDZmNjYyMDc0Njg2NTIwNzQ2ODY1NmUyMDYxNzA3MDZjNjk2MzYxNjI2YzY1MjA3Mzc0NjE2ZTY0NjE3MjY0MjA3NDY1NzI2ZDczMjA2MTZlNjQyMDYzNmY2ZTY0Njk3NDY5NmY2ZTczMjA2ZjY2MjA3NTczNjUyYzIwNjM2NTcyNzQ2OTY2Njk2MzYxNzQ2NTIwNzA2ZjZjNjk2Mzc5MjA2MTZlNjQyMDYzNjU3Mjc0Njk2NjY5NjM2MTc0Njk2ZjZlMjA3MDcyNjE2Mzc0Njk2MzY1MjA3Mzc0NjE3NDY1NmQ2NTZlNzQ3MzJlMzAzNjA2MDgyYjA2MDEwNTA1MDcwMjAxMTYyYTY4NzQ3NDcwM2EyZjJmNzc3Nzc3MmU2MTcwNzA2YzY1MmU2MzZmNmQyZjYzNjU3Mjc0Njk2NjY5NjM2MTc0NjU2MTc1NzQ2ODZmNzI2OTc0NzkyZjMwMzQwNjAzNTUxZDFmMDQyZDMwMmIzMDI5YTAyN2EwMjU4NjIzNjg3NDc0NzAzYTJmMmY2MzcyNmMyZTYxNzA3MDZjNjUyZTYzNmY2ZDJmNjE3MDcwNmM2NTYxNjk2MzYxMzMyZTYzNzI2YzMwMWQwNjAzNTUxZDBlMDQxNjA0MTQ5NDU3ZGI2ZmQ1NzQ4MTg2ODk4OTc2MmY3ZTU3ODUwN2U3OWI1ODI0MzAwZTA2MDM1NTFkMGYwMTAxZmYwNDA0MDMwMjA3ODAzMDBmMDYwOTJhODY0ODg2Zjc2MzY0MDYxZDA0MDIwNTAwMzAwYTA2MDgyYTg2NDhjZTNkMDQwMzAyMDM0OTAwMzA0NjAyMjEwMGJlMDk1NzFmZTcxZTFlNzM1YjU1ZTVhZmFjYjRjNzJmZWI0NDVmMzAxODUyMjJjNzI1MTAwMmI2MWViZDZmNTUwMjIxMDBkMThiMzUwYTVkZDZkZDZlYjE3NDYwMzViMTFlYjJjZTg3Y2ZhM2U2YWY2Y2JkODM4MDg5MGRjODJjZGRhYTYzMzA4MjAyZWUzMDgyMDI3NWEwMDMwMjAxMDIwMjA4NDk2ZDJmYmYzYTk4ZGE5NzMwMGEwNjA4MmE4NjQ4Y2UzZDA0MDMwMjMwNjczMTFiMzAxOTA2MDM1NTA0MDMwYzEyNDE3MDcwNmM2NTIwNTI2ZjZmNzQyMDQzNDEyMDJkMjA0NzMzMzEyNjMwMjQwNjAzNTUwNDBiMGMxZDQxNzA3MDZjNjUyMDQzNjU3Mjc0Njk2NjY5NjM2MTc0Njk2ZjZlMjA0MTc1NzQ2ODZmNzI2OTc0NzkzMTEzMzAxMTA2MDM1NTA0MGEwYzBhNDE3MDcwNmM2NTIwNDk2ZTYzMmUzMTBiMzAwOTA2MDM1NTA0MDYxMzAyNTU1MzMwMWUxNzBkMzEzNDMwMzUzMDM2MzIzMzM0MzYzMzMwNWExNzBkMzIzOTMwMzUzMDM2MzIzMzM0MzYzMzMwNWEzMDdhMzEyZTMwMmMwNjAzNTUwNDAzMGMyNTQxNzA3MDZjNjUyMDQxNzA3MDZjNjk2MzYxNzQ2OTZmNmUyMDQ5NmU3NDY1Njc3MjYxNzQ2OTZmNmUyMDQzNDEyMDJkMjA0NzMzMzEyNjMwMjQwNjAzNTUwNDBiMGMxZDQxNzA3MDZjNjUyMDQzNjU3Mjc0Njk2NjY5NjM2MTc0Njk2ZjZlMjA0MTc1NzQ2ODZmNzI2OTc0NzkzMTEzMzAxMTA2MDM1NTA0MGEwYzBhNDE3MDcwNmM2NTIwNDk2ZTYzMmUzMTBiMzAwOTA2MDM1NTA0MDYxMzAyNTU1MzMwNTkzMDEzMDYwNzJhODY0OGNlM2QwMjAxMDYwODJhODY0OGNlM2QwMzAxMDcwMzQyMDAwNGYwMTcxMTg0MTlkNzY0ODVkNTFhNWUyNTgxMDc3NmU4ODBhMmVmZGU3YmFlNGRlMDhkZmM0YjkzZTEzMzU2ZDU2NjViMzVhZTIyZDA5Nzc2MGQyMjRlN2JiYTA4ZmQ3NjE3Y2U4OGNiNzZiYjY2NzBiZWM4ZTgyOTg0ZmY1NDQ1YTM4MWY3MzA4MWY0MzA0NjA2MDgyYjA2MDEwNTA1MDcwMTAxMDQzYTMwMzgzMDM2MDYwODJiMDYwMTA1MDUwNzMwMDE4NjJhNjg3NDc0NzAzYTJmMmY2ZjYzNzM3MDJlNjE3MDcwNmM2NTJlNjM2ZjZkMmY2ZjYzNzM3MDMwMzQyZDYxNzA3MDZjNjU3MjZmNmY3NDYzNjE2NzMzMzAxZDA2MDM1NTFkMGUwNDE2MDQxNDIzZjI0OWM0NGY5M2U0ZWYyN2U2YzRmNjI4NmMzZmEyYmJmZDJlNGIzMDBmMDYwMzU1MWQxMzAxMDFmZjA0MDUzMDAzMDEwMWZmMzAxZjA2MDM1NTFkMjMwNDE4MzAxNjgwMTRiYmIwZGVhMTU4MzM4ODlhYTQ4YTk5ZGViZWJkZWJhZmRhY2IyNGFiMzAzNzA2MDM1NTFkMWYwNDMwMzAyZTMwMmNhMDJhYTAyODg2MjY2ODc0NzQ3MDNhMmYyZjYzNzI2YzJlNjE3MDcwNmM2NTJlNjM2ZjZkMmY2MTcwNzA2YzY1NzI2ZjZmNzQ2MzYxNjczMzJlNjM3MjZjMzAwZTA2MDM1NTFkMGYwMTAxZmYwNDA0MDMwMjAxMDYzMDEwMDYwYTJhODY0ODg2Zjc2MzY0MDYwMjBlMDQwMjA1MDAzMDBhMDYwODJhODY0OGNlM2QwNDAzMDIwMzY3MDAzMDY0MDIzMDNhY2Y3MjgzNTExNjk5YjE4NmZiMzVjMzU2Y2E2MmJmZjQxN2VkZDkwZjc1NGRhMjhlYmVmMTljODE1ZTQyYjc4OWY4OThmNzliNTk5Zjk4ZDU0MTBkOGY5ZGU5YzJmZTAyMzAzMjJkZDU0NDIxYjBhMzA1Nzc2YzVkZjMzODNiOTA2N2ZkMTc3YzJjMjE2ZDk2NGZjNjcyNjk4MjEyNmY1NGY4N2E3ZDFiOTljYjliMDk4OTIxNjEwNjk5MGYwOTkyMWQwMDAwMzE4MjAxOGMzMDgyMDE4ODAyMDEwMTMwODE4NjMwN2EzMTJlMzAyYzA2MDM1NTA0MDMwYzI1NDE3MDcwNmM2NTIwNDE3MDcwNmM2OTYzNjE3NDY5NmY2ZTIwNDk2ZTc0NjU2NzcyNjE3NDY5NmY2ZTIwNDM0MTIwMmQyMDQ3MzMzMTI2MzAyNDA2MDM1NTA0MGIwYzFkNDE3MDcwNmM2NTIwNDM2NTcyNzQ2OTY2Njk2MzYxNzQ2OTZmNmUyMDQxNzU3NDY4NmY3MjY5NzQ3OTMxMTMzMDExMDYwMzU1MDQwYTBjMGE0MTcwNzA2YzY1MjA0OTZlNjMyZTMxMGIzMDA5MDYwMzU1MDQwNjEzMDI1NTUzMDIwODRjMzA0MTQ5NTE5ZDU0MzYzMDBkMDYwOTYwODY0ODAxNjUwMzA0MDIwMTA1MDBhMDgxOTUzMDE4MDYwOTJhODY0ODg2ZjcwZDAxMDkwMzMxMGIwNjA5MmE4NjQ4ODZmNzBkMDEwNzAxMzAxYzA2MDkyYTg2NDg4NmY3MGQwMTA5MDUzMTBmMTcwZDMyMzIzMDM4MzAzMzMxMzIzMTMwMzEzMzVhMzAyYTA2MDkyYTg2NDg4NmY3MGQwMTA5MzQzMTFkMzAxYjMwMGQwNjA5NjA4NjQ4MDE2NTAzMDQwMjAxMDUwMGExMGEwNjA4MmE4NjQ4Y2UzZDA0MDMwMjMwMmYwNjA5MmE4NjQ4ODZmNzBkMDEwOTA0MzEyMjA0MjBjYWRlZWE1ODc3MTE1OTVlMTg5ZDNhOTUyMDBmMDdhZTQwNTE2M2JmNzA1MTk2MWRlMDk1NzY0ZGYyOTcxOTQzMzAwYTA2MDgyYTg2NDhjZTNkMDQwMzAyMDQ0NzMwNDUwMjIxMDA5MDUyMWYzNjJmYzk1ZGNiMDhhZjQxOTMyYTNkM2Y2YTNhYzVkNWFiZTIyMmYxY2YxZDAxMDNiMjM5MWI3MzEwMDIyMDYxMzZlYzJkNGQ2N2MwODZiZDRiYTA5YTJjZjMwODY1ZjJhYTM5NWMwODlmZTFkM2UwYWM4YTgzM2YwNjIwZDUwMDAwMDAwMDAwMDAiLCJvcGVyYXRpb25hbEFuYWx5dGljc0lkZW50aWZpZXIiOiJEQi5NZXJjaGFudFNvbHV0aW9uLlRlc3RNZXJjaGFudDoyODczMkE0RjA1QUUwNTU1MDA3NzY0MkNDNkJBQkE4QzU5MjNFMzQ3QTA4MzgwM0MwQjdBODA4ODcxMEMzMUU0IiwicmV0cmllcyI6MCwicHNwSWQiOiIyODczMkE0RjA1QUUwNTU1MDA3NzY0MkNDNkJBQkE4QzU5MjNFMzQ3QTA4MzgwM0MwQjdBODA4ODcxMEMzMUU0In0=", "rc" : "0", "message" : "success" }, "x-ApiExampleVersioning" : { "ApiExampleVersioningFirst" : "v2.1" } }, "sample_response_to_session_request_-_session_creation_failed" : { "summary" : "Session creation failed", "description" : "Session creation failed", "value" : { "rc" : "1547", "message" : " Payment Services Exception merchantId=28 not registered for domain=unknown.domain.com" }, "x-ApiExampleVersioning" : { "ApiExampleVersioningFirst" : "v2.1" } } } } } } } } }, "/applepay/pay/{event_id}/{tx_action}/initialize" : { "post" : { "tags" : [ "Apple Pay" ], "summary" : "Perform payment requests based on Apple Pay™ data.", "operationId" : "applepayPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "authorization", "preauthorization", "credit", "verify-mop" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApplePayPaymentRequest" }, "examples" : { "ApplePayPaymentRequest" : { "summary" : "Sample Apple Pay™ Request", "description" : "ApplePayPaymentRequest", "value" : { "means_of_payment" : { "applepay_token" : "eyJwYXltZW50RGF0YSI6eyJ2ZXJzaW9uIjoiRUNfdjEiLCJkYXRhIjoiYWJONTBPS0FNd1pUU0lJV2Z4VWpYWGhncVVZNTIrMlVnZWY4Q0VMUTg2QTE3eFJwdEdhTWFjWHhvNXl1Um1UVDFOb2Y3VERYeHFncHFkL2Mwa2l1OXZKcy9DcVNKUHZNUG9BbkJEemlYTGtDK0JnRFBJVERuMzFLTlVHU3dYQ1QrVkJZdy85cHVocVVvSWQwcU1QRzRUQ2E1cDBVc3k4VmkxN0g2bGpJaGhpdStKNXoxWWpsTTJBbXZtMmdxSUZ2WHRWdmJYbTBGL05tZDBqZWEvcUQ4UUNmQURJa0NkSHZwQWJic2gyTlVMbzFYbm1UNFlodFRjN1o5Zy9helVtMm9YTjZWdlRYYXY0SHhzZGJueERjN2tpWGo5U3VYYVN3anZudTdtS21uUG0zVXlQMkk2QWc1cDJZTGQ3dXg4bURpUmxQUG9WY0FLM0U4N2dxRU90a0lHUGRaM0JCZ1paOHNjaFlJQVRqR1p4aWI4aHRFNk1mcE1jV0VJdFlrVlZ5QzFIREpMcWdsY2VjRU1rUWhRPT0iLCJzaWduYXR1cmUiOiJNSUFHQ1NxR1NJYjNEUUVIQXFDQU1JQUNBUUV4RFRBTEJnbGdoa2dCWlFNRUFnRXdnQVlKS29aSWh2Y05BUWNCQUFDZ2dEQ0NBK013Z2dPSW9BTUNBUUlDQ0V3d1FVbFJuVlEyTUFvR0NDcUdTTTQ5QkFNQ01Ib3hMakFzQmdOVkJBTU1KVUZ3Y0d4bElFRndjR3hwWTJGMGFXOXVJRWx1ZEdWbmNtRjBhVzl1SUVOQklDMGdSek14SmpBa0JnTlZCQXNNSFVGd2NHeGxJRU5sY25ScFptbGpZWFJwYjI0Z1FYVjBhRzl5YVhSNU1STXdFUVlEVlFRS0RBcEJjSEJzWlNCSmJtTXVNUXN3Q1FZRFZRUUdFd0pWVXpBZUZ3MHhPVEExTVRnd01UTXlOVGRhRncweU5EQTFNVFl3TVRNeU5UZGFNRjh4SlRBakJnTlZCQU1NSEdWall5MXpiWEF0WW5KdmEyVnlMWE5wWjI1ZlZVTTBMVkJTVDBReEZEQVNCZ05WQkFzTUMybFBVeUJUZVhOMFpXMXpNUk13RVFZRFZRUUtEQXBCY0hCc1pTQkpibU11TVFzd0NRWURWUVFHRXdKVlV6QlpNQk1HQnlxR1NNNDlBZ0VHQ0NxR1NNNDlBd0VIQTBJQUJNSVZkKzNyMXNleUlZOW8zWENRb1NHTng3QzlieXdvUFlSZ2xkbEs5S1ZCRzROQ0R0Z1I4MEIrZ3pNZkhGVEQ5K3N5SU5hNjFkVHY5SktKaVQ1OER4T2pnZ0lSTUlJQ0RUQU1CZ05WSFJNQkFmOEVBakFBTUI4R0ExVWRJd1FZTUJhQUZDUHlTY1JQaytUdkorYkU5aWhzUDZLNy9TNUxNRVVHQ0NzR0FRVUZCd0VCQkRrd056QTFCZ2dyQmdFRkJRY3dBWVlwYUhSMGNEb3ZMMjlqYzNBdVlYQndiR1V1WTI5dEwyOWpjM0F3TkMxaGNIQnNaV0ZwWTJFek1ESXdnZ0VkQmdOVkhTQUVnZ0VVTUlJQkVEQ0NBUXdHQ1NxR1NJYjNZMlFGQVRDQi9qQ0J3d1lJS3dZQkJRVUhBZ0l3Z2JZTWdiTlNaV3hwWVc1alpTQnZiaUIwYUdseklHTmxjblJwWm1sallYUmxJR0o1SUdGdWVTQndZWEowZVNCaGMzTjFiV1Z6SUdGalkyVndkR0Z1WTJVZ2IyWWdkR2hsSUhSb1pXNGdZWEJ3YkdsallXSnNaU0J6ZEdGdVpHRnlaQ0IwWlhKdGN5QmhibVFnWTI5dVpHbDBhVzl1Y3lCdlppQjFjMlVzSUdObGNuUnBabWxqWVhSbElIQnZiR2xqZVNCaGJtUWdZMlZ5ZEdsbWFXTmhkR2x2YmlCd2NtRmpkR2xqWlNCemRHRjBaVzFsYm5SekxqQTJCZ2dyQmdFRkJRY0NBUllxYUhSMGNEb3ZMM2QzZHk1aGNIQnNaUzVqYjIwdlkyVnlkR2xtYVdOaGRHVmhkWFJvYjNKcGRIa3ZNRFFHQTFVZEh3UXRNQ3N3S2FBbm9DV0dJMmgwZEhBNkx5OWpjbXd1WVhCd2JHVXVZMjl0TDJGd2NHeGxZV2xqWVRNdVkzSnNNQjBHQTFVZERnUVdCQlNVVjl0djFYU0Job21KZGk5K1Y0VUg1NXRZSkRBT0JnTlZIUThCQWY4RUJBTUNCNEF3RHdZSktvWklodmRqWkFZZEJBSUZBREFLQmdncWhrak9QUVFEQWdOSkFEQkdBaUVBdmdsWEgrY2VIbk5iVmVXdnJMVEhMK3RFWHpBWVVpTEhKUkFDdGg2OWIxVUNJUURSaXpVS1hkYmRickYwWURXeEhyTE9oOCtqNXE5c3ZZT0FpUTNJTE4ycVl6Q0NBdTR3Z2dKMW9BTUNBUUlDQ0VsdEw3ODZtTnFYTUFvR0NDcUdTTTQ5QkFNQ01HY3hHekFaQmdOVkJBTU1Fa0Z3Y0d4bElGSnZiM1FnUTBFZ0xTQkhNekVtTUNRR0ExVUVDd3dkUVhCd2JHVWdRMlZ5ZEdsbWFXTmhkR2x2YmlCQmRYUm9iM0pwZEhreEV6QVJCZ05WQkFvTUNrRndjR3hsSUVsdVl5NHhDekFKQmdOVkJBWVRBbFZUTUI0WERURTBNRFV3TmpJek5EWXpNRm9YRFRJNU1EVXdOakl6TkRZek1Gb3dlakV1TUN3R0ExVUVBd3dsUVhCd2JHVWdRWEJ3YkdsallYUnBiMjRnU1c1MFpXZHlZWFJwYjI0Z1EwRWdMU0JITXpFbU1DUUdBMVVFQ3d3ZFFYQndiR1VnUTJWeWRHbG1hV05oZEdsdmJpQkJkWFJvYjNKcGRIa3hFekFSQmdOVkJBb01Da0Z3Y0d4bElFbHVZeTR4Q3pBSkJnTlZCQVlUQWxWVE1Ga3dFd1lIS29aSXpqMENBUVlJS29aSXpqMERBUWNEUWdBRThCY1JoQm5YWklYVkdsNGxnUWQyNklDaTc5NTdyazNnamZ4TGsrRXpWdFZtV3pXdUl0Q1hkZzBpVG51NkNQMTJGODZJeTNhN1puQyt5T2dwaFA5VVJhT0I5ekNCOURCR0JnZ3JCZ0VGQlFjQkFRUTZNRGd3TmdZSUt3WUJCUVVITUFHR0ttaDBkSEE2THk5dlkzTndMbUZ3Y0d4bExtTnZiUzl2WTNOd01EUXRZWEJ3YkdWeWIyOTBZMkZuTXpBZEJnTlZIUTRFRmdRVUkvSkp4RStUNU84bjVzVDJLR3cvb3J2OUxrc3dEd1lEVlIwVEFRSC9CQVV3QXdFQi96QWZCZ05WSFNNRUdEQVdnQlM3c042aFdET0ltcVNLbWQ2K3ZldXYyc3NrcXpBM0JnTlZIUjhFTURBdU1DeWdLcUFvaGlab2RIUndPaTh2WTNKc0xtRndjR3hsTG1OdmJTOWhjSEJzWlhKdmIzUmpZV2N6TG1OeWJEQU9CZ05WSFE4QkFmOEVCQU1DQVFZd0VBWUtLb1pJaHZkalpBWUNEZ1FDQlFBd0NnWUlLb1pJemowRUF3SURad0F3WkFJd09zOXlnMUVXbWJHRyt6WERWc3Bpdi9RWDdka1BkVTJpanI3eG5JRmVRcmVKK0pqM20xbWZtTlZCRFkrZDZjTCtBakF5TGRWRUliQ2pCWGRzWGZNNE81Qm4vUmQ4TENGdGxrL0djbW1DRW05VStIcDlHNW5MbXdtSklXRUdtUThKa2gwQUFER0NBWWd3Z2dHRUFnRUJNSUdHTUhveExqQXNCZ05WQkFNTUpVRndjR3hsSUVGd2NHeHBZMkYwYVc5dUlFbHVkR1ZuY21GMGFXOXVJRU5CSUMwZ1J6TXhKakFrQmdOVkJBc01IVUZ3Y0d4bElFTmxjblJwWm1sallYUnBiMjRnUVhWMGFHOXlhWFI1TVJNd0VRWURWUVFLREFwQmNIQnNaU0JKYm1NdU1Rc3dDUVlEVlFRR0V3SlZVd0lJVERCQlNWR2RWRFl3Q3dZSllJWklBV1VEQkFJQm9JR1RNQmdHQ1NxR1NJYjNEUUVKQXpFTEJna3Foa2lHOXcwQkJ3RXdIQVlKS29aSWh2Y05BUWtGTVE4WERUSXlNVEV3TnpFeE1qWXpObG93S0FZSktvWklodmNOQVFrME1Sc3dHVEFMQmdsZ2hrZ0JaUU1FQWdHaENnWUlLb1pJemowRUF3SXdMd1lKS29aSWh2Y05BUWtFTVNJRUlITDBiWkczRk51NHhsZ0tCcW9hVGh5dm1DWnJTeXY5UG51NjlZcUFrK2dVTUFvR0NDcUdTTTQ5QkFNQ0JFY3dSUUlnSnpFNG1adjNYc003M01PZHJFcU9EWjN0cXQ0ZE9wdlFhc0YyRGpyOVFiNENJUUMzT2hGczJmMVM0ZndhRThuNDNGVlRTZWo0NDl4YUpiZElMbnFHQVlMcXFRQUFBQUFBQUE9PSIsImhlYWRlciI6eyJlcGhlbWVyYWxQdWJsaWNLZXkiOiJNRmt3RXdZSEtvWkl6ajBDQVFZSUtvWkl6ajBEQVFjRFFnQUVpbXhhUmR4dGJaeFNVUEtYSVh2NG5RS3lSTHdUQjdHcUN5UjhDc2hKTGhraTlJUXErTVNsaHArOXlqQURvcVR1a0R6VkVXblBabUNnTnBDUTNUZ3ZyUT09IiwicHVibGljS2V5SGFzaCI6ImI2UXJSemt6NnJzRGdWV2hTdzh0ZkdGRHprcHdtOTV4RUpzYnFGSWJVcDQ9IiwidHJhbnNhY3Rpb25JZCI6IjY1ODYwNjA4Y2YwZDAxYzgzNTUyNmIwOGZjOTNmNTE1M2Y0NDdlZDgwZDU3MjhkMjNjMDMwNzhjZmIxMWIxMjUifX0sInBheW1lbnRNZXRob2QiOnsiZGlzcGxheU5hbWUiOiJNYXN0ZXJDYXJkIDA4MzkiLCJuZXR3b3JrIjoiTWFzdGVyQ2FyZCIsInR5cGUiOiJjcmVkaXQifSwidHJhbnNhY3Rpb25JZGVudGlmaWVyIjoiNjU4NjA2MDhDRjBEMDFDODM1NTI2QjA4RkM5M0Y1MTUzRjQ0N0VEODBENTcyOEQyM0MwMzA3OENGQjExQjEyNSJ9" }, "processing_options" : [ "RISKCHECK" ], "amount_total" : { "amount" : 1000, "currency" : "EUR" }, "tds_20_data" : { "communication_data" : { "method_notification_url" : "https://example.com/method_notification_url", "cres_notification_url" : "https://example.com/cres_notification_url" } } } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Information about the outcome of the transaction.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Headless3DSecureResponse" }, "examples" : { "sample_response_to_initial_request_-_transaction_processed" : { "summary" : "Transaction has been processed, no further actions required.", "description" : "Transaction has been processed, no further actions required.", "value" : { "outcome" : "PROCESSED", "processed" : { "amount_total" : { "amount" : 100, "currency" : "EUR" }, "event_id" : "id1628241502404", "kind" : "CREDITCARD_3DS20", "tx_action" : "preauthorization", "tx_id" : "fCDszGoUje8piOUC2tVVU9", "back_rc" : "00", "transaction_info" : { "type" : "creditcard", "transaction_creditcard_info" : { "credit_card" : { "number" : "401200******7778", "expiry_date" : { "year" : 2034, "month" : 12 }, "cardholder" : "Card Holder" } } }, "rc" : "0", "message" : "Transaction successful." }, "rc" : "0", "message" : "Transaction successful." } }, "sample_response_to_initial_request_-_method_flow_required" : { "summary" : "Proceed with 3-D Secure method flow.", "description" : "Proceed with 3-D Secure method flow.", "value" : { "outcome" : "METHOD_REQUIRED", "method_required" : { "method_request" : "ew0KICAiY29udGVudCIgOiAiZHVtbXkiDQp9" }, "rc" : "1548", "message" : "Transaction is pending." } }, "sample_response_to_initial_request_-_challenge_flow_required" : { "summary" : "Proceed with 3-D Secure challenge flow.", "description" : "Proceed with 3-D Secure challenge flow.", "value" : { "outcome" : "CHALLENGE_REQUIRED", "challenge_required" : { "acs_url" : "https://acs.example.com/acs/challenge/ew0KICAiZHVtbXkiIDogImR1bW15Ig0KfQ==", "creq" : "ew0KICAiZHVtbXkiIDogImNvbnRlbnQiDQp9" }, "rc" : "1548", "message" : "Transaction is pending." } } } } } } } } }, "/escore/event/{event_id}/addresscheck" : { "post" : { "tags" : [ "eScore" ], "summary" : "Performs an Address Verification (ES0013).", "description" : "\nTwo scenarios of use are possible:\n \n1. The address details of a customer are verified with the address verification. If an address is supplied wrongly the customer is requested to correct it. Thereafter the address is verified again. After a successful address verification further information has to be collated via credit assessment. \n\n2. The transaction “integrated address verification, credit assessment and scoring” is carried out. \n\nIMPORTANT: The address verification may only be carried out in connection with the credit assessment. Using the address verification on its own is not permissible for contractual reasons.\n\nWith the address verification the supplied address (name, town of residence, post code and street) is verified. This means that as a rule the address verification is related to the person. \n\nThe basis for the query is the post directory of the Deutsche Post Direkt GmbH (German mail) with roughly 95 m validated consumer addresses. The correction function is differentiated according to the individual address components and can provide evidence for their coherence and correct wrong details respectively.", "operationId" : "escoreAddressVerificationPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EScoreRequest" }, "example" : { "reason" : "ABK", "billing_address" : { "title" : "MRS", "first_name" : "KATJA", "last_name" : "KOPLIN", "postal_code" : "10407", "city" : "BERLIN", "country" : "DE", "extensions" : { "alternative_address_data" : { "street" : "DANZIGER STR.", "street_number" : "67" } } }, "basket" : { "basket_id" : "basketId1641228398709" }, "customer_information" : { "customer_id" : "5x14120ffrG", "date_of_birth" : "1979-10-27" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "If the query could be carried out you receive the return value `rc=0` as response independent from the outcome of the address verification. The outcome of the address verification is returned in the field `address_note`. Where applicable, the address fields of the response include the address components, which could be corrected. If possible you will receive the freight routing code for the corrected address in the field `freight_routing_code`.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EScoreAddresscheckResponse" }, "example" : { "address_note" : "PPB", "freight_routing_code" : "10435003067", "rc" : "0", "message" : "Transaction successful.", "event_id" : "9184bf11-75ed-4a11-b9e6-557c11bd3853", "tx_id" : "2yYJ5nYkDIGuTdjWgCkJoK", "action" : "addresscheck", "basket_id" : "basketId1641293516625", "scoring_rc" : "G", "reason" : "ABK", "billing_address" : { "title" : "MRS", "first_name" : "KATJA", "last_name" : "KOPLIN", "date_of_birth" : "1979-10-27", "postal_code" : "10407", "city" : "BERLIN", "country" : "DE", "extensions" : { "alternative_address_data" : { "street" : "DANZIGER STR.", "street_number" : "67" } } } } } } } } } }, "/escore/event/{event_id}/creditassessment" : { "post" : { "tags" : [ "eScore" ], "summary" : "Performs a Credit Assessment (ES0012).", "description" : "\nThe credit assessment provides information about the customers' negative features. From the result the possible general payment behaviour and the creditworthiness of a purchaser may be deduced.\n\nUpon entering the customer details during the order process it is verified in the background whether there is a negative feature related to this person resulting from extra judicial or judicial collection proceedings, enforcement by writ or affidavit.", "operationId" : "escoreCreditAssessmentPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EScoreRequest" }, "example" : { "reason" : "ABK", "billing_address" : { "title" : "MRS", "first_name" : "KATJA", "last_name" : "KOPLIN", "postal_code" : "10407", "city" : "BERLIN", "country" : "DE", "extensions" : { "alternative_address_data" : { "street" : "DANZIGER STR.", "street_number" : "67" } } }, "basket" : { "basket_id" : "basketId1641228398709" }, "customer_information" : { "customer_id" : "5x14120ffrG", "date_of_birth" : "1979-10-27" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "\nDepending on the negative features found you will receive in the field `scoring_rc` a classification of the data record following the traffic light system 'green', 'yellow/amber' and 'red' (This classification only takes place if the address was rectifiable postally, otherwise you will receive the return value `rc=1538`). The negative features are divided into the categories 'soft', 'medium' and 'hard'.\n\nThe allocation of the negative features to the traffic light values is as follows:\n \n• `G`: green - There are no negative features.\n\n• `Y`: yellow/amber - There are no negative features.\n\n• `R`: red - There are no negative features.\n\nThe field score provides you with a more subtly graduated result of the credit assessment. \n\nIn addition to the traffic light values and score all negative features are returned, which were relevant for the generation of the traffic light value.\n ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EScoreCreditassessmentResponse" }, "example" : { "customer_id" : "5x14120ffrG", "score" : "100", "negative_criteria" : [ { "kind" : "LP", "date" : "2021-01-08", "doc_reference" : "8IN303" }, { "kind" : "VB", "date" : "2021-12-07", "doc_reference" : "8IN306" } ], "rc" : "0", "message" : "Transaction successful.", "event_id" : "9dd00d1d-7888-4679-af78-7dc95eef052d", "tx_id" : "fC1DpbpWZeELL6tzmoHcKL", "action" : "creditassessment", "basket_id" : "basketId1641293519408", "scoring_rc" : "R", "reason" : "ABK", "billing_address" : { "title" : "MRS", "first_name" : "KATJA", "last_name" : "KOPLIN", "date_of_birth" : "1979-10-27", "postal_code" : "10407", "city" : "BERLIN", "country" : "DE", "extensions" : { "alternative_address_data" : { "street" : "DANZIGER STR.", "street_number" : "67" } } } } } } } } } }, "/escore/event/{event_id}/bankaccount" : { "post" : { "tags" : [ "eScore" ], "summary" : "Performs an RPP Check (ES0024).", "description" : "\nThis service checks bank details for plausibility and current return debit notes.\n\nThe “return debit note prevention pool” (RPP) is a data pool where bank details are saved for which return debit notes are currently known. The pool primarily serves the prevention of cash loss for direct debits.\n", "operationId" : "escoreRppPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EScoreRPPRequest" }, "example" : { "bank_account" : { "bic" : "PZHSDE66XXX", "iban" : "DE84666500855073321010" }, "basket" : { "basket_id" : "basketId1641228398709" }, "customer_information" : { "customer_id" : "5x14120ffrG", "date_of_birth" : "1979-10-27" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "\nIn addition to information on return debit notes the following data are available:\n\n• data of stolen or lost EC cards (for example from the KUNO database)\n\n• data about publicly known bank details (NCA = non consumer account)\n\n• customer specific negative and positive lists\n\nNo personal data are saved in the RPP. This means it is not known who is the account holder.\n\nThe return debit note service is currently available for Germany.\n\nThe bank account details in the response possibly include corrections or additional information, for example IBAN and BIC when you submitted account number and bank code in the request.\n ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EScoreRPPResponse" }, "example" : { "bank_account" : { "bic" : "PZHSDE66XXX", "iban" : "DE84666500855073321010", "bank_name" : "Sparkasse Pforzheim Calw" }, "bank_account_validation_result" : "00", "bank_account_validation_message" : "The bank account is valid.", "rpp_match" : "0", "rc" : "0", "message" : "Transaction successful.", "event_id" : "abf1ccf6-a9d6-4904-99d3-cadb6521ee90", "tx_id" : "np5yYhvMr2dZQqWNub0BGj", "action" : "bankaccount", "basket_id" : "basketId1641293501021", "scoring_rc" : "G" } } } } } } }, "/escore/event/{event_id}/scoring" : { "post" : { "tags" : [ "eScore" ], "summary" : "Performs an integrated Address Verification, Credit Assessment, and Scoring (ES0015).", "description" : "This kind of transaction consists of address verification, credit assessment, and scoring.", "operationId" : "escoreScoringPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EScoreRequest" }, "example" : { "reason" : "ABK", "billing_address" : { "title" : "MRS", "first_name" : "KATJA", "last_name" : "KOPLIN", "postal_code" : "10407", "city" : "BERLIN", "country" : "DE", "extensions" : { "alternative_address_data" : { "street" : "DANZIGER STR.", "street_number" : "67" } } }, "basket" : { "basket_id" : "basketId1641228398709" }, "customer_information" : { "customer_id" : "5x14120ffrG", "date_of_birth" : "1979-10-27" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "\nIf there are no negative entries for a person's given name the probability of non-payments may be determined in a further step with help of the INFORMA score. The INFORMA score collates information from various socio-demographic parameters, such as details about the social structure of the town of residence. According to the risk assessment a recommendation for proceeding is provided. This value is included as essential component in the parameter `score`. \n ", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EScoreScoringResponse" }, "example" : { "customer_id" : "5x14120ffrG", "address_note" : "PPB", "freight_routing_code" : "10435003067", "score" : "980", "informa_score_value" : "670", "rc" : "0", "message" : "Transaction successful.", "event_id" : "f66400e4-40f2-4fdf-8229-d6e7dca3bf4d", "tx_id" : "pXKc6vH91ASi0QrYfH7Ch7", "action" : "scoring", "basket_id" : "basketId1641293520741", "scoring_rc" : "G", "reason" : "ABK", "billing_address" : { "title" : "MRS", "first_name" : "KATJA", "last_name" : "KOPLIN", "date_of_birth" : "1979-10-27", "postal_code" : "10407", "city" : "BERLIN", "country" : "DE", "extensions" : { "alternative_address_data" : { "street" : "DANZIGER STR.", "street_number" : "67" } } } } } } } } } }, "/form/alias/bankaccount" : { "post" : { "tags" : [ "Forms" ], "summary" : "Creates a form to enter bank account data and create an alias for it.", "operationId" : "formAliasBankAccountPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormRegisterAliasRequest" }, "example" : { "alias" : "AL1234_XY", "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "callback" : { "notify_url" : "http://www.example.com/notify" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialize a form interaction. No transaction is created.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormNoTxResponse" } } } } } } }, "/form/alias/creditcard" : { "post" : { "tags" : [ "Forms" ], "summary" : "Creates a form to enter credit card data and create an alias for it.", "operationId" : "formAliasCreditCardPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormRegisterAliasRequest" }, "example" : { "alias" : "AL1234_XY", "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "callback" : { "notify_url" : "http://www.example.com/notify" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialize a form interaction. No transaction is created.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormNoTxResponse" } } } } } } }, "/form/alias/klarna" : { "post" : { "tags" : [ "Forms" ], "summary" : "Creates an authorization form for a Klarna payment alias.", "operationId" : "formAliasKlarnaPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormRegisterAliasKlarnaRequest" }, "example" : { "alias" : "AL1234_XY", "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "callback" : { "notify_url" : "http://www.example.com/notify" }, "customer_information" : { "date_of_birth" : "1980-01-01" }, "shipping_address" : { "title" : "Ms", "first_name" : "Jane", "last_name" : "Doe", "email" : "test_jane@gmail.com", "address_line_1" : "Main Street 123", "address_line_2" : "Building A", "address_line_3" : "Apartment 12", "postal_code" : "80469", "phone_contact" : { "phone_type" : "MOBILE", "phone_number" : "+4917614287464" }, "city" : "Munich", "country" : "DE", "extensions" : { } }, "billing_address" : { "title" : "Ms", "first_name" : "Jane", "last_name" : "Doe", "email" : "test_jane@gmail.com", "address_line_1" : "Main Street 123", "address_line_2" : "Building A", "address_line_3" : "Apartment 12", "postal_code" : "80469", "phone_contact" : { "phone_type" : "MOBILE", "phone_number" : "+4917614287464" }, "city" : "Munich", "country" : "DE", "extensions" : { "klarna_data" : { "custom_payment_method_ids" : [ ] } } }, "basket" : { "basket_id" : "basket123456", "invoice_id" : "RE123345", "soft_descriptor" : "800-123-1234", "shipping_costs" : { "amount" : 200, "currency" : "EUR" }, "basket_type" : "DIGITAL", "extensions" : { "paypal_data" : { "custom_id" : "CUSTOMID123" } }, "basket_items" : [ { "name" : "A fine shirt", "description" : "BI123456", "reference" : "UGG-BB-PUR-06", "quantity" : { "quantity_amount" : 5, "quantity_unit" : "pcs" }, "unit_price" : { "net" : 100, "gross" : 100, "currency" : "EUR", "tax" : 1900 }, "discount" : { "net" : 0, "gross" : 0, "currency" : "EUR", "tax" : 1900 }, "extensions" : { "klarna_data" : { "klarna_type" : "PHYSICAL", "image_url" : "https://upload.wikimedia.org/wikipedia/commons/thumb/a/a5/Camisade_pu%C3%B1o_doble.jpg/256px-Camisade_pu%C3%B1o_doble.jpg" } } } ] }, "amount_total" : { "amount" : 700, "currency" : "EUR" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialize a form interaction.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormResponse" } } } } } } }, "/form/event/{event_id}/checkout/{tx_action}" : { "post" : { "tags" : [ "Forms" ], "summary" : "Creates a redirect to a checkout page where the customer may choose one of the offered means of payments \n (for instance credit card or Request to Pay) and then continue the payment.", "operationId" : "formCheckoutPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "authorization", "preauthorization" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormCheckoutRequest" }, "example" : { "checkout_page_configuration" : { "direct_debit_data" : { "mandate" : { "reference" : "MDT1620213727383XY", "mandate_name" : "Sample mandate name", "signed_on" : "2020-12-30", "mandate_sequence_type" : "ONEOFF" } }, "request_to_pay_data" : { "customer_id" : "testCustrID" }, "checkout_entry_sorting_order" : [ "DIRECTDEBIT", "REQUEST_TO_PAY" ] }, "amount_total" : { "amount" : 100, "currency" : "EUR" }, "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "callback" : { "notify_url" : "http://www.example.com/notify" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialize a form interaction, a return code and a message. In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormResponse" } } } } } } }, "/form/event/{event_id}/creditcard/{tx_action}" : { "post" : { "tags" : [ "Forms" ], "summary" : "Creates a form to enter credit card data and then proceed with the transaction (pre-authorization, authorization, or verify MOP).", "operationId" : "formCreditCardPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "authorization", "preauthorization", "verify-mop" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormCreditCardRequest" }, "examples" : { "exampleccv2.1a" : { "summary" : "Sample initialization of a credit card transaction.", "description" : "Redirect the customer to the URL received in the result.", "value" : { "amount_total" : { "amount" : 100, "currency" : "EUR" }, "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "callback" : { "notify_url" : "http://www.example.com/notify" }, "billing_address" : { "first_name" : "Heinz", "last_name" : "Müller", "email" : "heinz@email.com", "address_line_1" : "Rohrteichstr 18", "address_line_2" : "EG R. 184", "address_line_3" : "Wohnhaus", "state" : "SN", "postal_code" : "04347", "city" : "Leipzig", "country" : "DE" } } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialize a form interaction, a return code and a message. In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormResponse" } } } } } } }, "/form/event/{event_id}/directdebit/{tx_action}" : { "post" : { "tags" : [ "Forms" ], "summary" : "Creates a form to enter bank account data and then proceed with an SDD transaction (pre-authorization, authorization, or verify MOP).", "operationId" : "formDirectDebitPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "authorization", "preauthorization", "verify-mop" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormDirectDebitRequest" }, "example" : { "amount_total" : { "amount" : 100, "currency" : "EUR" }, "direct_debit_data" : { "mandate" : { "reference" : "MDT1620213727383XY", "mandate_name" : "Sample mandate name", "signed_on" : "2020-12-30", "mandate_sequence_type" : "ONEOFF" } }, "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "callback" : { "notify_url" : "http://www.example.com/notify" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialize a form interaction, a return code and a message. \n In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormResponse" } } } } } } }, "/form/event/{event_id}/giropay/{tx_action}" : { "post" : { "tags" : [ "Forms" ], "summary" : "Initializes a giropay transaction (payment, avs, or avspayment).", "description" : "Start a new giropay transaction sequence. Customers should be redirected to the returned URL.", "operationId" : "formGiropayInitPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "payment", "avs", "avspayment" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormGiropayRequest" }, "examples" : { "sample21" : { "summary" : "Sample giropay initialization request.", "description" : "Start a new giropay transaction sequence.", "value" : { "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "callback" : { "notify_url" : "http://www.example.com/notify" }, "amount_total" : { "amount" : 100, "currency" : "EUR" }, "basket" : { "basket_id" : "basketId1639066152436", "order_amount" : { "amount" : 900, "currency" : "EUR" }, "shipping_costs" : { "amount" : 100, "currency" : "EUR" }, "basket_type" : "PHYSICAL", "basket_items" : [ { "name" : "PhysicalBasketItem", "description" : "A basket item", "quantity" : { "quantity_amount" : 1, "quantity_unit" : "pcs" }, "unit_price" : { "net" : 756, "gross" : 900, "currency" : "EUR", "tax" : 1900 } } ] } } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, accompanied by an appropriate redirect URL. In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormResponse" } } } } } } }, "/form/event/{event_id}/klarna/{tx_action}" : { "post" : { "tags" : [ "Forms" ], "summary" : "Initializes a Klarna transaction (pre-authorization or authorization).", "description" : "Start a new Klarna transaction sequence. Customers should be redirected to the returned URL.", "operationId" : "formKlarnaInitPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "authorization", "preauthorization" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormKlarnaRequest" }, "example" : { "shipping_address" : { "title" : "Ms", "first_name" : "Jane", "last_name" : "Doe", "email" : "test_jane@gmail.com", "address_line_1" : "Main Street 123", "address_line_2" : "Building A", "address_line_3" : "Apartment 12", "postal_code" : "80469", "city" : "Munich", "state" : "BY", "country" : "DE", "extensions" : { "alternative_address_data" : { "street" : "Main Street", "street_number" : "123a" } } }, "billing_address" : { "title" : "Ms", "first_name" : "Jane", "last_name" : "Doe", "email" : "test_jane@gmail.com", "address_line_1" : "Main Street 123", "address_line_2" : "Building A", "address_line_3" : "Apartment 12", "postal_code" : "80469", "city" : "Munich", "state" : "BY", "country" : "DE" }, "basket" : { "basket_id" : "basket123456", "invoice_id" : "RE123345", "soft_descriptor" : "800-123-1234", "shipping_costs" : { "amount" : 200, "currency" : "EUR" }, "basket_type" : "PHYSICAL", "basket_items" : [ { "name" : "A fine shirt", "description" : "BI123456", "reference" : "UGG-BB-PUR-06", "quantity" : { "quantity_amount" : 5, "quantity_unit" : "pcs" }, "unit_price" : { "net" : 10000, "gross" : 11900, "currency" : "EUR", "tax" : 1900 }, "item_discount" : { "net" : 0, "gross" : 0, "currency" : "EUR", "tax" : 1900 }, "extensions" : { "klarna_data" : { "image_url" : "https://upload.wikimedia.org/wikipedia/commons/thumb/a/a5/Camisade_pu%C3%B1o_doble.jpg/256px-Camisade_pu%C3%B1o_doble.jpg" } } } ] }, "customer_information" : { "customer_id" : "C1234-AX", "date_of_birth" : "1975-06-30", "gender" : "FEMALE", "title" : "Ms", "personal_identifications" : [ { "type" : "PASSPORT", "id" : "T220001297", "issued_by" : "DE" } ] }, "form_data" : { "locale" : "en" }, "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "callback" : { "notify_url" : "http://www.example.com/notify" }, "amount_total" : { "amount" : 59700, "currency" : "EUR" }, "merchant_information" : { "merchant_data_1" : "merchantData1", "merchant_data_2" : "merchantData2", "merchant_data_3" : "merchantData3" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, accompanied by an appropriate redirect URL. In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormResponse" } } } } } } }, "/form/event/{event_id}/p24" : { "post" : { "tags" : [ "Forms" ], "summary" : "Initializes a Request to P24 transaction (authorization).", "operationId" : "formP24Post", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormP24Request" }, "example" : { "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "billing_address" : { "first_name" : "Heinz", "last_name" : "Müller", "email" : "heinz@email.com", "address_line_1" : "Rohrteichstr 18", "address_line_2" : "EG R. 184", "address_line_3" : "Wohnhaus", "state" : "SN", "postal_code" : "04347", "city" : "Leipzig", "country" : "DE" }, "callback" : { "notify_url" : "http://www.example.com/notify" }, "amount_total" : { "amount" : 100, "currency" : "EUR" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialize a form interaction, a return code and a message. In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormResponse" } } } } } } }, "/form/event/{event_id}/psd2/authorization" : { "post" : { "tags" : [ "Forms" ], "summary" : "Initializes a PSD2 payment transaction (authorization).", "operationId" : "formPSD2AuthorizationPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormPSD2AuthorizationRequest" }, "example" : { "amount_total" : { "amount" : 100, "currency" : "EUR" }, "callback" : { "notify_url" : "http://www.example.com/notify" }, "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "form_data" : { "locale" : "fr" }, "psd2_pis_data" : { "processing_options" : [ "INSTANT_IF_POSSIBLE" ] } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialize a form interaction, a return code and a message. In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormResponse" } } } } } } }, "/form/event/{event_id}/psd2/reversal" : { "post" : { "tags" : [ "Forms" ], "summary" : "Initializes a cancellation (reversal) of a PSD2 future dated payment.", "operationId" : "formPSD2ReversalPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormPSD2ReversalRequest" }, "example" : { "callback" : { "notify_url" : "http://www.example.com/notify" }, "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialize a form interaction, a return code and a message. In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormPSD2ReversalResponse" }, "examples" : { "sample_psd2reversal_response_-_transaction_processed" : { "summary" : "The transaction has been processed, no further action is required.", "description" : "The transaction has been processed, no further action is required.", "value" : { "outcome" : "PROCESSED", "processed" : { "amount_total" : { "amount" : 100, "currency" : "EUR" }, "tx_action" : "reversal", "transaction_info" : { "type" : "bankaccount", "transaction_bankaccount_info" : { "bank_account" : { "bic" : "TESTDEL0BK2", "iban" : "DE3912345679123456****" } } }, "rc" : "0", "message" : "Transaction successful.", "event_id" : "e1661530099420", "tx_id" : "7PzZdYtamuTcTl8yhMpPXD" }, "rc" : "0", "message" : "Transaction successful." }, "x-ApiExampleVersioning" : { "ApiExampleVersioningFirst" : "v2.1" } }, "sample_psd2reversal_response_-_authorization_required" : { "summary" : "The customer has to authorize the reversal.", "description" : "The customer has to authorize the reversal.", "value" : { "outcome" : "REDIRECT_REQUIRED", "rc" : "0", "message" : "Transaction successful.", "tx_id" : "pOMnecOgs6cxDv34jrTVx9", "redirect_url" : "https://testmerch.directpos.de/web-api/de_DE/R.po?n=KMpGwCyjXoWq85VF9pKl4oMD9JXqYMT3yqgamsbhGjAm21" } } } } } } } } }, "/form/event/{event_id}/paypal/{tx_action}" : { "post" : { "tags" : [ "Forms" ], "summary" : "Initializes a PayPal transaction (pre-authorization or authorization).", "description" : "Start a new PayPal transaction sequence. Customers should be redirected to the returned URL.", "operationId" : "formPayPalInitPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "authorization", "preauthorization" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormPayPalRequest" }, "example" : { "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "callback" : { "notify_url" : "http://www.example.com/notify" }, "amount_total" : { "amount" : 100, "currency" : "EUR" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, accompanied by an appropriate redirect URL. In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormResponse" } } } } } } }, "/form/event/{event_id}/paydirekt/{tx_action}" : { "post" : { "tags" : [ "Forms" ], "summary" : "Initializes a paydirekt transaction (pre-authorization, authorization).", "description" : "Start a new paydirekt transaction sequence. Customers should be redirected to the returned URL.", "operationId" : "formPaydirektInitPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "authorization", "preauthorization" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormPaydirektRequest" }, "examples" : { "sample21" : { "summary" : "Sample paydirekt initialization request.", "description" : "Start a new paydirekt transaction sequence.", "value" : { "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "callback" : { "notify_url" : "http://www.example.com/notify" }, "billing_address" : { "first_name" : "Heinz", "last_name" : "Müller", "email" : "heinz@email.com", "address_line_1" : "Rohrteichstr 18", "address_line_2" : "EG R. 184", "address_line_3" : "Wohnhaus", "state" : "SN", "postal_code" : "04347", "city" : "Leipzig", "country" : "DE" }, "basket" : { "basket_id" : "basketId1639066152436", "order_amount" : { "amount" : 900, "currency" : "EUR" }, "shipping_costs" : { "amount" : 100, "currency" : "EUR" }, "basket_type" : "PHYSICAL", "basket_items" : [ { "name" : "PhysicalBasketItem", "description" : "A basket item", "quantity" : { "quantity_amount" : 1, "quantity_unit" : "pcs" }, "unit_price" : { "net" : 756, "gross" : 900, "currency" : "EUR", "tax" : 1900 } } ] }, "amount_total" : { "amount" : 100, "currency" : "EUR" } } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, accompanied by an appropriate redirect URL. In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormResponse" } } } } } } }, "/form/event/{event_id}/psd2/account_info" : { "post" : { "tags" : [ "Forms" ], "summary" : "Initializes a PSD2 account information transaction.", "operationId" : "formPsd2AccountInfoPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormPSD2AccountInfoRequest" }, "example" : { "bank_id" : "bG0E", "requested_details" : [ "OWNER" ], "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "callback" : { "skip" : true } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialise a form interaction.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormResponse" } } } } } } }, "/form/event/{event_id}/credittransfer" : { "post" : { "tags" : [ "Forms" ], "summary" : "Initializes a Request to Pay transaction (authorization).", "operationId" : "formRequestToPayPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormRequestToPayRequest" }, "example" : { "amount_total" : { "amount" : 100, "currency" : "EUR" }, "callback" : { "notify_url" : "http://www.example.com/notify" }, "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "form_data" : { "locale" : "fr" }, "request_to_pay_data" : { "processing_options" : [ "INSTANT_IF_POSSIBLE" ] } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialize a form interaction, a return code and a message. In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormResponse" } } } } } } }, "/form/event/{event_id}/sofort" : { "post" : { "tags" : [ "Forms" ], "summary" : "Initializes a Sofortüberweisung transaction (authorization).", "description" : "Start a new Sofortüberweisung sequence. Customers should be redirected to the returned URL.", "operationId" : "formSofortUeberweisungInitPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormSofortUeberweisungRequest" }, "examples" : { "sample21" : { "summary" : "Sample SOFORT initialization request.", "description" : "Start a new SOFORT Überweisung sequence.", "value" : { "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "callback" : { "notify_url" : "http://www.example.com/notify" }, "amount_total" : { "amount" : 100, "currency" : "EUR" }, "basket" : { "basket_id" : "basketId1639066152436" } } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "A return code and a message, accompanied by an appropriate redirect URL. In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormResponse" } } } } } } }, "/form/event/{event_id}/wechatpay" : { "post" : { "tags" : [ "Forms" ], "summary" : "Initializes a Request to WeChat Pay transaction (authorization).", "operationId" : "formWeChatPayPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormWeChatPayRequest" }, "example" : { "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "billing_address" : { "first_name" : "Heinz", "last_name" : "Müller", "email" : "heinz@email.com", "address_line_1" : "Rohrteichstr 18", "address_line_2" : "EG R. 184", "address_line_3" : "Wohnhaus", "state" : "SN", "postal_code" : "04347", "city" : "Leipzig", "country" : "DE" }, "callback" : { "notify_url" : "http://www.example.com/notify" }, "amount_total" : { "amount" : 100, "currency" : "EUR" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialize a form interaction, a return code and a message. In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WeChatPayResponse" } } } } } } }, "/googlepay/pay/{event_id}/{tx_action}/initialize" : { "post" : { "tags" : [ "Google Pay" ], "summary" : "Perform payment requests based on Google Pay™ data.", "operationId" : "googlepayPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "authorization", "preauthorization", "credit", "verify-mop" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GooglePayRequest" }, "examples" : { "GooglePayRequest" : { "summary" : "Sample Google Pay™ Request", "description" : "GooglePayRequest", "value" : { "means_of_payment_google_pay" : { "googlepay_token" : "{\"signature\":\"MEUCIEx9BeftghFS3BeKpaOsmBYyOtP5NzJiBN9NknaTAUypAiEAgkDAuAa8upeKpKx3xWDMKvp4YvOY60jpPneFA/LGtBs\\u003d\",\"intermediateSigningKey\":{\"signedKey\":\"{\\\"keyValue\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE/Cs+e5QTjlzCSkOeGy0UtI8waUV+2xxep1+MdYHOcFT1F/K0d55UidOTht9wziNEInHqCj3o+3X2+8H8hZEKoA\\\\u003d\\\\u003d\\\",\\\"keyExpiration\\\":\\\"1646101850734\\\"}\",\"signatures\":[\"MEUCIQD9TzJS/FYPaAbhPvKklnVj9IDkhZDXxgBWxnkFaboHSAIgDGU9MI3uKf9NG3eEL+B25eW+ylIzYnX8lzm6rysiKNQ\\u003d\"]},\"protocolVersion\":\"ECv2\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"qlZOdNSdm/G5pEFuyUWxZhjG2TSQrtq9c1xZIAaKs5ocrqs/EfcO/rTR0/SMHsxxdqlSv0TMduJUrzD1k7BCXQjamvST0DRVrz48bAeCDuXIitzKQcil/JvLqZA04DASMVSHMmEy2wCCXvzZndXvOob6nx95l2G/f3wlGfolfj9uCGp/W7LohCqvpTc/Eovp+sVfsSTRsb2QDNzm8awXPwnOAAfn4yqbLE4Be7mbaSQDGwhGI5tJYSJrJtOTsjAYlZWfjchKMRu49rW1NE0ghUOLeGWvWub7Qvj4bB9xVN1SBQIvvzswWDkXiDw3xPsVNs5dFoCwBip7OJp+xsOHXM/Xx+eKWR3fgNMQNvuzm4mLhaE4v2R56xQlUjWt21FhPg/iUY6fO9wws71hCjuSuOeBxkqFi7qGvvN2/0jDjyaW7c/4SBO9Dc1T4g/F7t60/77fmrHlMYzflC4j2n0EKAsaWr5BBNkcta9+DjDT9ahzvjNQlueD15abKaoOfuogC73T5D5wpHiFT0Uz657bWXYlMpVEACdu\\\",\\\"ephemeralPublicKey\\\":\\\"BIxk2eXO3LCyKyCytyYVi6MqIfSJ6HbJsxI/To4oVodJjiUi+l55Or9APgSKowxeLh5S+1mGP/zm83vEAGm1WvQ\\\\u003d\\\",\\\"tag\\\":\\\"8vMJhy/dCOtUIo4YQlOlLn7fys+BVAqmx2Lh9aWZaGU\\\\u003d\\\"}\"}" }, "processing_options" : [ "RISKCHECK" ], "amount_total" : { "amount" : 100, "currency" : "EUR" }, "tds_20_data" : { "communication_data" : { "method_notification_url" : "https://example.com/method_notification_url", "cres_notification_url" : "https://example.com/cres_notification_url" } } } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Information about the outcome of the transaction.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Headless3DSecureResponse" }, "examples" : { "sample_response_to_initial_request_-_transaction_processed" : { "summary" : "Transaction has been processed, no further actions required.", "description" : "Transaction has been processed, no further actions required.", "value" : { "outcome" : "PROCESSED", "processed" : { "amount_total" : { "amount" : 100, "currency" : "EUR" }, "event_id" : "id1628241502404", "kind" : "CREDITCARD_3DS20", "tx_action" : "preauthorization", "tx_id" : "fCDszGoUje8piOUC2tVVU9", "back_rc" : "00", "transaction_info" : { "type" : "creditcard", "transaction_creditcard_info" : { "credit_card" : { "number" : "401200******7778", "expiry_date" : { "year" : 2034, "month" : 12 }, "cardholder" : "Card Holder" } } }, "rc" : "0", "message" : "Transaction successful." }, "rc" : "0", "message" : "Transaction successful." } }, "sample_response_to_initial_request_-_method_flow_required" : { "summary" : "Proceed with 3-D Secure method flow.", "description" : "Proceed with 3-D Secure method flow.", "value" : { "outcome" : "METHOD_REQUIRED", "method_required" : { "method_request" : "ew0KICAiY29udGVudCIgOiAiZHVtbXkiDQp9" }, "rc" : "1548", "message" : "Transaction is pending." } }, "sample_response_to_initial_request_-_challenge_flow_required" : { "summary" : "Proceed with 3-D Secure challenge flow.", "description" : "Proceed with 3-D Secure challenge flow.", "value" : { "outcome" : "CHALLENGE_REQUIRED", "challenge_required" : { "acs_url" : "https://acs.example.com/acs/challenge/ew0KICAiZHVtbXkiIDogImR1bW15Ig0KfQ==", "creq" : "ew0KICAiZHVtbXkiIDogImNvbnRlbnQiDQp9" }, "rc" : "1548", "message" : "Transaction is pending." } } } } } } } } }, "/headless3DSecure/event/{event_id}/final" : { "post" : { "tags" : [ "Headless 3-D Secure" ], "summary" : "Step 3 of a headless 3-D Secure transaction: finalizes transaction.", "operationId" : "headless3DSecureFinalPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event. Use the same value as in the predecessor transaction the current transaction relates to.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Headless3DSecureFinalRequest" }, "example" : { "cres" : "ew0KICAiZXhhbXBsZSIgOiAicmVxdWVzdCINCn0=" } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Information about the outcome of the transaction.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentResponse" }, "example" : { "amount_total" : { "amount" : 100, "currency" : "EUR" }, "event_id" : "id1628241998006", "kind" : "CREDITCARD_3DS20", "tx_action" : "preauthorization", "tx_id" : "7P6cconB5vYqBQqGjyO8yR", "back_rc" : "00", "transaction_info" : { "type" : "creditcard", "transaction_creditcard_info" : { "credit_card" : { "number" : "401200******4444", "expiry_date" : { "year" : 2034, "month" : 12 }, "cardholder" : "Card Holder" } } }, "rc" : "0", "message" : "Transaction successful." } } } } } } }, "/headless3DSecure/event/{event_id}/{tx_action}/initialize" : { "post" : { "tags" : [ "Headless 3-D Secure" ], "summary" : "Step 1 of a headless 3-D Secure transaction (authorization, pre-authorization, credit, verify MOP): initializes transaction.", "operationId" : "headless3DSecureInitializePost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "authorization", "preauthorization", "credit", "verify-mop" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Headless3DSecureInitializeRequest" }, "examples" : { "sample21" : { "summary" : "Sample headless 3-D Secure initial request.", "description" : "Sample headless 3-D Secure initial request.", "value" : { "means_of_payment" : { "credit_card" : { "number" : "4012001037167778", "expiry_date" : { "year" : 2034, "month" : 12 }, "code" : "123", "cardholder" : "Card Holder" } }, "tds_20_data" : { "communication_data" : { "method_notification_url" : "https://example.com/method_notification_url", "cres_notification_url" : "https://example.com/cres_notification_url" } }, "merchant_risk_indicators" : { "delivery_email_address" : "delivery@example.com", "delivery_timeframe" : "ELECTRONIC", "gift_card_amount" : "900", "gift_card_count" : "1", "gift_card_currency" : "EUR", "pre_order_date" : "2021-10-25", "pre_order_purchase_indicator" : "AVAILABLE", "reordered_items_indicator" : "FIRST", "shipping_indicator" : "DIGITAL" }, "device_information" : { "cookies_accepted" : "true", "http_accept_browser_value" : "text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8", "http_accept_content" : "text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8", "color_depth" : "B24", "http_browser_email" : "mustermann@example.com", "http_browser_java_enabled" : "true", "http_browser_java_script_enabled" : "true", "http_browser_language" : "de-DE", "http_browser_screen_height" : "1080", "http_browser_screen_width" : "1920", "http_browser_time_difference" : "60", "ip_address" : "192.168.0.1", "user_agent" : "Mozilla", "user_agent_browser_value" : "Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Firefox/78.0" }, "amount_total" : { "amount" : 100, "currency" : "EUR" } } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Information about the outcome of the transaction.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Headless3DSecureResponse" }, "examples" : { "sample_response_to_initial_request_-_transaction_processed" : { "summary" : "Transaction has been processed, no further actions required.", "description" : "Transaction has been processed, no further actions required.", "value" : { "outcome" : "PROCESSED", "processed" : { "amount_total" : { "amount" : 100, "currency" : "EUR" }, "event_id" : "id1628241502404", "kind" : "CREDITCARD_3DS20", "tx_action" : "preauthorization", "tx_id" : "fCDszGoUje8piOUC2tVVU9", "back_rc" : "00", "transaction_info" : { "type" : "creditcard", "transaction_creditcard_info" : { "credit_card" : { "number" : "401200******7778", "expiry_date" : { "year" : 2034, "month" : 12 }, "cardholder" : "Card Holder" } } }, "rc" : "0", "message" : "Transaction successful." }, "rc" : "0", "message" : "Transaction successful." } }, "sample_response_to_initial_request_-_method_flow_required" : { "summary" : "Proceed with 3-D Secure method flow.", "description" : "Proceed with 3-D Secure method flow.", "value" : { "outcome" : "METHOD_REQUIRED", "method_required" : { "method_request" : "ew0KICAiY29udGVudCIgOiAiZHVtbXkiDQp9" }, "rc" : "1548", "message" : "Transaction is pending." } }, "sample_response_to_initial_request_-_challenge_flow_required" : { "summary" : "Proceed with 3-D Secure challenge flow.", "description" : "Proceed with 3-D Secure challenge flow.", "value" : { "outcome" : "CHALLENGE_REQUIRED", "challenge_required" : { "acs_url" : "https://acs.example.com/acs/challenge/ew0KICAiZHVtbXkiIDogImR1bW15Ig0KfQ==", "creq" : "ew0KICAiZHVtbXkiIDogImNvbnRlbnQiDQp9" }, "rc" : "1548", "message" : "Transaction is pending." } } } } } } } } }, "/headless3DSecure/event/{event_id}/method_completed/{completed}" : { "post" : { "tags" : [ "Headless 3-D Secure" ], "summary" : "Step 2 of a headless 3-D Secure transaction: processes method completion.", "operationId" : "headless3DSecureMethodCompletedPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event. Use the same value as in the predecessor transaction the current transaction relates to.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "completed", "in" : "path", "description" : "Indicates if the shop has received a request from the ACS to the methodNotificationURL within 10 seconds (true) or not (false).", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Information about the outcome of the transaction.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Headless3DSecureResponse" }, "examples" : { "sample_response_to_method_request_-_transaction_processed" : { "summary" : "Transaction has been processed, no further actions required.", "description" : "Transaction has been processed, no further actions required.", "value" : { "outcome" : "PROCESSED", "processed" : { "amount_total" : { "amount" : 100, "currency" : "EUR" }, "event_id" : "id1628241502404", "kind" : "CREDITCARD_3DS20", "tx_action" : "preauthorization", "tx_id" : "fCDszGoUje8piOUC2tVVU9", "back_rc" : "00", "transaction_info" : { "type" : "creditcard", "transaction_creditcard_info" : { "credit_card" : { "number" : "401200******7778", "expiry_date" : { "year" : 2034, "month" : 12 }, "cardholder" : "Card Holder" } } }, "rc" : "0", "message" : "Transaction successful." }, "rc" : "0", "message" : "Transaction successful." } }, "sample_response_to_method_request_-_challenge_flow_required" : { "summary" : "Proceed with 3-D Secure challenge flow.", "description" : "Proceed with 3-D Secure challenge flow.", "value" : { "outcome" : "CHALLENGE_REQUIRED", "challenge_required" : { "acs_url" : "https://acs.example.com/acs/challenge/ew0KICAiZHVtbXkiIDogImR1bW15Ig0KfQ==", "creq" : "ew0KICAiZHVtbXkiIDogImNvbnRlbnQiDQp9" }, "rc" : "1548", "message" : "Transaction is pending." } } } } } } } } }, "/iframe/initialize" : { "post" : { "tags" : [ "iFrame" ], "summary" : "Prepares an iFrame interaction.", "operationId" : "iFrameInitializePost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IFrameInitializeRequest" }, "example" : { "amount_total" : { "amount" : 100, "currency" : "EUR" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialize an iFrame interaction.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IFrameInitializeResponse" } } } } } } }, "/info/banks/psd2" : { "get" : { "tags" : [ "Info" ], "summary" : "Retrieves how banks matching the given search criteria support PSD 2 account information services.", "description" : "Finds and returns banks which match the given query parameter.\nUse either _name_ or _bic_ or _bank_code_ or _any_ for filtering. If you use _any_ banks including\nthe given value in any of the fields _name_, _bic_ or _bank_code_ will be returned. Searching is\ncarried out case-insensitive.", "operationId" : "infoBanksPSD2Get", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "name", "in" : "query", "description" : "Fragment of bank name.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Sparkasse" }, { "name" : "bic", "in" : "query", "description" : "Fragment of BIC (business identifier code).", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "bank_code", "in" : "query", "description" : "Fragment of German bank code (Bankleitzahl, BLZ).", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "any", "in" : "query", "description" : "Fragment of either bank name, BIC or bank code.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "offset", "in" : "query", "description" : "Number of rows to skip at the beginning of the total result set.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of result items to be returned.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Paged response with matching banks.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PSD2BankResults" }, "example" : { "metadata" : { "limit" : 10, "offset" : 0, "total" : 2 }, "banks" : [ { "name" : "Sparkasse KölnBonn", "town" : "Köln", "bic" : "COLSDE33XXX", "bank_code" : "37050198", "psd2_supported" : false }, { "id" : "lsw", "name" : "Stadt- und Kreissparkasse Leipzig", "town" : "Leipzig", "bic" : "WELADE8LXXX", "bank_code" : "86055592", "psd2_supported" : true, "capabilities" : [ "AVAILABLE_ACCOUNTS", "AVAILABLE_ACCOUNTS_WITH_BALANCE", "GLOBAL_CONSENT" ] } ] } } } } } } }, "/info/event/{event_id}/psd2/account_info" : { "get" : { "tags" : [ "Info" ], "summary" : "Retrieves bank account details which were stored in a previous PSD 2 account information transaction.", "operationId" : "infoPsd2AccountInfoGet", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Bank account details which were stored in a previous step.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PSD2AccountInfoResponse" } } } } } } }, "/managedmandate/{mandate_id}/{action}" : { "post" : { "tags" : [ "Managed Mandate" ], "summary" : "Manages a SDD mandate.", "operationId" : "managedmandateDiscardPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "mandate_id", "in" : "path", "description" : "Mandate ID.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" }, "example" : "57e1bf82d3764e58b3b04a1c249e1282" }, { "name" : "action", "in" : "path", "description" : "Action.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "Actions for ManagedMandate service.\n | * 'discard' - discard a mandate.\n ", "example" : "discard", "enum" : [ "discard" ] }, "example" : "discard" } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Mandate is successfully changed.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } } } } } }, "/payment/event/{event_id}/creditcard/{tx_action}" : { "post" : { "tags" : [ "Payment" ], "summary" : "Creates an initial creditcard payment transaction (authorization, pre-authorization, credit, or verify MOP).", "operationId" : "paymentCreditCardPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "authorization", "preauthorization", "credit", "verify-mop" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentCreditCardRequestInitial" }, "example" : { "amount_total" : { "amount" : 100, "currency" : "EUR" }, "means_of_payment" : { "credit_card" : { "number" : "4111111111111111", "expiry_date" : { "year" : 2027, "month" : 12 }, "code" : "111", "card_holder" : "Rene Meier" } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Information about the payment", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentResponse" } } } } } } }, "/payment/event/{event_id}/directdebit/{tx_action}" : { "post" : { "tags" : [ "Payment" ], "summary" : "Creates an initial SDD payment transaction (pre-authorization, authorization, credit, or verify MOP).", "operationId" : "paymentDirectDebitPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "authorization", "preauthorization", "credit", "verify-mop" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentDirectDebitRequestInitial" }, "example" : { "amount_total" : { "amount" : 100, "currency" : "EUR" }, "means_of_payment" : { "bank_account" : { "account_holder" : "Rene Meier", "iban" : "DE39123456790009290701" } }, "mandate" : { "reference" : "MDT1620213727383XY", "mandate_name" : "Sample mandate name", "signed_on" : "2020-12-30", "mandate_sequence_type" : "ONEOFF" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "The request has been processed.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentResponse" } } } } } } }, "/payment/event/{event_id}" : { "get" : { "tags" : [ "Payment" ], "summary" : "Retrieves details of an event (consisting of one or more transactions).", "operationId" : "paymentEventGet", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "The request has been processed.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentDiagnosisEventResponse" } } } } } } }, "/payment/event/{event_id}/klarna/{tx_action}" : { "post" : { "tags" : [ "Payment" ], "summary" : "Creates an initial Klarna payment transaction (pre-authorization, authorization).", "operationId" : "paymentKlarnaPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "authorization", "preauthorization" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentKlarnaRequestInitial" }, "example" : { "customer_information" : { "date_of_birth" : "1980-01-01" }, "shipping_address" : { "title" : "Ms", "first_name" : "Jane", "last_name" : "Doe", "email" : "test_jane@gmail.com", "address_line_1" : "Main Street 123", "address_line_2" : "Building A", "address_line_3" : "Apartment 12", "postal_code" : "80469", "phone_contact" : { "phone_type" : "MOBILE", "phone_number" : "+4917614287464" }, "city" : "Munich", "country" : "DE", "extensions" : { } }, "billing_address" : { "title" : "Ms", "first_name" : "Jane", "last_name" : "Doe", "email" : "test_jane@gmail.com", "address_line_1" : "Main Street 123", "address_line_2" : "Building A", "address_line_3" : "Apartment 12", "postal_code" : "80469", "phone_contact" : { "phone_type" : "MOBILE", "phone_number" : "+4917614287464" }, "city" : "Munich", "country" : "DE", "extensions" : { "klarna_data" : { "custom_payment_method_ids" : [ ] } } }, "basket" : { "basket_id" : "basket123456", "invoice_id" : "RE123345", "soft_descriptor" : "800-123-1234", "shipping_costs" : { "amount" : 200, "currency" : "EUR" }, "basket_type" : "DIGITAL", "extensions" : { "paypal_data" : { "custom_id" : "CUSTOMID123" } }, "basket_items" : [ { "name" : "A fine shirt", "description" : "BI123456", "reference" : "UGG-BB-PUR-06", "quantity" : { "quantity_amount" : 5, "quantity_unit" : "pcs" }, "unit_price" : { "net" : 100, "gross" : 100, "currency" : "EUR", "tax" : 1900 }, "discount" : { "net" : 0, "gross" : 0, "currency" : "EUR", "tax" : 1900 }, "extensions" : { "klarna_data" : { "klarna_type" : "PHYSICAL", "image_url" : "https://upload.wikimedia.org/wikipedia/commons/thumb/a/a5/Camisade_pu%C3%B1o_doble.jpg/256px-Camisade_pu%C3%B1o_doble.jpg" } } } ] }, "form_data" : { "locale" : "en" }, "amount_total" : { "amount" : 700, "currency" : "EUR" }, "merchant_information" : { "merchant_data_1" : "merchantData1", "merchant_data_2" : "merchantData2", "merchant_data_3" : "merchantData3" }, "means_of_payment" : { "alias" : "AliAss" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "The request has been processed.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentResponse" } } } } } } }, "/payment/event/{event_id}/tx/{tx_id}/{tx_action}" : { "post" : { "tags" : [ "Payment" ], "summary" : "Creates a subsequent transaction (capture, reversal, or refund) referencing a predecessor transaction (pre-authorization, authorization, or credit).", "operationId" : "paymentTxActionPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event. Use the same value as in the predecessor transaction the current transaction relates to.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_id", "in" : "path", "description" : "A reference to a transaction retrieved in a response (tx_reference_id).", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[/0-9a-zA-Z=_-]+", "type" : "string" }, "example" : "020LMG10jxSI8FN0OC4vLR" }, { "name" : "tx_action", "in" : "path", "description" : "The action of a subsequent transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "capture", "reversal", "refund" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentRequestSubsequent" }, "examples" : { "sample21" : { "summary" : "Sample credit card subsequent transaction", "description" : "Sample credit card subsequent transaction", "value" : { "kind" : "CREDITCARD", "basket" : { "basket_id" : "basket123456" } } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "The request has been processed.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentResponse" } } } } } } }, "/payment/tx/{tx_id}" : { "get" : { "tags" : [ "Payment" ], "summary" : "Retrieves details of a (single) transaction.", "operationId" : "paymentTxGet", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "tx_id", "in" : "path", "description" : "A reference to a transaction retrieved in a response (tx_reference_id).", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[/0-9a-zA-Z=_-]+", "type" : "string" }, "example" : "020LMG10jxSI8FN0OC4vLR" } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "The request has been processed.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentResponse" } } } } } } }, "/paymentlink/event/{event_id}/checkout/{tx_action}" : { "post" : { "tags" : [ "Payment Link" ], "summary" : "Creates a link to a checkout page you can forward to your customer. Later, the customer can use\n this link to choose one of the offered means of payments \n (credit card, SDD, PayPal, Request to Pay, Sofortüberweisung, giropay, and paydirekt) and then carry out the payment.", "operationId" : "paymentlinkCheckoutPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } }, { "name" : "tx_action", "in" : "path", "description" : "The action of an initial transaction.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "authorization", "preauthorization", "verify-mop" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentLinkRequest" }, "example" : { "expires" : "2022-12-19T19:11:59.212", "checkout_page_configuration" : { "direct_debit_data" : { "mandate" : { "reference" : "MDT1620213727383XY", "mandate_name" : "Sample mandate name", "signed_on" : "2020-12-30", "mandate_sequence_type" : "ONEOFF" } }, "request_to_pay_data" : { "customer_id" : "testCustrID" }, "checkout_entry_sorting_order" : [ "DIRECTDEBIT", "REQUEST_TO_PAY" ] }, "basket" : { "basket_id" : "basketId1639066152436", "order_amount" : { "amount" : 900, "currency" : "EUR" }, "shipping_costs" : { "amount" : 100, "currency" : "EUR" }, "basket_type" : "PHYSICAL", "basket_items" : [ { "name" : "PhysicalBasketItem", "description" : "A basket item", "quantity" : { "quantity_amount" : 1, "quantity_unit" : "pcs" }, "unit_price" : { "net" : 756, "gross" : 900, "currency" : "EUR", "tax" : 1900 } } ] }, "amount_total" : { "amount" : 100, "currency" : "EUR" }, "form_customer_continuation" : { "success_url" : "https://www.example.com/target.php?success", "error_url" : "https://www.example.com/target.php?error", "notification_failed_url" : "https://www.example.com/target.php?notifyfailed" }, "callback" : { "notify_url" : "http://www.example.com/notify" } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Values required to initialize a form interaction, a return code and a message. In case of a known business or persistence error,\n only error code and message are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentLinkResponse" } } } } } } }, "/paymentlink/event/{event_id}" : { "get" : { "tags" : [ "Payment Link" ], "summary" : "Retrieves details of a payment link.", "operationId" : "paymentlinkEventGet", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "The request has been processed.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentLinkEventResponse" } } } } } } }, "/paymentlink/event/{event_id}/deactivate" : { "post" : { "tags" : [ "Payment Link" ], "summary" : "Deactivates a payment link.", "operationId" : "paymentlinkManagementDeactivatePost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Response of the deactivation request of the payment link.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentLinkEventResponse" } } } } } } }, "/paymentlink/event/{event_id}/update" : { "post" : { "tags" : [ "Payment Link" ], "summary" : "Updates a payment link.", "operationId" : "paymentlinkManagementUpdatePost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentLinkManagementUpdateRequest" }, "example" : { "expires" : "2022-11-29T19:41:30" } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Response of the update request of the payment link.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentLinkEventResponse" } } } } } } }, "/riskmanagement/entry/{event_id}" : { "post" : { "tags" : [ "Risk Management" ], "summary" : "Adds data to or deletes data from the positive or the negative list.", "operationId" : "riskmanagementEntryPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RiskmanagementEntryRequest" }, "examples" : { "sample21" : { "summary" : "Sample risk management entry request.", "description" : "sample21", "value" : { "credit_card_data" : { "number" : "4000056655665556", "code" : "123", "cardholder" : "Card T. Holder", "expiry_date" : { "year" : 2028, "month" : 11 } }, "bank_account" : { "bic" : "HYVEDEMMXXX", "iban" : "DE02700202700010108669", "account_holder" : "Rene Meier", "bank_name" : "UniCredit Bank - HypoVereinsbank" }, "address" : { "first_name" : "Fritz", "last_name" : "Mustermann", "address_line_1" : "Musterteichstr 18", "address_line_2" : "EG R. 184", "address_line_3" : "Wohnhaus", "state" : "SN", "postal_code" : "94347", "city" : "Musterhausen", "country" : "DE" }, "billing_address" : { "first_name" : "Heinz", "last_name" : "Mustermann", "address_line_1" : "Musterstraße 18", "address_line_2" : "EG Rechnungsraum. 184", "address_line_3" : "Rechnungsgebäude/Buchhaltung", "state" : "SN", "postal_code" : "84347", "city" : "Musterstadt", "country" : "DE", "email" : "heinz.mustermann@example.com", "phone_contact" : { "phone_type" : "MOBILE", "phone_number" : "+442071838750" } }, "shipping_address" : { "first_name" : "Klaus", "last_name" : "Mustermann", "address_line_1" : "Musterstratße 7", "address_line_2" : "2. OG Lieferraum 333", "address_line_3" : "Lieferhaus", "state" : "BE", "postal_code" : "10243", "city" : "Musterdorf", "country" : "DE" }, "amount_total" : { "amount" : "100050", "currency" : "EUR" }, "basket" : { "basket_id" : "123456-basketId-dummy", "order_amount" : { "amount" : "100050", "currency" : "EUR" }, "shipping_costs" : { "amount" : "50", "currency" : "EUR" }, "basket_type" : "PHYSICAL", "basket_items" : [ { "name" : "productName1", "description" : "productDescription1", "reference" : "reference1", "quantity" : { "quantity_amount" : 1, "quantity_unit" : "pcs" }, "unit_price" : { "net" : "84034", "gross" : "100000", "currency" : "EUR", "tax" : "1900" }, "item_discount" : { "net" : "0", "gross" : "0", "currency" : "EUR", "tax" : "1900" }, "extensions" : { "riskcheck_data" : { "riskcheck_type" : "SHIPPING_ONLY", "distributor_product_sku" : "1234567890", "gift_card_currency" : "EUR", "is_gift" : "false", "product_risk" : "LOW", "risk_check_passenger" : { "type" : "ADT", "status" : "standard", "phone" : { "phone_type" : "MOBILE", "phone_number" : "+4917223456789" }, "first_name" : "Maria", "last_name" : "Musterfrau", "id" : "B7564", "email" : "maria.musterfrau@passenger.com", "country" : "DE" }, "shipping_destination_types" : "RESIDENTIAL" } } } ] }, "device_information" : { "cookies_accepted" : "true", "http_accept_browser_value" : "text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8", "http_accept_content" : "text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8", "color_depth" : "B24", "http_browser_email" : "mustermann@example.com", "http_browser_java_enabled" : "true", "http_browser_java_script_enabled" : "true", "http_browser_language" : "de-DE", "http_browser_screen_height" : "1080", "http_browser_screen_width" : "1920", "http_browser_time_difference" : "60", "ip_address" : "192.168.0.1", "user_agent" : "Mozilla", "user_agent_browser_value" : "Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Firefox/78.0" }, "customer_information" : { "date_of_birth" : "1985-12-30", "gender" : "FEMALE", "title" : "Prof. Dr. Dr.", "personal_identifications" : [ ], "contacts" : { "phone_contacts" : [ { "phone_type" : "MOBILE", "phone_number" : "+442071838750" }, { "phone_type" : "FAX", "phone_number" : "+442071838751" } ] } }, "reason" : "SUSPECTED", "action" : "DELETE", "list_name" : "NEGATIVE" } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Indicates the list interaction to add/remove an entry was performed. Result can be success or information regarding the problems occured.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RiskmanagementEntryResponse" } } } } } } }, "/riskmanagement/scoring/{event_id}" : { "post" : { "tags" : [ "Risk Management" ], "summary" : "Calculates risk score of given data.", "operationId" : "riskmanagementScoringPost", "parameters" : [ { "name" : "Merchant-ID", "in" : "header", "description" : "Unique identification of the merchant for whom the transaction is carried out. This parameter is required if the `Merchant-ID` cannot be derived from the `client_id` you used for authentication.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 10, "minLength" : 10, "pattern" : "[0-9]+", "type" : "string" } }, { "name" : "event_id", "in" : "path", "description" : "A unique ID for the event.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RiskmanagementScoringRequest" }, "examples" : { "sample21" : { "summary" : "Sample risk management scoring request.", "description" : "sample21", "value" : { "credit_card_data" : { "number" : "4000056655665556", "code" : "123", "cardholder" : "Card T. Holder", "expiry_date" : { "year" : 2028, "month" : 11 } }, "bank_account" : { "bic" : "HYVEDEMMXXX", "iban" : "DE02700202700010108669", "account_holder" : "Rene Meier", "bank_name" : "UniCredit Bank - HypoVereinsbank" }, "address" : { "first_name" : "Fritz", "last_name" : "Mustermann", "address_line_1" : "Musterteichstr 18", "address_line_2" : "EG R. 184", "address_line_3" : "Wohnhaus", "state" : "SN", "postal_code" : "94347", "city" : "Musterhausen", "country" : "DE" }, "billing_address" : { "first_name" : "Heinz", "last_name" : "Mustermann", "address_line_1" : "Musterstraße 18", "address_line_2" : "EG Rechnungsraum. 184", "address_line_3" : "Rechnungsgebäude/Buchhaltung", "state" : "SN", "postal_code" : "84347", "city" : "Musterstadt", "country" : "DE", "email" : "heinz.mustermann@example.com", "phone_contact" : { "phone_type" : "MOBILE", "phone_number" : "+442071838750" } }, "amount_total" : { "amount" : "100050", "currency" : "EUR" }, "basket" : { "basket_id" : "123456-basketId-dummy", "order_amount" : { "amount" : "100000", "currency" : "EUR" }, "shipping_costs" : { "amount" : "50", "currency" : "EUR" }, "basket_type" : "PHYSICAL", "basket_items" : [ { "name" : "productName1", "description" : "productDescription1", "reference" : "reference1", "quantity" : { "quantity_amount" : 1, "quantity_unit" : "pcs" }, "unit_price" : { "net" : "84034", "gross" : "100000", "currency" : "EUR", "tax" : "1900" }, "item_discount" : { "net" : "0", "gross" : "0", "currency" : "EUR", "tax" : "1900" }, "extensions" : { "riskcheck_data" : { "riskcheck_type" : "SHIPPING_ONLY", "distributor_product_sku" : "1234567890", "gift_card_currency" : "EUR", "is_gift" : "false", "product_risk" : "LOW", "risk_check_passenger" : { "type" : "ADT", "status" : "standard", "phone" : { "phone_type" : "MOBILE", "phone_number" : "+4917223456789" }, "first_name" : "Maria", "last_name" : "Musterfrau", "id" : "B7564", "email" : "maria.musterfrau@passenger.com", "country" : "DE" }, "shipping_destination_types" : "RESIDENTIAL" } } } ] }, "shipping_address" : { "first_name" : "Klaus", "last_name" : "Mustermann", "email" : "klaus-mustermann-shipping@example.com", "address_line_1" : "Musterstratße 7", "address_line_2" : "2. OG Lieferraum 333", "address_line_3" : "Lieferhaus", "state" : "BE", "postal_code" : "10243", "city" : "Musterdorf", "country" : "DE" }, "customer_information" : { "date_of_birth" : "1985-12-30", "gender" : "FEMALE", "title" : "Prof. Dr. Dr.", "personal_identifications" : [ { "type" : "PASSPORT", "id" : "T220001297", "issued_by" : "DE" }, { "type" : "DRIVERS_LICENSE", "id" : "DL220001297", "issued_by" : "BE" } ], "contacts" : { "phone_contacts" : [ { "phone_type" : "MOBILE", "phone_number" : "+442071838750" }, { "phone_type" : "FAX", "phone_number" : "+442071838751" } ] } }, "device_information" : { "cookies_accepted" : "true", "http_accept_browser_value" : "text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8", "http_accept_content" : "text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8", "color_depth" : "B24", "http_browser_email" : "mustermann@example.com", "http_browser_java_enabled" : "true", "http_browser_java_script_enabled" : "true", "http_browser_language" : "de-DE", "http_browser_screen_height" : "1080", "http_browser_screen_width" : "1920", "http_browser_time_difference" : "60", "ip_address" : "192.168.0.1", "user_agent" : "Mozilla", "user_agent_browser_value" : "Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Firefox/78.0" }, "account_information" : { "account_change_date" : "2021-10-25", "account_creation_indicator" : "GUEST", "account_id" : "MC_ACC_12345678", "account_opened_date" : "2021-10-25", "modification_indicator" : "ACCOUNT_UPDATED_NOW", "password_change_date" : "2021-10-25", "password_change_indicator" : "PASSWORD_CHANGED_NOW", "payment_account_date" : "2021-10-25", "payment_account_history" : "PAYMENT_ACCOUNT_ADDED_NOW", "add_card_attempts" : "1", "provisioning_day_count" : "1", "purchases_six_month_count" : "2", "shipping_address_first_use_date" : "2021-10-25", "shipping_address_first_use" : "false", "shipping_name_indicator" : "02", "suspicious_account_activity" : "false", "transactions_day_count" : "1", "transactions_year_count" : "1" }, "merchant_risk_indicators" : { "delivery_email_address" : "delivery@example.com", "delivery_timeframe" : "MORE_THAN_ONE_DAY", "gift_card_amount" : "0", "gift_card_count" : "0", "gift_card_currency" : "EUR", "pre_order_date" : "2021-10-25", "pre_order_purchase_indicator" : "AVAILABLE", "reordered_items_indicator" : "FIRST", "shipping_indicator" : "DIGITAL" }, "travel_information" : { "actual_final_destination" : "LEJ", "complete_route" : "LEJ-LHR:LHR-JFK:JFK-LHR:LHR-LEJ", "departure_time" : "2024-07-01T07:40+01:00", "journey_type" : "ROUNDTRIP", "legs" : [ { "origination" : "LEJ", "destination" : "LHR", "carrier_code" : "LH", "departure_date" : "20240701" }, { "origination" : "LHR", "destination" : "JFK", "carrier_code" : "BA", "departure_date" : "20240701" }, { "origination" : "JFK", "destination" : "LHR", "carrier_code" : "BA", "departure_date" : "20240714" }, { "origination" : "LHR", "destination" : "LEJ", "carrier_code" : "LH", "departure_date" : "20240714" } ], "number_of_passengers" : 2, "passengers" : [ { "first_name" : "Heinz", "last_name" : "Mueller" }, { "first_name" : "Klaus", "last_name" : "Mueller" } ] }, "merchant_defined_information" : [ { "key" : "11", "value" : "nightly_order" }, { "key" : "2", "value" : "high_volume_order" }, { "key" : "52", "value" : "donation" }, { "key" : "99", "value" : "multi-packaging" }, { "key" : "100", "value" : "reordered-8times" }, { "key" : "103", "value" : "devices" } ], "risk_check_additional_information" : { "fingerprint_session_id" : "1234567890-0000000005" } } } } } } }, "responses" : { "400" : { "description" : "Response in case of an error. Includes a response code and an error message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "401" : { "description" : "Unauthorized request. Response body may be empty.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorModel" } } } }, "200" : { "description" : "Calculates the score of the given data and gives back more detailed information regarding the result calculation.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RiskmanagementScoringResponse" } } } } } } } }, "components" : { "schemas" : { "ErrorModel" : { "required" : [ "message", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Four digit response code.", "example" : "4001" }, "message" : { "type" : "string", "description" : "Describes the error.", "example" : "unexpected error" } }, "description" : "Includes data returned in case of an error." }, "AddressPaydirektData" : { "type" : "object", "properties" : { "addon" : { "maxLength" : 100, "minLength" : 0, "type" : "string", "description" : "Additional address information.", "example" : "Apartment 12A" } }, "description" : "Paydirekt specific address fields." }, "AliasInfo" : { "type" : "object", "properties" : { "alias" : { "type" : "string", "description" : "Name of the alias.", "example" : "da2c9029-b180-42a7-b473-50d182a01f8a" }, "credit_card" : { "$ref" : "#/components/schemas/CreditCardInfo" }, "bank_account" : { "$ref" : "#/components/schemas/BankAccount" }, "address" : { "$ref" : "#/components/schemas/CommonAddress" } }, "description" : "Contains information about the created or updated alias. This field is null if the there was no 'alias_info' in the request." }, "AliasResponse" : { "required" : [ "message", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "alias_info" : { "$ref" : "#/components/schemas/AliasInfo" } }, "description" : "Common response of all alias requests." }, "AlternativeAddressData" : { "type" : "object", "properties" : { "street" : { "maxLength" : 100, "minLength" : 0, "type" : "string", "description" : "The street.", "example" : "Main Street" }, "street_number" : { "maxLength" : 10, "minLength" : 0, "type" : "string", "description" : "The street number.", "example" : "123a" } }, "description" : "Alternative address fields." }, "BankAccount" : { "required" : [ "iban" ], "type" : "object", "properties" : { "bic" : { "maxLength" : 11, "minLength" : 11, "pattern" : "[A-Z]{6}[A-Z2-9][A-NP-Z0-9][A-Z0-9]{3}", "type" : "string", "description" : "The business identifier code (BIC) of a bank account. If the branch identifier\n (positions 9 to 11) is not applicable, it is set to \"XXX\". ", "example" : "VZVDDED1XXX" }, "iban" : { "maxLength" : 34, "minLength" : 15, "pattern" : "[A-Z]{2}[0-9]{2}[A-Z0-9*]{11,30}", "type" : "string", "description" : "The international bank account number of a bank account.", "example" : "DE17215730140403340300" }, "account_holder" : { "maxLength" : 27, "minLength" : 1, "pattern" : ".*", "type" : "string", "description" : "The account holder of the bank account.", "example" : "Max Muster" }, "bank_name" : { "type" : "string", "description" : "Name of the bank.", "example" : "Musterbank" } }, "description" : "Information about a bank account." }, "CommonAddress" : { "type" : "object", "properties" : { "title" : { "type" : "string", "description" : "Customer's title.", "example" : "Ms" }, "first_name" : { "maxLength" : 60, "minLength" : 0, "type" : "string", "description" : "First name of the individual.", "example" : "Jane" }, "last_name" : { "maxLength" : 60, "minLength" : 0, "type" : "string", "description" : "Last name of the individual.", "example" : "Doe" }, "company_name" : { "maxLength" : 60, "minLength" : 0, "type" : "string", "description" : "Name of the company.", "example" : "Acme Inc." }, "email" : { "maxLength" : 255, "minLength" : 0, "type" : "string", "description" : "Email address of the individual.", "example" : "test_jane@gmail.com" }, "phone_contact" : { "$ref" : "#/components/schemas/PhoneContact" }, "address_line_1" : { "maxLength" : 60, "minLength" : 0, "type" : "string", "description" : "An address line.", "example" : "Main Street 123" }, "address_line_2" : { "maxLength" : 60, "minLength" : 0, "type" : "string", "description" : "An address line. For 3DS this maps to additional1.", "example" : "Building A" }, "address_line_3" : { "maxLength" : 60, "minLength" : 0, "type" : "string", "description" : "An address line. For 3DS this maps to additional2.", "example" : "Apartment 12" }, "postal_code" : { "maxLength" : 60, "minLength" : 0, "type" : "string", "description" : "Postal code of the address.", "example" : "80469" }, "city" : { "maxLength" : 60, "minLength" : 0, "type" : "string", "description" : "City of the address.", "example" : "Munich" }, "state" : { "maxLength" : 300, "minLength" : 0, "type" : "string", "description" : "State or province of the address.", "example" : "BY" }, "country" : { "maxLength" : 2, "minLength" : 2, "pattern" : "[A-Z]{2}", "type" : "string", "description" : "The ISO 3166 Alpha-2 country code (upper case) of the individual's homeland.", "example" : "DE" }, "extensions" : { "$ref" : "#/components/schemas/CommonAddressExtensions" } }, "description" : "Address data as applicable to most use cases." }, "CommonAddressExtensions" : { "type" : "object", "properties" : { "alternative_address_data" : { "$ref" : "#/components/schemas/AlternativeAddressData" }, "paydirekt_data" : { "$ref" : "#/components/schemas/AddressPaydirektData" } }, "description" : "Service specific address fields." }, "CreditCardInfo" : { "required" : [ "expiry_date", "number" ], "type" : "object", "properties" : { "number" : { "maxLength" : 19, "minLength" : 10, "pattern" : "[0-9]*", "type" : "string", "description" : "The credit card number (Primary Account Number). It is sometimes masked in response messages, for example 411111******1111.", "example" : "41111111111111111" }, "expiry_date" : { "$ref" : "#/components/schemas/ExpiryDate" }, "cardholder" : { "maxLength" : 27, "minLength" : 1, "type" : "string", "description" : "The holder of a credit card.", "example" : "Max Muster" }, "brand" : { "type" : "string", "description" : "The credit card brand. The use of this field requires an explicit activation. Please contact customer support. Possible values: \n \n* `AMEX`\n* `DINERS`\n* `JCB`\n* `MAESTRO`\n* `MASTERCARD`\n* `VISA` \n", "example" : "VISA", "enum" : [ "AMEX", "DINERS", "JCB", "MAESTRO", "MASTERCARD", "VISA" ] }, "issuer_country" : { "type" : "string", "description" : "The card issuers country of origin. The use of this field requires an explicit activation. Please contact customer support." } }, "description" : "Information about a credit card." }, "ExpiryDate" : { "required" : [ "month", "year" ], "type" : "object", "properties" : { "year" : { "maximum" : 2099, "minimum" : 2000, "type" : "integer", "description" : "The credit card expiry year.", "format" : "int32", "example" : 2021 }, "month" : { "maximum" : 12, "minimum" : 1, "type" : "integer", "description" : "The credit card expiry month.", "format" : "int32", "example" : 11 } }, "description" : "The credit card expiry date." }, "PhoneContact" : { "required" : [ "phone_number", "phone_type" ], "type" : "object", "properties" : { "phone_type" : { "type" : "string", "description" : "The phone type.\n\n* `FAX`\n* `HOME`\n* `MOBILE`\n* `OTHER`\n* `PAGER`\n* `WORK`\n", "example" : "FAX", "enum" : [ "FAX", "HOME", "MOBILE", "OTHER", "PAGER", "WORK" ] }, "phone_number" : { "maxLength" : 16, "minLength" : 0, "pattern" : "\\+[1-9]\\d{1,14}", "type" : "string", "description" : "A phone number in its canonical international E.164 numbering plan format.", "example" : "+442071838750" } }, "description" : "A means of contacting a customer by phone.", "example" : { "phone_type" : "FAX", "phone_number" : "+442071838750" } }, "AliasBankAccountRequest" : { "type" : "object", "properties" : { "alias" : { "maxLength" : 50, "minLength" : 0, "type" : "string", "description" : "The alias value. If no value is set an alias is created by the system.", "example" : "221f56ca355d8e6c42517749cf79ceb8" }, "token" : { "maxLength" : 500, "minLength" : 0, "pattern" : "[a-zA-Z0-9/+=_-]*", "type" : "string", "description" : "The token value.", "example" : "eyJ0IjoiSFcyaS13cTB3PT0iLCJzIjoiaWIybzFRMHEifQ" }, "bank_account" : { "$ref" : "#/components/schemas/BankAccount" }, "address" : { "$ref" : "#/components/schemas/CommonAddress" } }, "description" : "Contains information used to create an alias for a bank account. Either `token` or `bank_account` must be specified." }, "BaseResponse" : { "required" : [ "message", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." } } }, "AliasCreditCardRequest" : { "type" : "object", "properties" : { "alias" : { "maxLength" : 50, "minLength" : 0, "type" : "string", "description" : "The alias value. If no value is set an alias is created by the system.", "example" : "221f56ca355d8e6c42517749cf79ceb8" }, "token" : { "maxLength" : 500, "minLength" : 0, "pattern" : "[a-zA-Z0-9/+=_-]*", "type" : "string", "description" : "The token value.", "example" : "eyJ0IjoiSFcyaS13cTB3PT0iLCJzIjoiaWIybzFRMHEifQ" }, "credit_card" : { "$ref" : "#/components/schemas/CreditCard" } }, "description" : "Contains information used to create an alias for a credit card. Either `token` or `credit_card` must be specified." }, "CreditCard" : { "required" : [ "expiry_date", "number" ], "type" : "object", "properties" : { "number" : { "maxLength" : 19, "minLength" : 10, "pattern" : "[0-9]*", "type" : "string", "description" : "The credit card number (Primary Account Number). It is sometimes masked in response messages, for example 411111******1111.", "example" : "41111111111111111" }, "expiry_date" : { "$ref" : "#/components/schemas/ExpiryDate" }, "code" : { "maxLength" : 4, "minLength" : 3, "pattern" : "[0-9]*", "type" : "string", "description" : "Card verification number of the credit card (also CVV or CVC).", "example" : "332" }, "cardholder" : { "maxLength" : 27, "minLength" : 1, "type" : "string", "description" : "The holder of a credit card.", "example" : "Max Muster" } }, "description" : "Information about a credit card." }, "ApplePayPaymentSessionResponse" : { "required" : [ "message", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "applepay_payment_session_token" : { "maxLength" : 10000, "minLength" : 1, "pattern" : "[a-zA-Z0-9:,\\/+=_\\-\\\\\\{\\}\\[\\]\\\"\r\n\t ]*", "type" : "string", "description" : "The Base64 encoded stringified payment session response from Apple Pay™.", "example" : "ewoJImVwb2NoVGltZXN0YW1wIjoxNjYzNzU0OTQwMDY5LAoJImV4cGlyZXNBdCI6MTY2Mzc1ODU0MDA2OSwKCSJtZXJjaGFudFNlc3Npb25JZGVudGlmaWVyIjoiU1NINTk3RjRCQjk5MkMzNEEzNjgwNDkwNTc1RjhEMTJBQ0NfQzIzQTBEMzAyNEZBQjhCMTJDQkI2NzY2MEI0QzFCNDhBQkYxMjcyRUM4QjYxMzk5RTNBNjQ3MjkwQzhCRTY3QSIsCgkibm9uY2UiOiI4NmI1ZDlmMSIsCgkibWVyY2hhbnRJZGVudGlmaWVyIjoiMjg3MzJBNEYwNUFFMDU1NTAwNzc2NDJDQzZCQUJBOEM1OTIzRTM0N0EwODM4MDNDMEI3QTgwODg3MTBDMzFFNCIsCgkiZG9tYWluTmFtZSI6InRlc3RtZXJjaC5kaXJlY3Rwb3MuZGUiLAoJImRpc3BsYXlOYW1lIjoiREIucHJvY2Vzc2luZ3BhZ2F0ZXEubWVyY2hhbnRzb2x1dGlvbiIsCgkic2lnbmF0dXJlIjoiMzA4MDA2MDkyYTg2NDg4NmY3MGQwMTA3MDJhMDgwMzA4MDAyMDEwMTMxMGYzMDBkMDYwOTYwODY0ODAxNjUwMzA0MDIwMTA1MDAzMDgwMDYwOTJhODY0ODg2ZjcwZDAxMDcwMTAwMDBhMDgwMzA4MjAzZTMzMDgyMDM4OGEwMDMwMjAxMDIwMjA4NGMzMDQxNDk1MTlkNTQzNjMwMGEwNjA4MmE4NjQ4Y2UzZDA0MDMwMjMwN2EzMTJlMzAyYzA2MDM1NTA0MDMwYzI1NDE3MDcwNmM2NTIwNDE3MDcwNmM2OTYzNjE3NDY5NmY2ZTIwNDk2ZTc0NjU2NzcyNjE3NDY5NmY2ZTIwNDM0MTIwMmQyMDQ3MzMzMTI2MzAyNDA2MDM1NTA0MGIwYzFkNDE3MDcwNmM2NTIwNDM2NTcyNzQ2OTY2Njk2MzYxNzQ2OTZmNmUyMDQxNzU3NDY4NmY3MjY5NzQ3OTMxMTMzMDExMDYwMzU1MDQwYTBjMGE0MTcwNzA2YzY1MjA0OTZlNjMyZTMxMGIzMDA5MDYwMzU1MDQwNjEzMDI1NTUzMzAxZTE3MGQzMTM5MzAzNTMxMzgzMDMxMzMzMjM1Mzc1YTE3MGQzMjM0MzAzNTMxMzYzMDMxMzMzMjM1Mzc1YTMwNWYzMTI1MzAyMzA2MDM1NTA0MDMwYzFjNjU2MzYzMmQ3MzZkNzAyZDYyNzI2ZjZiNjU3MjJkNzM2OTY3NmU1ZjU1NDMzNDJkNTA1MjRmNDQzMTE0MzAxMjA2MDM1NTA0MGIwYzBiNjk0ZjUzMjA1Mzc5NzM3NDY1NmQ3MzMxMTMzMDExMDYwMzU1MDQwYTBjMGE0MTcwNzA2YzY1MjA0OTZlNjMyZTMxMGIzMDA5MDYwMzU1MDQwNjEzMDI1NTUzMzA1OTMwMTMwNjA3MmE4NjQ4Y2UzZDAyMDEwNjA4MmE4NjQ4Y2UzZDAzMDEwNzAzNDIwMDA0YzIxNTc3ZWRlYmQ2YzdiMjIxOGY2OGRkNzA5MGExMjE4ZGM3YjBiZDZmMmMyODNkODQ2MDk1ZDk0YWY0YTU0MTFiODM0MjBlZDgxMWYzNDA3ZTgzMzMxZjFjNTRjM2Y3ZWIzMjIwZDZiYWQ1ZDRlZmY0OTI4OTg5M2U3YzBmMTNhMzgyMDIxMTMwODIwMjBkMzAwYzA2MDM1NTFkMTMwMTAxZmYwNDAyMzAwMDMwMWYwNjAzNTUxZDIzMDQxODMwMTY4MDE0MjNmMjQ5YzQ0ZjkzZTRlZjI3ZTZjNGY2Mjg2YzNmYTJiYmZkMmU0YjMwNDUwNjA4MmIwNjAxMDUwNTA3MDEwMTA0MzkzMDM3MzAzNTA2MDgyYjA2MDEwNTA1MDczMDAxODYyOTY4NzQ3NDcwM2EyZjJmNmY2MzczNzAyZTYxNzA3MDZjNjUyZTYzNmY2ZDJmNmY2MzczNzAzMDM0MmQ2MTcwNzA2YzY1NjE2OTYzNjEzMzMwMzIzMDgyMDExZDA2MDM1NTFkMjAwNDgyMDExNDMwODIwMTEwMzA4MjAxMGMwNjA5MmE4NjQ4ODZmNzYzNjQwNTAxMzA4MWZlMzA4MWMzMDYwODJiMDYwMTA1MDUwNzAyMDIzMDgxYjYwYzgxYjM1MjY1NmM2OTYxNmU2MzY1MjA2ZjZlMjA3NDY4Njk3MzIwNjM2NTcyNzQ2OTY2Njk2MzYxNzQ2NTIwNjI3OTIwNjE2ZTc5MjA3MDYxNzI3NDc5MjA2MTczNzM3NTZkNjU3MzIwNjE2MzYzNjU3MDc0NjE2ZTYzNjUyMDZmNjYyMDc0Njg2NTIwNzQ2ODY1NmUyMDYxNzA3MDZjNjk2MzYxNjI2YzY1MjA3Mzc0NjE2ZTY0NjE3MjY0MjA3NDY1NzI2ZDczMjA2MTZlNjQyMDYzNmY2ZTY0Njk3NDY5NmY2ZTczMjA2ZjY2MjA3NTczNjUyYzIwNjM2NTcyNzQ2OTY2Njk2MzYxNzQ2NTIwNzA2ZjZjNjk2Mzc5MjA2MTZlNjQyMDYzNjU3Mjc0Njk2NjY5NjM2MTc0Njk2ZjZlMjA3MDcyNjE2Mzc0Njk2MzY1MjA3Mzc0NjE3NDY1NmQ2NTZlNzQ3MzJlMzAzNjA2MDgyYjA2MDEwNTA1MDcwMjAxMTYyYTY4NzQ3NDcwM2EyZjJmNzc3Nzc3MmU2MTcwNzA2YzY1MmU2MzZmNmQyZjYzNjU3Mjc0Njk2NjY5NjM2MTc0NjU2MTc1NzQ2ODZmNzI2OTc0NzkyZjMwMzQwNjAzNTUxZDFmMDQyZDMwMmIzMDI5YTAyN2EwMjU4NjIzNjg3NDc0NzAzYTJmMmY2MzcyNmMyZTYxNzA3MDZjNjUyZTYzNmY2ZDJmNjE3MDcwNmM2NTYxNjk2MzYxMzMyZTYzNzI2YzMwMWQwNjAzNTUxZDBlMDQxNjA0MTQ5NDU3ZGI2ZmQ1NzQ4MTg2ODk4OTc2MmY3ZTU3ODUwN2U3OWI1ODI0MzAwZTA2MDM1NTFkMGYwMTAxZmYwNDA0MDMwMjA3ODAzMDBmMDYwOTJhODY0ODg2Zjc2MzY0MDYxZDA0MDIwNTAwMzAwYTA2MDgyYTg2NDhjZTNkMDQwMzAyMDM0OTAwMzA0NjAyMjEwMGJlMDk1NzFmZTcxZTFlNzM1YjU1ZTVhZmFjYjRjNzJmZWI0NDVmMzAxODUyMjJjNzI1MTAwMmI2MWViZDZmNTUwMjIxMDBkMThiMzUwYTVkZDZkZDZlYjE3NDYwMzViMTFlYjJjZTg3Y2ZhM2U2YWY2Y2JkODM4MDg5MGRjODJjZGRhYTYzMzA4MjAyZWUzMDgyMDI3NWEwMDMwMjAxMDIwMjA4NDk2ZDJmYmYzYTk4ZGE5NzMwMGEwNjA4MmE4NjQ4Y2UzZDA0MDMwMjMwNjczMTFiMzAxOTA2MDM1NTA0MDMwYzEyNDE3MDcwNmM2NTIwNTI2ZjZmNzQyMDQzNDEyMDJkMjA0NzMzMzEyNjMwMjQwNjAzNTUwNDBiMGMxZDQxNzA3MDZjNjUyMDQzNjU3Mjc0Njk2NjY5NjM2MTc0Njk2ZjZlMjA0MTc1NzQ2ODZmNzI2OTc0NzkzMTEzMzAxMTA2MDM1NTA0MGEwYzBhNDE3MDcwNmM2NTIwNDk2ZTYzMmUzMTBiMzAwOTA2MDM1NTA0MDYxMzAyNTU1MzMwMWUxNzBkMzEzNDMwMzUzMDM2MzIzMzM0MzYzMzMwNWExNzBkMzIzOTMwMzUzMDM2MzIzMzM0MzYzMzMwNWEzMDdhMzEyZTMwMmMwNjAzNTUwNDAzMGMyNTQxNzA3MDZjNjUyMDQxNzA3MDZjNjk2MzYxNzQ2OTZmNmUyMDQ5NmU3NDY1Njc3MjYxNzQ2OTZmNmUyMDQzNDEyMDJkMjA0NzMzMzEyNjMwMjQwNjAzNTUwNDBiMGMxZDQxNzA3MDZjNjUyMDQzNjU3Mjc0Njk2NjY5NjM2MTc0Njk2ZjZlMjA0MTc1NzQ2ODZmNzI2OTc0NzkzMTEzMzAxMTA2MDM1NTA0MGEwYzBhNDE3MDcwNmM2NTIwNDk2ZTYzMmUzMTBiMzAwOTA2MDM1NTA0MDYxMzAyNTU1MzMwNTkzMDEzMDYwNzJhODY0OGNlM2QwMjAxMDYwODJhODY0OGNlM2QwMzAxMDcwMzQyMDAwNGYwMTcxMTg0MTlkNzY0ODVkNTFhNWUyNTgxMDc3NmU4ODBhMmVmZGU3YmFlNGRlMDhkZmM0YjkzZTEzMzU2ZDU2NjViMzVhZTIyZDA5Nzc2MGQyMjRlN2JiYTA4ZmQ3NjE3Y2U4OGNiNzZiYjY2NzBiZWM4ZTgyOTg0ZmY1NDQ1YTM4MWY3MzA4MWY0MzA0NjA2MDgyYjA2MDEwNTA1MDcwMTAxMDQzYTMwMzgzMDM2MDYwODJiMDYwMTA1MDUwNzMwMDE4NjJhNjg3NDc0NzAzYTJmMmY2ZjYzNzM3MDJlNjE3MDcwNmM2NTJlNjM2ZjZkMmY2ZjYzNzM3MDMwMzQyZDYxNzA3MDZjNjU3MjZmNmY3NDYzNjE2NzMzMzAxZDA2MDM1NTFkMGUwNDE2MDQxNDIzZjI0OWM0NGY5M2U0ZWYyN2U2YzRmNjI4NmMzZmEyYmJmZDJlNGIzMDBmMDYwMzU1MWQxMzAxMDFmZjA0MDUzMDAzMDEwMWZmMzAxZjA2MDM1NTFkMjMwNDE4MzAxNjgwMTRiYmIwZGVhMTU4MzM4ODlhYTQ4YTk5ZGViZWJkZWJhZmRhY2IyNGFiMzAzNzA2MDM1NTFkMWYwNDMwMzAyZTMwMmNhMDJhYTAyODg2MjY2ODc0NzQ3MDNhMmYyZjYzNzI2YzJlNjE3MDcwNmM2NTJlNjM2ZjZkMmY2MTcwNzA2YzY1NzI2ZjZmNzQ2MzYxNjczMzJlNjM3MjZjMzAwZTA2MDM1NTFkMGYwMTAxZmYwNDA0MDMwMjAxMDYzMDEwMDYwYTJhODY0ODg2Zjc2MzY0MDYwMjBlMDQwMjA1MDAzMDBhMDYwODJhODY0OGNlM2QwNDAzMDIwMzY3MDAzMDY0MDIzMDNhY2Y3MjgzNTExNjk5YjE4NmZiMzVjMzU2Y2E2MmJmZjQxN2VkZDkwZjc1NGRhMjhlYmVmMTljODE1ZTQyYjc4OWY4OThmNzliNTk5Zjk4ZDU0MTBkOGY5ZGU5YzJmZTAyMzAzMjJkZDU0NDIxYjBhMzA1Nzc2YzVkZjMzODNiOTA2N2ZkMTc3YzJjMjE2ZDk2NGZjNjcyNjk4MjEyNmY1NGY4N2E3ZDFiOTljYjliMDk4OTIxNjEwNjk5MGYwOTkyMWQwMDAwMzE4MjAxOGQzMDgyMDE4OTAyMDEwMTMwODE4NjMwN2EzMTJlMzAyYzA2MDM1NTA0MDMwYzI1NDE3MDcwNmM2NTIwNDE3MDcwNmM2OTYzNjE3NDY5NmY2ZTIwNDk2ZTc0NjU2NzcyNjE3NDY5NmY2ZTIwNDM0MTIwMmQyMDQ3MzMzMTI2MzAyNDA2MDM1NTA0MGIwYzFkNDE3MDcwNmM2NTIwNDM2NTcyNzQ2OTY2Njk2MzYxNzQ2OTZmNmUyMDQxNzU3NDY4NmY3MjY5NzQ3OTMxMTMzMDExMDYwMzU1MDQwYTBjMGE0MTcwNzA2YzY1MjA0OTZlNjMyZTMxMGIzMDA5MDYwMzU1MDQwNjEzMDI1NTUzMDIwODRjMzA0MTQ5NTE5ZDU0MzYzMDBkMDYwOTYwODY0ODAxNjUwMzA0MDIwMTA1MDBhMDgxOTUzMDE4MDYwOTJhODY0ODg2ZjcwZDAxMDkwMzMxMGIwNjA5MmE4NjQ4ODZmNzBkMDEwNzAxMzAxYzA2MDkyYTg2NDg4NmY3MGQwMTA5MDUzMTBmMTcwZDMyMzIzMDM5MzIzMTMxMzAzMDM5MzAzMDVhMzAyYTA2MDkyYTg2NDg4NmY3MGQwMTA5MzQzMTFkMzAxYjMwMGQwNjA5NjA4NjQ4MDE2NTAzMDQwMjAxMDUwMGExMGEwNjA4MmE4NjQ4Y2UzZDA0MDMwMjMwMmYwNjA5MmE4NjQ4ODZmNzBkMDEwOTA0MzEyMjA0MjAwOWNhYmJiZWVhMjFmNWRiOWM4ZDdjNzdjMjM3N2ZkOThkNDdkYjQ2ZTIxNjlkZmU1ZWU1MGM0OWQwZTRmNjJkMzAwYTA2MDgyYTg2NDhjZTNkMDQwMzAyMDQ0ODMwNDYwMjIxMDA5ZDczN2Q4NTY5YmE0M2U4NTkyODU3MmZlNThkYzIxODYzODMzY2JhY2QxNTI1YTlhZWQ3NjE0ODk4NGFkMjc0MDIyMTAwZDA3YWNiOTUyYTBhMGVlMzk0ZGZlYjY5ZWUxMmRiODFmNDRmY2JmMGRjMWRmMzMxMTFkMmUxOTBkZTNhYjIyMTAwMDAwMDAwMDAwMCIsCgkib3BlcmF0aW9uYWxBbmFseXRpY3NJZGVudGlmaWVyIjoiREIucHJvY2Vzc2luZ3BhZ2F0ZXEubWVyY2hhbnRzb2x1dGlvbjoyODczMkE0RjA1QUUwNTU1MDA3NzY0MkNDNkJBQkE4QzU5MjNFMzQ3QTA4MzgwM0MwQjdBODA4ODcxMEMzMUU0IiwKCSJyZXRyaWVzIjowLAoJInBzcElkIjoiMjg3MzJBNEYwNUFFMDU1NTAwNzc2NDJDQzZCQUJBOEM1OTIzRTM0N0EwODM4MDNDMEI3QTgwODg3MTBDMzFFNCIKfQo=" } } }, "ApplePayPaymentSessionRequest" : { "required" : [ "initiative", "initiative_context", "merchant_id" ], "type" : "object", "properties" : { "merchant_id" : { "type" : "string", "description" : "Merchant Identifier registered for payments at Apple Pay™.", "example" : "merchant.9999900999.1.processingpagateq.merchantsolution" }, "initiative" : { "type" : "string", "description" : "Initiative of a payment. If not submitted initiative web is assumed.\n\n * `web`: browser initiated Apple Pay payment\n * `messaging`: Apple Pay payment initiated by App\n", "example" : "web", "enum" : [ "web", "messaging" ] }, "initiative_context" : { "type" : "string", "description" : "Domain where the payment is initiated and which is registered and validated at Apple Pay™.", "example" : "testmerch.directpos.de" } }, "description" : "The payment session creation request of the Apple Pay™ API." }, "AmountCurrency" : { "required" : [ "amount", "currency" ], "type" : "object", "properties" : { "amount" : { "type" : "integer", "description" : "Minor currency value of an amount of money.", "format" : "int64", "example" : 200 }, "currency" : { "maxLength" : 3, "minLength" : 3, "pattern" : "[A-Z]{3}", "type" : "string", "description" : "ISO 4217 currency code, three uppercase letters.", "example" : "EUR" } }, "description" : "An amount and a currency." }, "Headless3DSecure20ChallengeRequiredResponse" : { "required" : [ "acs_url" ], "type" : "object", "properties" : { "PaReq" : { "type" : "string", "description" : "3-D Secure Payer Authentication Request that has to be sent to the ACS." }, "acs_url" : { "type" : "string", "description" : "The URL to which the customer should be redirected." }, "creq" : { "type" : "string", "description" : "3-D Secure challenge request data that has to be sent to the ACS." } } }, "Headless3DSecure20MethodRequiredResponse" : { "type" : "object", "properties" : { "method_request" : { "type" : "string" }, "method_url" : { "type" : "string" } } }, "Headless3DSecureResponse" : { "required" : [ "message", "outcome", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "outcome" : { "type" : "string", "description" : "Indicates the outcome of the current headless 3-D Secure transaction.\n \n* `PROCESSED`: The transaction has been processed, no further action required. \n Consult attribute `processed` for details of the processed transaction.\n* `METHOD_REQUIRED`: 3-D Secure method flow needs to be started.\n Consult attribute `method_required` for required data.\n* `CHALLENGE_REQUIRED`: 3-D Secure challenge flow needs to be started.\n Consult attribute `challenge_required` for required data. \n", "example" : "PROCESSED", "enum" : [ "PROCESSED", "METHOD_REQUIRED", "CHALLENGE_REQUIRED" ] }, "challenge_required" : { "$ref" : "#/components/schemas/Headless3DSecure20ChallengeRequiredResponse" }, "method_required" : { "$ref" : "#/components/schemas/Headless3DSecure20MethodRequiredResponse" }, "processed" : { "$ref" : "#/components/schemas/PaymentResponse" } } }, "MandateResponse" : { "required" : [ "signed_on" ], "type" : "object", "properties" : { "mandate_id" : { "maxLength" : 32, "minLength" : 32, "type" : "string", "description" : "Unique identification of the SEPA mandate. Use it for managed and already created mandates.", "example" : "89c3d6b532be80339839f1605201f2c7" }, "signed_on" : { "type" : "string", "description" : "Date when the SEPA mandate was issued. Full-date notation as defined by RFC 3339, section 5.6.", "format" : "date", "example" : "2017-01-01" } } }, "PaymentResponse" : { "required" : [ "event_id", "message", "rc", "timestamp", "tx_id" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "event_id" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string", "description" : "A unique ID for the event.", "example" : "E5686585867636541231230" }, "tx_id" : { "type" : "string", "description" : "Unique transaction identifier. Can be used to reference this transaction.", "example" : "020LMG10jxSI8FN0OC4vLR" }, "riskmanagement_info" : { "$ref" : "#/components/schemas/RiskmanagementInfoResponse" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "kind" : { "type" : "string", "description" : "The type of transaction.", "enum" : [ "DIRECTDEBIT", "CREDITCARD", "CREDITCARD_3DS20", "CREDITTRANSFER", "SOFORTUEBERWEISUNG", "PAYPAL", "PAYDIREKT", "WECHATPAY", "P24", "GIROPAY", "KLARNA", "PSD2" ] }, "tx_action" : { "type" : "string", "description" : "The action of a transaction.", "enum" : [ "authorization", "capture", "credit", "preauthorization", "refund", "reversal", "risk_check", "verify-mop", "payment", "avs", "avspayment" ] }, "alias_info" : { "$ref" : "#/components/schemas/AliasInfo" }, "back_rc" : { "maxLength" : 255, "minLength" : 0, "type" : "string", "description" : "Response code of a backend system, for example the GICC response code.", "example" : "00" }, "timestamp" : { "type" : "string", "description" : "Timestamp of the transaction.", "format" : "date-time" }, "transaction_info" : { "$ref" : "#/components/schemas/TransactionInfo" } } }, "RiskmanErrorFieldInformation" : { "type" : "object", "properties" : { "field" : { "type" : "string", "description" : "The name of the field which was the reason of the request rejection.", "example" : "orderInformation.billTo.firstName" }, "reason" : { "type" : "string", "description" : "The reason why the request was rejected.", "example" : "MISSING_FIELD" } }, "description" : "Field name and reason why the request was rejected." }, "RiskmanErrorInformation" : { "type" : "object", "properties" : { "error_field_information" : { "type" : "array", "description" : "Detailed field level information regarding the reason why the request was rejected.", "items" : { "$ref" : "#/components/schemas/RiskmanErrorFieldInformation" } }, "error_message" : { "type" : "string", "description" : "The reason why the request was rejected.", "example" : "Declined - The request is missing one or more fields." }, "error_reason" : { "type" : "string", "description" : "The reason why the request was rejected from the backend system.", "example" : "MISSING_FIELD" }, "error_status" : { "type" : "string", "description" : "The status why the request was rejected from the backend system.", "example" : "INVALID_REQUEST" } }, "description" : "Detailed error information including fields which had been the reasons for unsuccessful processing." }, "RiskmanagementInfoResponse" : { "type" : "object", "properties" : { "case_priority" : { "type" : "string", "description" : "Riskcheck information regarding the case priority.", "example" : "1" }, "error_information" : { "$ref" : "#/components/schemas/RiskmanErrorInformation" }, "event_id" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string", "description" : "A unique ID for the event.", "example" : "E5686585867636541231230" }, "infocodes_address" : { "type" : "array", "items" : { "type" : "string", "description" : "Riskcheck information regarding the address risk check. See user guide for details and all possible values.", "example" : "[\"COR-BA\",\"COR-SA\",\"MM-A\",\"MM-Z\"]" } }, "infocodes_customerlist" : { "type" : "array", "items" : { "type" : "string", "description" : "Riskcheck information regarding the customer list risk check. See user guide for details and all possible values.", "example" : "[\"CONPOSNEG\",\"NEG-BCO\"]" } }, "infocodes_device_behaviour" : { "type" : "array", "items" : { "type" : "string", "description" : "Indicates the device behavior information code(s) returned from device fingerprinting. See user guide for details and all possible values.", "example" : "[\"MouseOffPageDetected\"]" } }, "infocodes_globalvelocity" : { "type" : "array", "items" : { "type" : "string", "description" : "Riskcheck information regarding the velocity risk check. See user guide for details and all possible values.", "example" : "[\"VEL-ADDR\",\"VELS-FP\"]" } }, "infocodes_identitychange" : { "type" : "array", "items" : { "type" : "string", "description" : "Riskcheck information regarding the identity change. See user guide for details and all possible values.", "example" : "[\"ID-M-HPOS\"]" } }, "infocodes_internet" : { "type" : "array", "items" : { "type" : "string", "description" : "Riskcheck information regarding the internet check. See user guide for details and all possible values.", "example" : "[\"FREE-EM\"]" } }, "infocodes_phone" : { "type" : "array", "items" : { "type" : "string", "description" : "Riskcheck information regarding the phone risk check. See user guide for details and all possible values.", "example" : "[\"MMACBST, \"UNV-PH\" ]" } }, "infocodes_suspicious" : { "type" : "array", "items" : { "type" : "string", "description" : "Riskcheck information regarding suspicious risk. See user guide for details and all possible values.", "example" : "[\"BAD-FP\",\"MUL-EM\"]" } }, "infocodes_velocity" : { "type" : "array", "items" : { "type" : "string", "description" : "List of information codes triggered by the order. These information codes were generated when you created\nthe order and product velocity rules and are returned so that you can associate them with the rules. See user guide for details and all possible values.", "example" : "[\"GVEL-R20\",\"GVEL-R21\"]" } }, "localtime" : { "type" : "string", "description" : "Riskcheck information regarding the local time of the risk check.", "example" : "55083" }, "profile_destination_queue" : { "type" : "string", "description" : "Riskcheck information regarding the profile destination queue of the risk check.", "example" : "dst-queue" }, "profile_name" : { "type" : "string", "description" : "Riskcheck information regarding the profile of the risk check.", "example" : "example-profile" }, "profile_selectorrule" : { "type" : "string", "description" : "Riskcheck information regarding the profile selector rule risk check.", "example" : "example-rule" }, "providers" : { "type" : "array", "items" : { "type" : "string", "description" : "Providers used to calculate the risk.", "example" : "[\"provider1\",\"provider2\"]" } }, "rules" : { "type" : "array", "items" : { "type" : "string", "description" : "Riskcheck information regarding the matched rules in risk check.", "example" : "[\"example-rule\"]" } }, "score" : { "type" : "string", "description" : "Calculated risk score of request data.", "example" : "14" }, "score_factor_codes" : { "type" : "array", "items" : { "type" : "string", "description" : "Riskcheck information regarding the profile factor codes of the risk check. See user guide for all possible values.", "example" : "[\"G\",\"H\",\"Y\",\"Z\"]" } }, "score_model_used" : { "type" : "string", "description" : "Name of the score model used for the transaction. This field contains the name of risk management’s selected model.", "example" : "default_eu" }, "travel_actual_final_dst_country" : { "type" : "string", "description" : "Actual country of final destination of the travel.", "example" : "US" }, "travel_actual_final_dst_locality" : { "type" : "string", "description" : "Actual city of final destination of the travel.", "example" : "Chicago" }, "travel_first_departure_country" : { "type" : "string", "description" : "First departure country of the travel.", "example" : "US" }, "travel_first_departure_locality" : { "type" : "string", "description" : "First departure city of the travel.", "example" : "San Francisco" }, "tx_risk_status" : { "type" : "string", "description" : "Status result of an external risk management transaction. See user guide for all possible values.", "example" : "ACCEPTED" }, "tx_scoring_id" : { "type" : "string", "description" : "Unique scoring transaction identifier. Can be used to reference the depending scoring transaction.", "example" : "6373172383866963604006" }, "utc_time" : { "type" : "string", "description" : "Riskcheck information regarding the UTC time of the risk check, used in error cases.", "example" : "2021-12-21T14:18:04Z" } } }, "TDSInfo" : { "type" : "object", "properties" : { "tds_auth_level" : { "type" : "string", "description" : "The 3D-Secure transaction status.\n \n* `FULL`: Full 3-D Secure Authentification\n* `ATTEMPT`: 3-D Secure Authentification attempted\n", "example" : "ATTEMPT", "enum" : [ "FULL", "ATTEMPT" ] }, "tds_version" : { "maxLength" : 10, "minLength" : 0, "type" : "string", "description" : "3-D Secure version." }, "tds_ares_cardholder_info" : { "maxLength" : 80, "minLength" : 0, "type" : "string", "description" : "3-D Secure 2: ARes card holder information." }, "tds_ares_error_code" : { "maxLength" : 80, "minLength" : 0, "type" : "string", "description" : "3-D Secure 2: ARes error code." }, "tds_ares_error_component" : { "maxLength" : 80, "minLength" : 0, "type" : "string", "description" : "3-D Secure 2: ARes error component." }, "tds_ares_trans_status" : { "maxLength" : 1, "minLength" : 0, "type" : "string", "description" : "3-D Secure 2: ARes transaction status.", "example" : "Y" }, "tds_ares_trans_status_reason" : { "maxLength" : 80, "minLength" : 0, "type" : "string", "description" : "3-D Secure 2: reason for the ARes transaction status.", "example" : "MediumConfidence" }, "tds_rreq_challenge_cancel_indicator" : { "maxLength" : 80, "minLength" : 0, "type" : "string", "description" : "Optional 3-D Secure 2 response parameter.", "example" : "CardholderCancel" }, "tds_rreq_error_code" : { "maxLength" : 80, "minLength" : 0, "type" : "string", "description" : "3-D Secure 2: RReq error code." }, "tds_rreq_error_component" : { "maxLength" : 80, "minLength" : 0, "type" : "string", "description" : "3-D Secure 2: RReq error component." }, "tds_rreq_trans_status" : { "maxLength" : 1, "minLength" : 0, "type" : "string", "description" : "3-D Secure 2: RReq transaction status." }, "tds_rreq_trans_status_reason" : { "maxLength" : 80, "minLength" : 0, "type" : "string", "description" : "3-D Secure 2: reason for the RReq transaction status.", "example" : "MediumConfidence" }, "tds_ares_error_description" : { "maxLength" : 80, "minLength" : 0, "type" : "string", "description" : "3-D Secure 2: ARes error description." }, "tds_ares_error_detail" : { "maxLength" : 80, "minLength" : 0, "type" : "string", "description" : "3-D Secure 2: ARes error detail." }, "tds_rreq_error_description" : { "maxLength" : 80, "minLength" : 0, "type" : "string", "description" : "3-D Secure 2: RReq error description." }, "tds_rreq_error_detail" : { "maxLength" : 80, "minLength" : 0, "type" : "string", "description" : "3-D Secure 2: RReq error detail." } }, "description" : "Contains 3-D Secure response data. The use of this field requires an explicit activation. Please contact customer support." }, "TransactionBankAccountInfo" : { "type" : "object", "properties" : { "bank_account" : { "$ref" : "#/components/schemas/BankAccount" } } }, "TransactionCreditCardInfo" : { "type" : "object", "properties" : { "credit_card" : { "$ref" : "#/components/schemas/CreditCardInfo" }, "tds_info" : { "$ref" : "#/components/schemas/TDSInfo" }, "recurring_payment" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[/0-9a-zA-Z_.:,+*$%-]+", "type" : "string", "description" : "Identifier of a recurring credit card payment.", "example" : "07H987Tx3PF9VxL5G7RfNp" }, "cvc_result" : { "type" : "string", "description" : "Response code of the verification of the card verification code\n according to the response of a backend system. This value is available on some backend systems. The use of this field requires an explicit activation. Please contact customer support. \n Possible values:\n \n* `CVC_MATCH`\n* `CVC_NO_MATCH`\n* `CVC_NO_RESPONSE_RECEIVED`\n* `CVC_NOT_PROCESSED`\n* `CVC_NOT_PROVIDED`\n* `CVC_SHOULD_BE_ON_CARD`\n* `CVC_VERIFICATION_UNAVAILABLE`\n\n", "example" : "CVC_MATCH", "enum" : [ "CVC_MATCH", "CVC_NO_MATCH", "CVC_NO_RESPONSE_RECEIVED", "CVC_NOT_PROCESSED", "CVC_NOT_PROVIDED", "CVC_SHOULD_BE_ON_CARD", "CVC_VERIFICATION_UNAVAILABLE" ] }, "avs_result" : { "type" : "string", "description" : "Response code of the address verification according to the response of a backend system. \n This value is available on some backend systems. The use of this field requires an explicit activation. Please contact customer support. Possible values:\n \n* `MATCH`\n* `NO_MATCH`\n", "example" : "MATCH", "enum" : [ "MATCH", "NO_MATCH" ] } } }, "TransactionInfo" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "creditcard", "bankaccount" ] }, "transaction_creditcard_info" : { "$ref" : "#/components/schemas/TransactionCreditCardInfo" }, "transaction_bankaccount_info" : { "$ref" : "#/components/schemas/TransactionBankAccountInfo" }, "mandate_data" : { "$ref" : "#/components/schemas/MandateResponse" }, "back_state" : { "type" : "string", "description" : "State of a transaction according to the response of a backend system. \n This value is available on some backend systems. The use of this field requires an explicit activation. Please contact customer support. Possible values:\n \n* `DECLINED`\n* `AUTHORIZED`\n* `REVERSED`\n* `CAPTURED`\n* `SETTLED`\n", "example" : "REVERSED", "enum" : [ "DECLINED", "AUTHORIZED", "REVERSED", "CAPTURED", "SETTLED" ] }, "ip_address" : { "type" : "string", "description" : "The customer's IP address associated with this transaction. The use of this field requires an explicit activation. Please contact customer support." } } }, "AccountInformation" : { "type" : "object", "properties" : { "account_change_date" : { "type" : "string", "description" : "Date of the last change to the client's account. This includes changes to the billing or shipping addresses, new payment methods or new users added.", "format" : "date", "example" : "2021-10-25" }, "account_creation_indicator" : { "type" : "string", "description" : "What kind of account is it?\n\n* GUEST\n* NEW_ACCOUNT\n* EXISTING_ACCOUNT\n", "example" : "GUEST", "enum" : [ "GUEST", "NEW_ACCOUNT", "EXISTING_ACCOUNT" ] }, "account_id" : { "type" : "string", "description" : "The account ID.", "example" : "MC_ACC_12345678" }, "account_opened_date" : { "type" : "string", "description" : "Date the client opened the account. This usually only applies if this is an EXISTING_ACCOUNT.", "format" : "date", "example" : "2021-10-25" }, "modification_indicator" : { "type" : "string", "description" : "This field is applicable only if this is an EXISTING_ACCOUNT.\n\n* ACCOUNT_UPDATED_NOW\n* ACCOUNT_UPDATED_PAST\n", "example" : "ACCOUNT_UPDATED_NOW", "enum" : [ "ACCOUNT_UPDATED_NOW", "ACCOUNT_UPDATED_PAST" ] }, "password_change_date" : { "type" : "string", "description" : "Date the client last changed the account's password. May be empty if the password has not been changed yet.", "format" : "date", "example" : "2021-10-25" }, "password_change_indicator" : { "type" : "string", "description" : "This field is applicable only if this is an EXISTING_ACCOUNT.\n\n* PASSWORD_CHANGED_NOW\n* PASSWORD_CHANGED_PAST\n* PASSWORD_NEVER_CHANGED\n", "example" : "PASSWORD_CHANGED_NOW", "enum" : [ "PASSWORD_CHANGED_NOW", "PASSWORD_CHANGED_PAST", "PASSWORD_NEVER_CHANGED" ] }, "payment_account_date" : { "type" : "string", "description" : "Only applicable if PAYMENT_ACCOUNT_EXISTS.", "format" : "date", "example" : "2021-10-25" }, "payment_account_history" : { "type" : "string", "description" : "This field is applicable only if this is a NEW_ACCOUNT or EXISTING_ACCOUNT.\n\n* PAYMENT_ACCOUNT_EXISTS\n* PAYMENT_ACCOUNT_ADDED_NOW\n", "example" : "PAYMENT_ACCOUNT_EXISTS", "enum" : [ "PAYMENT_ACCOUNT_EXISTS", "PAYMENT_ACCOUNT_ADDED_NOW" ] }, "add_card_attempts" : { "maximum" : 999, "type" : "integer", "description" : "Number of add card attempts during the last 24 hours.", "format" : "int32", "example" : 1 }, "provisioning_day_count" : { "maximum" : 9999, "type" : "integer", "description" : "The provisioning day counter.", "format" : "int32", "example" : 1 }, "purchases_six_month_count" : { "maximum" : 9999, "type" : "integer", "description" : "Number of purchases with this account during the previous six months.", "format" : "int32", "example" : 2 }, "shipping_address_first_use_date" : { "type" : "string", "description" : "Date when the shipping address was first used for this transaction. Only applies if firstUseOfShippingAddress is false and this is not a guest account.", "format" : "date", "example" : "2021-10-25" }, "shipping_address_first_use" : { "type" : "boolean", "description" : "Applicable if this is not a guest account.", "example" : false }, "shipping_name_indicator" : { "type" : "string", "description" : "The shipping name indicator. Indicates if the account's cardholder name equals the shipping name used for this transaction.", "example" : "02" }, "suspicious_account_activity" : { "type" : "boolean", "description" : "Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account.", "example" : false }, "transactions_day_count" : { "maximum" : 999, "type" : "integer", "description" : "Number of transactions (successful or abandoned) of this account during the last 24 hours.", "format" : "int32", "example" : 1 }, "transactions_year_count" : { "maximum" : 9999, "type" : "integer", "description" : "Number of transactions (successful or abandoned) of this account during the last 365 days.", "format" : "int32", "example" : 1 } }, "description" : "Information on a user's account usage, payment history, transaction statistics." }, "AliasAction" : { "required" : [ "action" ], "type" : "object", "properties" : { "alias" : { "type" : "string", "description" : "The alias value. If no value is set an alias is created by the system.", "example" : "221f56ca355d8e6c42517749cf79ceb8" }, "action" : { "type" : "string", "description" : "What should be done.", "enum" : [ "CREATE", "UPDATE", "USE" ] } }, "description" : "Specifies an alias and an operation to perform on it." }, "ApplePayPaymentRequest" : { "required" : [ "amount_total", "means_of_payment" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "account_information" : { "$ref" : "#/components/schemas/AccountInformation" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "merchant_risk_indicators" : { "$ref" : "#/components/schemas/MerchantRiskIndicators" }, "merchant_defined_information" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RiskCheckMerchantDefinedInformation" } }, "travel_information" : { "$ref" : "#/components/schemas/RiskCheckTravelInformation" }, "risk_check_additional_information" : { "$ref" : "#/components/schemas/RiskCheckAdditionalInformation" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "alias_action" : { "$ref" : "#/components/schemas/AliasAction" }, "means_of_payment" : { "$ref" : "#/components/schemas/MeansOfPaymentApplePay" }, "processing_options" : { "uniqueItems" : true, "type" : "array", "description" : "Defines an additional processing option for Google Pay™ transactions.", "example" : [ "RISKCHECK" ], "items" : { "type" : "string", "description" : "Additional processing option for headless 3-D Secure transactions.\n\n* `FALLBACK_ON_SSL`: process the transaction flagged as channel-encrypted (SSL, 3-D Secure authentication \nwas not performed) instead of 3-D Secure in case 3-D Secure authentication could not be performed.\n* `RISKCHECK`: process risk check transaction before start of 3-D Secure authentication. In case of declined risk check\nno credit card transaction is started\n", "example" : "FALLBACK_ON_SSL", "enum" : [ "FALLBACK_ON_SSL", "RISKCHECK" ] } }, "recurring_payment" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[/0-9a-zA-Z_.:,+*$%-]+", "type" : "string", "description" : "Identifier of a recurring credit card payment.", "example" : "07H987Tx3PF9VxL5G7RfNp" }, "sequence_type" : { "type" : "string", "description" : "If this payment is part of a sequence of payments\n\n * `FIRST`: first payment of a sequence\n * `RECURRING`: follow-up payment\n * `FINAL`: last payment of a sequence\n", "enum" : [ "FINAL", "FIRST", "RECURRING" ] }, "series_flag" : { "type" : "string", "description" : "Designates a payment as part of a series of payments.\n\n* `INSTALMENT`: for example in the case of paying a fixed sum in multiple partial payments.\n* `RECURRING`: for example in the case of a subscription or standing order.\n* `UCOF`: when a card number alias is created for future payments with the same credit card. In this case use _alias_action_ with _action_ `CREATE` with the first payment and the card number alias with the following payments. You can use the _tx_action_ `verify-mop` with the first UCOF transaction to register a card number alias without a payment.", "enum" : [ "INSTALMENT", "RECURRING", "UCOF" ] }, "tds_20_data" : { "$ref" : "#/components/schemas/TDS20Data" } }, "description" : "The payment request of the Google Pay™ API." }, "Basket" : { "type" : "object", "properties" : { "basket_id" : { "maxLength" : 140, "minLength" : 0, "type" : "string", "description" : "Dependent on the backend services the value might be shortened or special characters might be removed before sending.\n\ngiropay: Will be displayed by giropay at the first row of the remittance information on the giropay form. Values longer than 27 characters will be cut off.", "example" : "basket123456" }, "invoice_id" : { "maxLength" : 127, "minLength" : 0, "type" : "string", "description" : "The API caller-provided external invoice number for this order.", "example" : "RE123345" }, "soft_descriptor" : { "type" : "string", "description" : "Dynamic text used to construct the statement descriptor that appears on a payer's card statement.", "example" : "800-123-1234" }, "shipping_costs" : { "$ref" : "#/components/schemas/AmountCurrency" }, "basket_discount" : { "$ref" : "#/components/schemas/AmountCurrency" }, "basket_type" : { "type" : "string", "description" : "Type of a shopping basket. Mandatory for PayPal.\n\n* `DIGITAL`: Basket contains digital items only.\n* `MIXED`: Basket contains items of various types.\n* `PHYSICAL`: Basket contains physical items only.\n", "example" : "DIGITAL", "enum" : [ "DIGITAL", "MIXED", "PHYSICAL" ] }, "extensions" : { "$ref" : "#/components/schemas/BasketExtensions" }, "basket_items" : { "type" : "array", "description" : "An array of items that the customer purchases from the merchant.", "items" : { "$ref" : "#/components/schemas/BasketItem" } } }, "description" : "A generalized shopping basket." }, "BasketExtensions" : { "type" : "object", "properties" : { "paypal_data" : { "$ref" : "#/components/schemas/BasketPayPalData" } }, "description" : "Service specific basket fields." }, "BasketItem" : { "type" : "object", "properties" : { "name" : { "maxLength" : 127, "minLength" : 0, "type" : "string", "description" : "Descriptive name of the order item. Mandatory for PayPal.", "example" : "A fine shirt" }, "description" : { "maxLength" : 127, "minLength" : 0, "type" : "string", "description" : "Used for storing merchant's internal order number or other reference.", "example" : "BI123456" }, "reference" : { "maxLength" : 64, "minLength" : 0, "type" : "string", "description" : "Article number, SKU or similar.", "example" : "UGG-BB-PUR-06" }, "quantity" : { "$ref" : "#/components/schemas/Quantity" }, "unit_price" : { "$ref" : "#/components/schemas/TaxedAmountCurrency" }, "item_discount" : { "$ref" : "#/components/schemas/TaxedAmountCurrency" }, "extensions" : { "$ref" : "#/components/schemas/BasketItemExtensions" } }, "description" : "A purchasable item that is part of a shopping basket's list of items." }, "BasketItemExtensions" : { "type" : "object", "properties" : { "paypal_data" : { "$ref" : "#/components/schemas/BasketItemPayPalData" }, "riskcheck_data" : { "$ref" : "#/components/schemas/BasketItemRiskCheckData" }, "klarna_data" : { "$ref" : "#/components/schemas/BasketItemKlarnaData" } }, "description" : "Service specific basket item fields." }, "BasketItemKlarnaData" : { "type" : "object", "properties" : { "product_url" : { "maxLength" : 1024, "minLength" : 0, "type" : "string", "description" : "Product's URL in the merchant's webshop. May be used in communication between Klarna and the customer.", "example" : "https://www.exampleobjects.com/products/123456789" }, "image_url" : { "maxLength" : 1024, "minLength" : 0, "type" : "string", "description" : "Product image URL in the merchant's webshop. May be used to embed the image into communication between Klarna and the customer.", "example" : "https://www.exampleobjects.com/product-image-1200x1200.jpg" }, "product_identifiers" : { "type" : "array", "description" : "Additional information identifying the basket item.", "items" : { "$ref" : "#/components/schemas/KlarnaProductIdentifier" } } }, "description" : "Service specific basket item fields for Klarna related use cases." }, "BasketItemPayPalData" : { "required" : [ "paypal_type" ], "type" : "object", "properties" : { "paypal_type" : { "type" : "string", "description" : "PayPal specific type of an order item.\n\n * `DIGITAL_GOODS`: Goods that are stored, delivered, and used in electronic format.\n * `PHYSICAL_GOODS`: A tangible item that can be shipped with proof of delivery.\n * `DONATION`: A contribution or gift for which no good or service is exchanged.\n ", "example" : "PHYSICAL_GOODS", "enum" : [ "DIGITAL_GOODS", "PHYSICAL_GOODS", "DONATION" ] } }, "description" : "Service specific basket item fields for PayPal." }, "BasketItemRiskCheckData" : { "type" : "object", "properties" : { "riskcheck_type" : { "type" : "string", "description" : "Riskcheck specific type of an order item.\n\n* `ADULT_CONTENT`: Adult content.\n* `COUPON`: Coupon applied to the entire order.\n* `DEFAULT`: Default value for the product code. This value is used if a request message does not include a value for the product code.\n* `ELECTRONIC_GOOD`: Electronic product other than software.\n* `ELECTRONIC_SOFTWARE`: Software distributed electronically rather than on physical media.\n* `GIFT_CERTIFICATE`: Gift certificate.\n* `HANDLING_ONLY`: A fee that covers the merchant's administrative selling costs.\n* `SERVICE`: An arbitrary service that a merchant performs for customers.\n* `SHIPPING_ONLY`: Charge for transporting tangible personal property from the merchant to the customer.\n* `SHIPPING_AND_HANDLING`: Handling & Shipping fees combined.\n* `SUBSCRIPTION`: Subscription to a website or other type of subscribable content.", "example" : "SHIPPING_ONLY", "enum" : [ "ADULT_CONTENT", "COUPON", "DEFAULT", "ELECTRONIC_GOOD", "ELECTRONIC_SOFTWARE", "GIFT_CERTIFICATE", "HANDLING_ONLY", "SERVICE", "SHIPPING_ONLY", "SHIPPING_AND_HANDLING", "SUBSCRIPTION" ] }, "distributor_product_sku" : { "maxLength" : 15, "minLength" : 0, "type" : "string", "description" : "Product's identifier code.", "example" : "12345678" }, "gift_card_currency" : { "type" : "string", "description" : "If riskcheck_type is GIFT_CERTIFICATE, this field must contain the ISO-4217-3 alpha-numeric currency code used for the gift card purchase.", "example" : "EUR" }, "product_risk" : { "type" : "string", "description" : "Indicates the product's risk level. This field may contain one of the following values:\n\n* `LOW`: The product is associated with a low number of chargebacks.\n* `NORMAL`: The product is associated with a normal number of chargebacks.\n* `HIGH`: The product is associated with a high number of chargebacks.\n", "example" : "NORMAL", "enum" : [ "LOW", "NORMAL", "HIGH" ] }, "risk_check_passenger" : { "$ref" : "#/components/schemas/RiskCheckPassenger" }, "shipping_destination_types" : { "type" : "string", "description" : "Destination to where the item will be shipped.\n \n* `COMMERCIAL`\n* `RESIDENTIAL`\n* `STORE`\n", "example" : "RESIDENTIAL", "enum" : [ "COMMERCIAL", "RESIDENTIAL", "STORE" ] }, "is_gift" : { "type" : "boolean", "description" : "If billing and shipping addresses are different:\n\ntrue: Order risk increases slightly.\nfalse: Order risk increases significantly.\n", "example" : true } }, "description" : "Service specific basket item fields for riskcheck related use cases." }, "BasketPayPalData" : { "type" : "object", "properties" : { "custom_id" : { "maxLength" : 127, "minLength" : 0, "type" : "string", "description" : "The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer.", "example" : "CUSTOMID123" } }, "description" : "Service specific basket fields for PayPal." }, "Contacts" : { "type" : "object", "properties" : { "phone_contacts" : { "type" : "array", "description" : "A means of contacting a customer by phone.", "example" : { "phone_type" : "FAX", "phone_number" : "+442071838750" }, "items" : { "$ref" : "#/components/schemas/PhoneContact" } } }, "description" : "Means of contacting the customer.", "example" : { "phone_contacts" : [ { "phone_type" : "FAX", "phone_number" : "+442071838750" } ] } }, "CustomerExtensionPayPalData" : { "type" : "object", "properties" : { "payer_id" : { "maxLength" : 13, "minLength" : 0, "type" : "string", "example" : "23456789ABCDE" }, "tax_info" : { "$ref" : "#/components/schemas/TaxInfo" } }, "description" : "PayPal specific customer information fields." }, "CustomerInformation" : { "type" : "object", "properties" : { "customer_id" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string", "description" : "Technical identification number of a customer.", "example" : "C1234-AX" }, "date_of_birth" : { "type" : "string", "description" : "Customer's date of birth.", "format" : "date", "example" : "1975-06-30" }, "gender" : { "type" : "string", "description" : "Customer's gender.\n \n* `DIVERSE`\n* `FEMALE`\n* `MALE`\n", "example" : "FEMALE", "enum" : [ "DIVERSE", "FEMALE", "MALE" ] }, "title" : { "type" : "string", "description" : "Customer's title.", "example" : "Ms" }, "personal_identifications" : { "type" : "array", "description" : "Customer's available identifications.", "items" : { "$ref" : "#/components/schemas/PersonalIdentification" } }, "contacts" : { "$ref" : "#/components/schemas/Contacts" }, "extensions" : { "$ref" : "#/components/schemas/CustomerInformationExtensions" } }, "description" : "Details of a customer." }, "CustomerInformationExtensions" : { "type" : "object", "properties" : { "paypal_data" : { "$ref" : "#/components/schemas/CustomerExtensionPayPalData" } }, "description" : "Service specific customer information fields." }, "DeviceInformation" : { "type" : "object", "properties" : { "cookies_accepted" : { "type" : "boolean", "description" : "Whether or not the browser accepts cookies.", "example" : true }, "http_accept_browser_value" : { "maxLength" : 2048, "minLength" : 0, "type" : "string", "description" : "Value of the 'Accept' header sent by the customer's web browser. Note: If the customer's browser provides a value, you must include it with your request.", "example" : "text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8" }, "http_accept_content" : { "maxLength" : 2048, "minLength" : 0, "type" : "string", "description" : "The exact content of the HTTP accept header.", "example" : "text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8" }, "color_depth" : { "type" : "string", "description" : "The bit depth of the color palette for displaying images, in bits per pixel. See https://en.wikipedia.org/wiki/Color_depth. Possible values:\n\n* `B1`\n* `B4`\n* `B8`\n* `B15`\n* `B16`\n* `B24`\n* `B32`\n* `B48`\n\n ", "example" : "B24", "enum" : [ "B1", "B4", "B8", "B15", "B16", "B24", "B32", "B48" ] }, "http_browser_email" : { "maxLength" : 255, "minLength" : 0, "type" : "string", "description" : "Email address set in the customer's browser. May differ from customer's actual email.", "example" : "mustermann@example.com" }, "http_browser_java_enabled" : { "type" : "boolean", "description" : "Is the browser able to execute Java. Value is taken from the navigator.javaEnabled property.", "example" : false }, "http_browser_java_script_enabled" : { "type" : "boolean", "description" : "Is the browser able to execute JavaScript. Background: Merchants may want to fingerprint a cardholder's browser.", "example" : false }, "http_browser_language" : { "maxLength" : 8, "minLength" : 0, "type" : "string", "description" : "Browser language as defined in IETF BCP47. See https://en.wikipedia.org/wiki/IETF_language_tag.", "example" : "en-US" }, "http_browser_screen_height" : { "minimum" : 0, "type" : "integer", "description" : "Total height of the client's screen in pixels.", "format" : "int32", "example" : 864 }, "http_browser_screen_width" : { "minimum" : 0, "type" : "integer", "description" : "Total width of the client's screen in pixels.", "format" : "int32", "example" : 1536 }, "http_browser_time_difference" : { "maximum" : 1440, "minimum" : -1440, "type" : "integer", "description" : "Time difference between UTC time and the client's browser's local time in minutes.", "format" : "int32", "example" : 300 }, "ip_address" : { "maxLength" : 45, "minLength" : 0, "pattern" : "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))", "type" : "string", "description" : "IP address of the client. Both IPv4 and IPv6 are supported.", "example" : "192.168.0.1" }, "user_agent" : { "maxLength" : 40, "minLength" : 0, "type" : "string", "description" : "Client's browser as identified by the HTTP header data.", "example" : "Mozilla" }, "user_agent_browser_value" : { "maxLength" : 255, "minLength" : 0, "type" : "string", "description" : "Value of the User-Agent header sent by the client's browser.", "example" : "Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Firefox/78.0" } }, "description" : "Technical details of a client." }, "KlarnaProductIdentifier" : { "type" : "object", "properties" : { "brand" : { "type" : "string", "description" : "The product's brand name as generally recognized by consumers. If no brand is available for a product, do not supply any value.", "example" : "Intel" }, "category_path" : { "maxLength" : 750, "minLength" : 0, "type" : "string", "description" : "The product's category path as used in the merchant's webshop. Include the full and most detailed category and separate the segments with '>'.", "example" : "Electronics Store > Computers & Tablets > Desktops" }, "gtin" : { "pattern" : "[a-zA-Z0-9]*", "type" : "string", "description" : "The product's Global Trade Item Number (GTIN). Common types of GTIN are EAN, ISBN or UPC. Dashes and spaces must be omitted.", "example" : "735858293167" }, "mpn" : { "type" : "string", "description" : "The product's Manufacturer Part Number (MPN), which - together with the brand - uniquely identifies a product. Only submit MPNs assigned by a manufacturer and use the most specific MPN possible.", "example" : "BOXNUC5CPYH" } }, "description" : "Klarna specific unique identification attributes of a product." }, "MeansOfPaymentApplePay" : { "required" : [ "applepay_token" ], "type" : "object", "properties" : { "applepay_token" : { "maxLength" : 10000, "minLength" : 1, "pattern" : "[a-zA-Z0-9:,\\/+=_\\-\\\\\\{\\}\\[\\]\\\"\r\n\t ]*", "type" : "string", "description" : "The complete token generated by Apple Pay™ as contained in session.onpaymentauthorized in event.payment.token as Base64 encoded value.", "example" : "eyJwYXltZW50RGF0YSI6eyJ2ZXJzaW9uIjoiRUNfdjEiLCJkYXRhIjoiY3NIdGNucGtqcWFkT2NTMWNIRmVOK2xveWtlK1ZtRlNFUVoxL1kxdlIzNkRISGtCRy81MFVJVG9SYjZJeHFsNkRVVE5UQ1hWYnlkV1J6OElUUldQSkFDVkcwZHZNcEFXa09CRklrUHM5SDBLVkpWSjNzdFJDT08wcXVrV0tMS2M0VFhyWmpuNk1teExZTWw5LzVNM2NaRlgveXlMVWFuNGpDMms5WnJHUGZZaGZLTm9SN1B2OHJnemMzMWRVZTlIcCtQc0oxMytVVDVDbXVyS0V1d0hEdTd2UE9QK1FtejRaVVl4WDI0clhFbVFYaXpLaUZteFFGN0R4eHNoaCtLWm42Z1QrdUhUKy9hQnN2MC93dzhIWDFPYkNyWDltNGpMZGdESEhvQ213NkRnUTRaekZwdG5IRnRkVlljQk1xL1c4cmJIaFc4RjE4cUpyYVhvTzdGb2hSWFVDMWJpdytjQzJITFlQeTEvVXptRFgxWTNHK2htZzlPTVNYSUV2cXNYWURzZmxXVU9VcmtyYXFqL1hRPT0iLCJzaWduYXR1cmUiOiJNSUFHQ1NxR1NJYjNEUUVIQXFDQU1JQUNBUUV4RFRBTEJnbGdoa2dCWlFNRUFnRXdnQVlKS29aSWh2Y05BUWNCQUFDZ2dEQ0NBK013Z2dPSW9BTUNBUUlDQ0V3d1FVbFJuVlEyTUFvR0NDcUdTTTQ5QkFNQ01Ib3hMakFzQmdOVkJBTU1KVUZ3Y0d4bElFRndjR3hwWTJGMGFXOXVJRWx1ZEdWbmNtRjBhVzl1SUVOQklDMGdSek14SmpBa0JnTlZCQXNNSFVGd2NHeGxJRU5sY25ScFptbGpZWFJwYjI0Z1FYVjBhRzl5YVhSNU1STXdFUVlEVlFRS0RBcEJjSEJzWlNCSmJtTXVNUXN3Q1FZRFZRUUdFd0pWVXpBZUZ3MHhPVEExTVRnd01UTXlOVGRhRncweU5EQTFNVFl3TVRNeU5UZGFNRjh4SlRBakJnTlZCQU1NSEdWall5MXpiWEF0WW5KdmEyVnlMWE5wWjI1ZlZVTTBMVkJTVDBReEZEQVNCZ05WQkFzTUMybFBVeUJUZVhOMFpXMXpNUk13RVFZRFZRUUtEQXBCY0hCc1pTQkpibU11TVFzd0NRWURWUVFHRXdKVlV6QlpNQk1HQnlxR1NNNDlBZ0VHQ0NxR1NNNDlBd0VIQTBJQUJNSVZkKzNyMXNleUlZOW8zWENRb1NHTng3QzlieXdvUFlSZ2xkbEs5S1ZCRzROQ0R0Z1I4MEIrZ3pNZkhGVEQ5K3N5SU5hNjFkVHY5SktKaVQ1OER4T2pnZ0lSTUlJQ0RUQU1CZ05WSFJNQkFmOEVBakFBTUI4R0ExVWRJd1FZTUJhQUZDUHlTY1JQaytUdkorYkU5aWhzUDZLNy9TNUxNRVVHQ0NzR0FRVUZCd0VCQkRrd056QTFCZ2dyQmdFRkJRY3dBWVlwYUhSMGNEb3ZMMjlqYzNBdVlYQndiR1V1WTI5dEwyOWpjM0F3TkMxaGNIQnNaV0ZwWTJFek1ESXdnZ0VkQmdOVkhTQUVnZ0VVTUlJQkVEQ0NBUXdHQ1NxR1NJYjNZMlFGQVRDQi9qQ0J3d1lJS3dZQkJRVUhBZ0l3Z2JZTWdiTlNaV3hwWVc1alpTQnZiaUIwYUdseklHTmxjblJwWm1sallYUmxJR0o1SUdGdWVTQndZWEowZVNCaGMzTjFiV1Z6SUdGalkyVndkR0Z1WTJVZ2IyWWdkR2hsSUhSb1pXNGdZWEJ3YkdsallXSnNaU0J6ZEdGdVpHRnlaQ0IwWlhKdGN5QmhibVFnWTI5dVpHbDBhVzl1Y3lCdlppQjFjMlVzSUdObGNuUnBabWxqWVhSbElIQnZiR2xqZVNCaGJtUWdZMlZ5ZEdsbWFXTmhkR2x2YmlCd2NtRmpkR2xqWlNCemRHRjBaVzFsYm5SekxqQTJCZ2dyQmdFRkJRY0NBUllxYUhSMGNEb3ZMM2QzZHk1aGNIQnNaUzVqYjIwdlkyVnlkR2xtYVdOaGRHVmhkWFJvYjNKcGRIa3ZNRFFHQTFVZEh3UXRNQ3N3S2FBbm9DV0dJMmgwZEhBNkx5OWpjbXd1WVhCd2JHVXVZMjl0TDJGd2NHeGxZV2xqWVRNdVkzSnNNQjBHQTFVZERnUVdCQlNVVjl0djFYU0Job21KZGk5K1Y0VUg1NXRZSkRBT0JnTlZIUThCQWY4RUJBTUNCNEF3RHdZSktvWklodmRqWkFZZEJBSUZBREFLQmdncWhrak9QUVFEQWdOSkFEQkdBaUVBdmdsWEgrY2VIbk5iVmVXdnJMVEhMK3RFWHpBWVVpTEhKUkFDdGg2OWIxVUNJUURSaXpVS1hkYmRickYwWURXeEhyTE9oOCtqNXE5c3ZZT0FpUTNJTE4ycVl6Q0NBdTR3Z2dKMW9BTUNBUUlDQ0VsdEw3ODZtTnFYTUFvR0NDcUdTTTQ5QkFNQ01HY3hHekFaQmdOVkJBTU1Fa0Z3Y0d4bElGSnZiM1FnUTBFZ0xTQkhNekVtTUNRR0ExVUVDd3dkUVhCd2JHVWdRMlZ5ZEdsbWFXTmhkR2x2YmlCQmRYUm9iM0pwZEhreEV6QVJCZ05WQkFvTUNrRndjR3hsSUVsdVl5NHhDekFKQmdOVkJBWVRBbFZUTUI0WERURTBNRFV3TmpJek5EWXpNRm9YRFRJNU1EVXdOakl6TkRZek1Gb3dlakV1TUN3R0ExVUVBd3dsUVhCd2JHVWdRWEJ3YkdsallYUnBiMjRnU1c1MFpXZHlZWFJwYjI0Z1EwRWdMU0JITXpFbU1DUUdBMVVFQ3d3ZFFYQndiR1VnUTJWeWRHbG1hV05oZEdsdmJpQkJkWFJvYjNKcGRIa3hFekFSQmdOVkJBb01Da0Z3Y0d4bElFbHVZeTR4Q3pBSkJnTlZCQVlUQWxWVE1Ga3dFd1lIS29aSXpqMENBUVlJS29aSXpqMERBUWNEUWdBRThCY1JoQm5YWklYVkdsNGxnUWQyNklDaTc5NTdyazNnamZ4TGsrRXpWdFZtV3pXdUl0Q1hkZzBpVG51NkNQMTJGODZJeTNhN1puQyt5T2dwaFA5VVJhT0I5ekNCOURCR0JnZ3JCZ0VGQlFjQkFRUTZNRGd3TmdZSUt3WUJCUVVITUFHR0ttaDBkSEE2THk5dlkzTndMbUZ3Y0d4bExtTnZiUzl2WTNOd01EUXRZWEJ3YkdWeWIyOTBZMkZuTXpBZEJnTlZIUTRFRmdRVUkvSkp4RStUNU84bjVzVDJLR3cvb3J2OUxrc3dEd1lEVlIwVEFRSC9CQVV3QXdFQi96QWZCZ05WSFNNRUdEQVdnQlM3c042aFdET0ltcVNLbWQ2K3ZldXYyc3NrcXpBM0JnTlZIUjhFTURBdU1DeWdLcUFvaGlab2RIUndPaTh2WTNKc0xtRndjR3hsTG1OdmJTOWhjSEJzWlhKdmIzUmpZV2N6TG1OeWJEQU9CZ05WSFE4QkFmOEVCQU1DQVFZd0VBWUtLb1pJaHZkalpBWUNEZ1FDQlFBd0NnWUlLb1pJemowRUF3SURad0F3WkFJd09zOXlnMUVXbWJHRyt6WERWc3Bpdi9RWDdka1BkVTJpanI3eG5JRmVRcmVKK0pqM20xbWZtTlZCRFkrZDZjTCtBakF5TGRWRUliQ2pCWGRzWGZNNE81Qm4vUmQ4TENGdGxrL0djbW1DRW05VStIcDlHNW5MbXdtSklXRUdtUThKa2gwQUFER0NBWWd3Z2dHRUFnRUJNSUdHTUhveExqQXNCZ05WQkFNTUpVRndjR3hsSUVGd2NHeHBZMkYwYVc5dUlFbHVkR1ZuY21GMGFXOXVJRU5CSUMwZ1J6TXhKakFrQmdOVkJBc01IVUZ3Y0d4bElFTmxjblJwWm1sallYUnBiMjRnUVhWMGFHOXlhWFI1TVJNd0VRWURWUVFLREFwQmNIQnNaU0JKYm1NdU1Rc3dDUVlEVlFRR0V3SlZVd0lJVERCQlNWR2RWRFl3Q3dZSllJWklBV1VEQkFJQm9JR1RNQmdHQ1NxR1NJYjNEUUVKQXpFTEJna3Foa2lHOXcwQkJ3RXdIQVlKS29aSWh2Y05BUWtGTVE4WERUSXlNRGN5TmpFd05UWXdOMW93S0FZSktvWklodmNOQVFrME1Sc3dHVEFMQmdsZ2hrZ0JaUU1FQWdHaENnWUlLb1pJemowRUF3SXdMd1lKS29aSWh2Y05BUWtFTVNJRUlKVGFtUk56aEJWQUJ2eWRrd2ZVTFpPZFFOeGl6NzNIUk9GSTlrNTRnUWlPTUFvR0NDcUdTTTQ5QkFNQ0JFY3dSUUlnRElBTVJCdXM2MnNSVWQzaXpFRCs3blY4akN5R1hhdzVxMVpUWXB0Unp2d0NJUUN0aHUvdmI4Wmc5TjNtSDZyRkxpU3Q1VEdVYU9mS0R4eXRzQzduUk1hRmdnQUFBQUFBQUE9PSIsImhlYWRlciI6eyJlcGhlbWVyYWxQdWJsaWNLZXkiOiJNRmt3RXdZSEtvWkl6ajBDQVFZSUtvWkl6ajBEQVFjRFFnQUV1dmxlTmFocEJ6TGExUGFPTWlxU0xzMStIK3Y1SE9zS0F2cTZMYnNYRjJpT1JCcmwydWI5cE9rWlF5VlB1UjdXcGtNNDBLaDZSMHVSV216dU5FcFAzZz09IiwicHVibGljS2V5SGFzaCI6ImI2UXJSemt6NnJzRGdWV2hTdzh0ZkdGRHprcHdtOTV4RUpzYnFGSWJVcDQ9IiwidHJhbnNhY3Rpb25JZCI6IjJhODU1ZmQwOWQyOTQxZTM1MjhkMjQ5YWUwMWM4YThlOWE5M2RiNjZjYzZiNWExNmE3MTgwZWQ1OTQyYWY4ZDMifX0sInBheW1lbnRNZXRob2QiOnsiZGlzcGxheU5hbWUiOiJNYXN0ZXJDYXJkIDE0NzEiLCJuZXR3b3JrIjoiTWFzdGVyQ2FyZCIsInR5cGUiOiJkZWJpdCJ9LCJ0cmFuc2FjdGlvbklkZW50aWZpZXIiOiIyQTg1NUZEMDlEMjk0MUUzNTI4RDI0OUFFMDFDOEE4RTlBOTNEQjY2Q0M2QjVBMTZBNzE4MEVENTk0MkFGOEQzIn0=" } }, "description" : "The means of payment that will be used. Exactly one of the given means is valid." }, "MerchantInformation" : { "type" : "object", "properties" : { "locale" : { "type" : "string", "description" : "Language of the form to be displayed according to ISO 639-1.", "example" : "en" }, "merchant_data_1" : { "type" : "string", "description" : "The first merchant data field.", "example" : "123456789" }, "merchant_data_2" : { "type" : "string", "description" : "The second merchant data field.", "example" : "123456789" }, "merchant_data_3" : { "type" : "string", "description" : "The third merchant data field.", "example" : "123456789" }, "extensions" : { "$ref" : "#/components/schemas/MerchantInformationExtensions" } } }, "MerchantInformationExtensions" : { "type" : "object", "properties" : { "klarna_data" : { "$ref" : "#/components/schemas/MerchantInformationKlarnaData" } }, "description" : "Service specific merchant information fields." }, "MerchantInformationKlarnaData" : { "type" : "object", "properties" : { "custom_payment_method_ids" : { "type" : "array", "description" : "List of custom payment method ids.", "example" : [ "klarna_invoice", "klarna_installments" ], "items" : { "type" : "string", "description" : "List of custom payment method ids.", "example" : "[\"klarna_invoice\",\"klarna_installments\"]" } } }, "description" : "Klarna specific MerchantInformation fields." }, "MerchantRiskIndicators" : { "type" : "object", "properties" : { "delivery_email_address" : { "type" : "string", "description" : "The delivery email address." }, "delivery_timeframe" : { "type" : "string", "description" : "The delivery time frame for this order.", "enum" : [ "ELECTRONIC", "MORE_THAN_ONE_DAY", "OVERNIGHT", "SAME_DAY" ] }, "gift_card_amount" : { "type" : "string", "description" : "The gift card amount." }, "gift_card_count" : { "type" : "string", "description" : "The gift card count." }, "gift_card_currency" : { "type" : "string", "description" : "The gift card currency." }, "pre_order_date" : { "type" : "string", "description" : "The preorder date. Full-date notation as defined by RFC 3339 section 5.6.", "format" : "date" }, "pre_order_purchase_indicator" : { "type" : "string", "description" : "The preorder purchase indicator.", "enum" : [ "AVAILABLE", "FUTURE" ] }, "reordered_items_indicator" : { "type" : "string", "description" : "The reordered items indicator.", "enum" : [ "FIRST", "REORDERED" ] }, "shipping_indicator" : { "type" : "string", "description" : "The shipping indicator.", "enum" : [ "DIGITAL", "OTHER", "BILLING_ADDRESS", "DIFFERENT_ADDRESS", "STORE", "VERIFIED_ADDRESS" ] } } }, "PersonalIdentification" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Type of identification.\n\n* `NATIONAL`\n* `PASSPORT`\n* `CPF`\n* `CNPJ`\n* `CURP`\n* `SSN`\n* `DRIVERS_LICENSE`\n", "example" : "PASSPORT", "enum" : [ "NATIONAL", "PASSPORT", "CPF", "CNPJ", "CURP", "SSN", "DRIVERS_LICENSE" ] }, "id" : { "maxLength" : 26, "minLength" : 0, "type" : "string", "description" : "The value of the identification type. For 'PASSPORT', this is the customer's passport number. For 'CPF', set this field to the Cadastro de Pessoas Fisicas.", "example" : "T220001297" }, "issued_by" : { "type" : "string", "description" : "The government agency that issued the identification. For 'DRIVERS_LICENSE', this is the administrative area where it was issued. For 'PASSPORT', this is the country that issued the passport. Use the two-character state, province or territory codes respectively for United States and Canada.", "example" : "DE" } }, "description" : "Customer's legal ID data." }, "Quantity" : { "required" : [ "quantity_amount", "quantity_unit" ], "type" : "object", "properties" : { "quantity_amount" : { "minimum" : 0, "type" : "integer", "description" : "Amount of units.", "format" : "int64", "example" : 5 }, "quantity_unit" : { "maxLength" : 8, "minLength" : 0, "type" : "string", "description" : "Unit used to describe the quantity.", "example" : "pcs" } }, "description" : "A quantity." }, "RiskCheckAdditionalInformation" : { "type" : "object", "properties" : { "fingerprint_session_id" : { "maxLength" : 88, "minLength" : 0, "type" : "string", "description" : "Fingerprint session ID of the device and request of the customer.", "example" : "529572354443398504" } }, "description" : "Additional information for calculation of the risk of a transaction." }, "RiskCheckMerchantDefinedInformation" : { "type" : "object", "properties" : { "key" : { "maxLength" : 255, "minLength" : 0, "type" : "string", "description" : "Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event Riskmanagement discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, Riskmanagement will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.", "example" : "MDD_001" }, "value" : { "maxLength" : 255, "minLength" : 0, "type" : "string", "description" : "String value for the key.", "example" : "nightly order" } }, "description" : "Merchant defined information of the order. This must not be used to capture personally identifying information." }, "RiskCheckPassenger" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Passenger classification as indicated by the price discount class of the ticket. The following values are valid:\n\n* `ADT`: Adult\n* `CNN`: Child\n* `INF`: Infant\n* `YTH`: Youth\n* `STU`: Student\n* `SCR`: Senior Citizen\n* `MIL`: Military\n", "example" : "ADT", "enum" : [ "ADT", "CNN", "INF", "YTH", "STU", "SCR", "MIL" ] }, "status" : { "maxLength" : 32, "minLength" : 0, "type" : "string", "description" : "Merchant specific passenger classification, such as standard, gold, or platinum.", "example" : "standard" }, "phone" : { "$ref" : "#/components/schemas/PhoneContact" }, "first_name" : { "maxLength" : 60, "minLength" : 0, "type" : "string", "description" : "First name of the individual.", "example" : "Jane" }, "last_name" : { "maxLength" : 60, "minLength" : 0, "type" : "string", "description" : "Last name of the individual.", "example" : "Doe" }, "id" : { "maxLength" : 40, "minLength" : 0, "type" : "string", "description" : "ID of the passenger to whom a ticket was issued. For example, this field may contain the frequent flyer number.", "example" : "B7564" }, "email" : { "maxLength" : 255, "minLength" : 0, "type" : "string", "description" : "Email address of the individual.", "example" : "test_jane@gmail.com" }, "country" : { "maxLength" : 2, "minLength" : 2, "pattern" : "[A-Z]{2}", "type" : "string", "description" : "The ISO 3166 Alpha-2 country code (upper case) of the individual's homeland.", "example" : "DE" } }, "description" : "A (plane) passenger as modelled from the point of view of a risk check service." }, "RiskCheckTravelInformation" : { "type" : "object", "properties" : { "actual_final_destination" : { "maxLength" : 3, "minLength" : 0, "type" : "string", "description" : "IATA Code for the actual final destination that the customer intends to travel to.\nIt should be a destination on the complete_route.", "example" : "SFO" }, "complete_route" : { "maxLength" : 255, "minLength" : 0, "type" : "string", "description" : "Concatenation of individual travel legs in the format ORIG1-DEST1[:ORIG2-DEST2...:ORIGn-DESTn]", "example" : "SFO-JFK:JFK-LHR:LHR-CDG" }, "departure_time" : { "type" : "string", "description" : "Departure date and time of the first leg of the trip.", "format" : "date-time" }, "journey_type" : { "type" : "string", "description" : "Type of travel, for example one way or round trip.\n \n* `ONEWAY`\n* `ROUNDTRIP`\n", "example" : "ONEWAY", "enum" : [ "ONEWAY", "ROUNDTRIP" ] }, "legs" : { "maxItems" : 60, "minItems" : 0, "type" : "array", "description" : "Single legs of the complete journey.", "items" : { "$ref" : "#/components/schemas/RiskmanagementTravelInformationLeg" } }, "number_of_passengers" : { "type" : "string", "description" : "Number of passengers for whom the ticket was issued.", "example" : "1" }, "passengers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RiskmanagementTravelInformationPassenger" } } }, "description" : "Travel information of the order." }, "RiskmanagementTravelInformationLeg" : { "type" : "object", "properties" : { "origination" : { "maxLength" : 3, "minLength" : 0, "type" : "string", "description" : "Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search.", "example" : "SFO" }, "destination" : { "maxLength" : 3, "minLength" : 0, "type" : "string", "description" : "Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search.", "example" : "LHR" }, "carrier_code" : { "maxLength" : 2, "minLength" : 0, "type" : "string", "description" : "International Air Transport Association (IATA) code for the carrier for this leg of the trip. Required for each leg.", "example" : "LH" }, "departure_date" : { "maxLength" : 8, "minLength" : 8, "type" : "string", "description" : "Departure date for the first leg of the trip.", "example" : "20240212" } }, "description" : "Information about a leg of the complete journey." }, "RiskmanagementTravelInformationPassenger" : { "type" : "object", "properties" : { "first_name" : { "maxLength" : 60, "minLength" : 0, "type" : "string", "description" : "First name of the individual.", "example" : "Jane" }, "last_name" : { "maxLength" : 60, "minLength" : 0, "type" : "string", "description" : "Last name of the individual.", "example" : "Doe" } }, "description" : "Information about a passenger." }, "TDS20Address" : { "required" : [ "city", "country", "postal_code", "street" ], "type" : "object", "properties" : { "city" : { "type" : "string", "description" : "City of the address.", "example" : "Munich" }, "country" : { "maxLength" : 2, "minLength" : 2, "pattern" : "[A-Z]{2}", "type" : "string", "description" : "The ISO 3166 Alpha-2 country code (upper case) of the individual's homeland.", "example" : "DE" }, "postal_code" : { "type" : "string", "description" : "Postal code of the address.", "example" : "80469" }, "state" : { "type" : "string", "description" : "State or province of the address.", "example" : "BY" }, "street" : { "type" : "string", "description" : "The street." }, "street_number" : { "type" : "string", "description" : "The street number." }, "additional1" : { "type" : "string", "description" : "An additional first line." }, "additional2" : { "type" : "string", "description" : "An additional second line." } }, "description" : "Address data for 3DS 2.0 transactions." }, "TDS20CardHolderAccountInfo" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "The account ID." }, "account_age_indicator" : { "type" : "string", "description" : "The account age indicator.", "enum" : [ "LESS_30", "MORE_30_LESS_60", "MORE_60", "NEVER", "NOW" ] }, "password_change_indicator" : { "type" : "string", "description" : "The account password change indicator.", "enum" : [ "LESS_30", "MORE_30_LESS_60", "MORE_60", "NEVER", "NOW" ] }, "payment_account_age_indicator" : { "type" : "string", "description" : "The payment account age indicator.", "enum" : [ "LESS_30", "MORE_30_LESS_60", "MORE_60", "NEVER", "NOW" ] }, "account_change" : { "type" : "string", "description" : "The account change.", "enum" : [ "LESS_30", "MORE_30_LESS_60", "MORE_60", "NOW" ] }, "shipping_address_age_indicator" : { "type" : "string", "description" : "The shipping address age indicator.", "enum" : [ "LESS_30", "MORE_30_LESS_60", "MORE_60", "NOW" ] }, "account_change_date" : { "type" : "string", "description" : "The account change date.", "format" : "date" }, "account_opened_date" : { "type" : "string", "description" : "The account opened date.", "format" : "date" }, "password_change_date" : { "type" : "string", "description" : "The password change date.", "format" : "date" }, "payment_account_age" : { "type" : "string", "description" : "The payment account age.", "format" : "date" }, "shipping_address_age" : { "type" : "string", "description" : "The shipping address age.", "format" : "date" }, "purchases_six_month_count" : { "type" : "integer", "description" : "The 6 month purchases counter", "format" : "int32" }, "provisioning_day_count" : { "type" : "integer", "description" : "The provisioning day counter", "format" : "int32" }, "transactions_day_count" : { "type" : "integer", "description" : "The transaction day counter", "format" : "int32" }, "transactions_year_count" : { "type" : "integer", "description" : "The transaction year counter", "format" : "int32" }, "shipping_name_indicator" : { "type" : "string", "description" : "The shipping name indicator.", "enum" : [ "DIFFERENT", "IDENTICAL" ] }, "suspicious_account_activity" : { "type" : "string", "description" : "The suspicious account activity.", "enum" : [ "OBSERVED", "NOT_OBSERVED" ] } } }, "TDS20CommunicationData" : { "type" : "object", "properties" : { "method_notification_url" : { "type" : "string", "description" : "The URL to send the method notification to." }, "cres_notification_url" : { "type" : "string", "description" : "The URL to send the CRes to." } } }, "TDS20CustomerData" : { "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/TDS20Address" }, "shipping_address" : { "$ref" : "#/components/schemas/TDS20Address" }, "home_phone_number" : { "$ref" : "#/components/schemas/TDS20PhoneNumber" }, "mobile_phone_number" : { "$ref" : "#/components/schemas/TDS20PhoneNumber" }, "work_phone_number" : { "$ref" : "#/components/schemas/TDS20PhoneNumber" }, "cardholder_account_info" : { "$ref" : "#/components/schemas/TDS20CardHolderAccountInfo" }, "cardholder_email" : { "type" : "string" }, "addresses_match" : { "type" : "string", "enum" : [ "MATCHES", "DOES_NOT_MATCH" ] } } }, "TDS20Data" : { "type" : "object", "properties" : { "customer_data" : { "$ref" : "#/components/schemas/TDS20CustomerData" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "communication_data" : { "$ref" : "#/components/schemas/TDS20CommunicationData" }, "requestor_challenge_indicator" : { "type" : "string", "enum" : [ "NO_PREFERENCE", "NO_CHALLENGE_REQUESTED", "CHALLENGE_REQUESTED_3DS_REQUESTOR_PREFERENCE", "CHALLENGE_REQUESTED_MANDATE", "NO_CHALLENGE_REQUESTED_RISK_ANALYSIS_ALREADY_PERFORMED", "NO_CHALLENGE_REQUESTED_DATA_SHARE_ONLY", "NO_CHALLENGE_REQUESTED_STRONGER_CONSUMER_AUTHENTICATION_ALREADY_PERFORMED", "NO_CHALLENGE_REQUESTED_UTILISE_WHITELIST_EXEMPTION_IF_NO_CHALLENGE_REQUIRED", "CHALLENGE_REQUESTED_WHITELIST_PROMPT_REQUESTED_IF_CHALLENGE_REQUIRED" ] }, "transaction_attributes" : { "$ref" : "#/components/schemas/TDS20TransactionAttributes" } }, "description" : "3-D Secure data. Activates 3-D Secure processing if values are set." }, "TDS20PhoneNumber" : { "type" : "object", "properties" : { "country" : { "type" : "string", "description" : "The country code of the phone number." }, "regional" : { "type" : "string", "description" : "The regional part of the phone number." } }, "description" : "Phone number with country code." }, "TDS20TransactionAttributes" : { "type" : "object", "properties" : { "purchase_instalment_data" : { "maximum" : 999, "minimum" : 2, "type" : "integer", "description" : "Maximum number of authorizations permitted for instalment payments, must be > 1.", "format" : "int32" }, "recurring_expiry" : { "type" : "string", "description" : "Date after which no further authorizations shall be carried out.", "format" : "date" }, "recurring_frequency" : { "maximum" : 9999, "minimum" : 1, "type" : "integer", "description" : "Minimum number of days between authorizations.", "format" : "int32" }, "transaction_type" : { "type" : "string", "description" : "Type of 3-D Secure 2.0 payment.", "enum" : [ "PURCHASE", "CHECK_ACCEPTANCE", "ACCOUNT_FUNDING", "QUASI_CASH", "PREPAID_ACTIVATION" ] } } }, "TaxInfo" : { "required" : [ "tax_id", "tax_id_type" ], "type" : "object", "properties" : { "tax_id" : { "type" : "string", "description" : "The customer's tax ID value.", "example" : "867.226.847-41" }, "tax_id_type" : { "type" : "string", "description" : "Type of tax ID. May be country specific. Different types may adhere to different patterns.\n\n* `BR_CPF` : Brazilian individual tax id type.\n* `BR_CNPJ` : Brazilian business tax id type.\n* `OTHER` : None of the above.\n", "example" : "BR_CPF", "enum" : [ "BR_CPF", "BR_CNPJ", "OTHER" ] } }, "description" : "Legal tax information of the payer." }, "TaxedAmountCurrency" : { "required" : [ "currency", "gross", "net", "tax" ], "type" : "object", "properties" : { "net" : { "type" : "integer", "description" : "Amount of money excl. tax in the minor currency unit.", "format" : "int64", "example" : 100 }, "gross" : { "type" : "integer", "description" : "Amount of money incl. tax in the minor currency unit.", "format" : "int64", "example" : 100 }, "currency" : { "maxLength" : 3, "minLength" : 3, "pattern" : "[A-Z]{3}", "type" : "string", "description" : "ISO 4217 currency code, three uppercase letters.", "example" : "EUR" }, "tax" : { "maximum" : 10000, "minimum" : 0, "type" : "integer", "description" : "Tax percentage. Non-negative value. The percentage value is represented with two implicit decimals.", "format" : "int32", "example" : 1900 } }, "description" : "Net and gross money amount accompanied by a tax percentage and currency." }, "EScoreAddresscheckResponse" : { "required" : [ "event_id", "message", "rc", "reason", "tx_id" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "event_id" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string", "description" : "A unique ID for the event.", "example" : "E5686585867636541231230" }, "tx_id" : { "type" : "string", "description" : "Unique transaction identifier. Can be used to reference this transaction.", "example" : "020LMG10jxSI8FN0OC4vLR" }, "scoring_rc" : { "type" : "string", "description" : "Traffic light value that allows you a basic estimate of a customer's credit-worthiness. The following values are valid:\n\n`G`: green - There are no negative features.\n\n`Y`: yellow/amber - There is a soft negative feature.\n\n`R`: red - There are more than one soft negative features or at least one medium or hard negative feature.\n\n`U`: unknown\n", "example" : "G", "default" : "U", "enum" : [ "G", "Y", "R", "U" ] }, "reason" : { "type" : "string", "description" : "Codes for the classification of the credit assessments. The following values are valid:\n\n`ABK`: Request for credit assessment before concluding a purchase contract (in particular purchase on account or by instalments.\n\n`ABV`: Request for credit assessment before concluding an insurance contract.\n\n`BZV`: Credit assessment within the scope of evaluating the reliability of an insurance broker or an insurance field representative.\n\n`BMT`: Credit assessment before opening or installing a mobile telecommunication account.\n\n`BFT`: Request for credit assessment before or in connection with the initiation or carrying out of debt-collecting measures.\n\n`ABI`: Request for credit assessment before takeover/purchase of a claim or before assuming del credere liability.\n\n`ABF`: Request for credit assessment before concluding a service contract.\n\n`ABD`: Request for credit assessment before concluding a contract for work and labour.\n\n`ABW`: Request for credit assessment before concluding a contract for work and labour.\n\n`ABL`: Request for credit assessment before concluding a lease or rental contract (chattels).\n\n`BKV`: Credit assessment before granting of credit.\n\n`BKE`: Credit assessment before opening an account.\n\n`BKA`: Credit assessment due to a credit or customer card application.\n\n`BBS`: Credit assessment before concluding a building loan contract.\n\n`BMV`: Credit assessment before concluding a rental contract (real estate).\n\n`BFV`: Credit assessment before concluding a franchising contract.\n\n`BER`: Credit assessment due to ascertainment order (credit agency company).\n", "example" : "ABD", "default" : "ABK", "enum" : [ "ABK", "ABV", "BZV", "BMT", "BFT", "ABI", "ABF", "ABD", "ABW", "ABL", "BKV", "BKE", "BKA", "BBS", "BMV", "BFV", "BER" ] }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "address" : { "$ref" : "#/components/schemas/CommonAddress" }, "address_note" : { "type" : "string", "description" : "Possible features for the result of address verification. The following values are valid:\n\n`PPB`: Confirmation on personal level. The address supplied (incl. name and first name) was completely correct or could be corrected completely. In this case only the freight routing code and possibly the corrected fields are returned to the initiator.\n\n`PHB`: Confirmation on household level. The address supplied (incl. name without first name) could be corrected completely or was completely correct on household level and had a first name, which is not rectifiable/known. In this case the corrected fields except the first name are returned to the initiator, as the first name could not be confirmed. The existence of the first name at this address could not be confirmed. In addition the field eScoreFreightRoutingCode is returned to the initiator as long as the freight routing code is available.\n\n`PAB`: Confirmation on address level. The address supplied (without name, without first name) could be corrected completely or on address level was already complete and had not rectifiable/known personal data. In this case the corrected fields except the first name and surname are returned to the initiator, as the first name and surname could not be confirmed. The existence of the first name and surname at this address could not be confirmed. In addition the field eScoreFreightRoutingCode is returned to the initiator as long as the freight routing code is available.\n\n`PNZ`: The person at the address supplied is known, but at this address is not or no longer deliverable. This corresponds to a confirmation on address level (PAB), however, with the above-mentioned limitation, that the person queried is undeliverable there.\n\n`PPV`: The person at the address supplied is deceased according to the Deutsche Post (German mail).\n\n`PKI`: The response of the Deutsche Post (German mail) is possibly contradictory and/or ambiguous. Therefore the person/address is not assessed!\n\n`PPF`: The address is postally wrong.\n\n`PNP`: The address cannot be checked because it contains structural errors, for example the name is missing.\n\n`PUG`: The address is formally correct, but the building is not known.\n\n`PUZ`: Outdated address. The person moved away, but the new address is known.\n", "example" : "PPB", "enum" : [ "PPB", "PHB", "PAB", "PNZ", "PPV", "PKI", "PPF", "PNP", "PUG", "PUZ" ] }, "freight_routing_code" : { "maxLength" : 12, "minLength" : 0, "pattern" : ".*", "type" : "string", "description" : "Freight routing code of the Deutsche Post AG (German mail).", "example" : "04109056012" } } }, "EScoreRequest" : { "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "reason" : { "type" : "string", "description" : "Codes for the classification of the credit assessments. The following values are valid:\n\n`ABK`: Request for credit assessment before concluding a purchase contract (in particular purchase on account or by instalments.\n\n`ABV`: Request for credit assessment before concluding an insurance contract.\n\n`BZV`: Credit assessment within the scope of evaluating the reliability of an insurance broker or an insurance field representative.\n\n`BMT`: Credit assessment before opening or installing a mobile telecommunication account.\n\n`BFT`: Request for credit assessment before or in connection with the initiation or carrying out of debt-collecting measures.\n\n`ABI`: Request for credit assessment before takeover/purchase of a claim or before assuming del credere liability.\n\n`ABF`: Request for credit assessment before concluding a service contract.\n\n`ABD`: Request for credit assessment before concluding a contract for work and labour.\n\n`ABW`: Request for credit assessment before concluding a contract for work and labour.\n\n`ABL`: Request for credit assessment before concluding a lease or rental contract (chattels).\n\n`BKV`: Credit assessment before granting of credit.\n\n`BKE`: Credit assessment before opening an account.\n\n`BKA`: Credit assessment due to a credit or customer card application.\n\n`BBS`: Credit assessment before concluding a building loan contract.\n\n`BMV`: Credit assessment before concluding a rental contract (real estate).\n\n`BFV`: Credit assessment before concluding a franchising contract.\n\n`BER`: Credit assessment due to ascertainment order (credit agency company).\n", "example" : "ABD", "default" : "ABK", "enum" : [ "ABK", "ABV", "BZV", "BMT", "BFT", "ABI", "ABF", "ABD", "ABW", "ABL", "BKV", "BKE", "BKA", "BBS", "BMV", "BFV", "BER" ] } } }, "EScoreCreditassessmentResponse" : { "required" : [ "event_id", "message", "rc", "reason", "tx_id" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "event_id" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string", "description" : "A unique ID for the event.", "example" : "E5686585867636541231230" }, "tx_id" : { "type" : "string", "description" : "Unique transaction identifier. Can be used to reference this transaction.", "example" : "020LMG10jxSI8FN0OC4vLR" }, "scoring_rc" : { "type" : "string", "description" : "Traffic light value that allows you a basic estimate of a customer's credit-worthiness. The following values are valid:\n\n`G`: green - There are no negative features.\n\n`Y`: yellow/amber - There is a soft negative feature.\n\n`R`: red - There are more than one soft negative features or at least one medium or hard negative feature.\n\n`U`: unknown\n", "example" : "G", "default" : "U", "enum" : [ "G", "Y", "R", "U" ] }, "reason" : { "type" : "string", "description" : "Codes for the classification of the credit assessments. The following values are valid:\n\n`ABK`: Request for credit assessment before concluding a purchase contract (in particular purchase on account or by instalments.\n\n`ABV`: Request for credit assessment before concluding an insurance contract.\n\n`BZV`: Credit assessment within the scope of evaluating the reliability of an insurance broker or an insurance field representative.\n\n`BMT`: Credit assessment before opening or installing a mobile telecommunication account.\n\n`BFT`: Request for credit assessment before or in connection with the initiation or carrying out of debt-collecting measures.\n\n`ABI`: Request for credit assessment before takeover/purchase of a claim or before assuming del credere liability.\n\n`ABF`: Request for credit assessment before concluding a service contract.\n\n`ABD`: Request for credit assessment before concluding a contract for work and labour.\n\n`ABW`: Request for credit assessment before concluding a contract for work and labour.\n\n`ABL`: Request for credit assessment before concluding a lease or rental contract (chattels).\n\n`BKV`: Credit assessment before granting of credit.\n\n`BKE`: Credit assessment before opening an account.\n\n`BKA`: Credit assessment due to a credit or customer card application.\n\n`BBS`: Credit assessment before concluding a building loan contract.\n\n`BMV`: Credit assessment before concluding a rental contract (real estate).\n\n`BFV`: Credit assessment before concluding a franchising contract.\n\n`BER`: Credit assessment due to ascertainment order (credit agency company).\n", "example" : "ABD", "default" : "ABK", "enum" : [ "ABK", "ABV", "BZV", "BMT", "BFT", "ABI", "ABF", "ABD", "ABW", "ABL", "BKV", "BKE", "BKA", "BBS", "BMV", "BFV", "BER" ] }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "address" : { "$ref" : "#/components/schemas/CommonAddress" }, "score" : { "type" : "string", "description" : "Subtly graduated result of the credit assessment. The following values are valid:\n\n**score - Performs a Credit Assessment (ES0012).:**\n\n`550`: There are no negative features., scoring_rc = G, credit assessment = KI\n\n`540`: A soft feature, cleared., scoring_rc = G, credit assessment = Feature cleared\n\n`340`: Medium feature(s), cleared or more than one soft feature cleared., scoring_rc = Y, credit assessment = Feature cleared\n\n`320`: A message with reservations, soft., scoring_rc = Y, credit assessment = Mwr\n\n`310`: A soft feature., scoring_rc = Y, credit assessment = Feature\n\n`250`: Message with reservations marked a) hard/medium or b) more than one data record exist., scoring_rc = Y, credit assessment = Mwr\n\n`120`: Person registered as deceased., scoring_rc = R, credit assessment = +++\n\n`110`: Requested address is registered as risk address., scoring_rc = R, credit assessment = TKZ 5\n\n`100`: Person with negative feature(s) medium or hard or more than one soft., scoring_rc = R, credit assessment = Features\n\n**score - Performs an integrated Address Verification, Credit Assessment, and Scoring (ES0015).:**\n\n`980`: No negative features, score >= 500., scoring_rc = G, credit assessment = KI, address verification = PPB\n\n`970`: No negative features, score >= 500., scoring_rc = G, credit assessment = KI, address verification = PHB\n\n`960`: No negative features, score >450 <500., scoring_rc = G, credit assessment = KI, address verification = PPB\n\n`950`: No negative features, score >450 <500., scoring_rc = G, credit assessment = KI, address verification = PHB\n\n`760`: No negative features, score >= 500., scoring_rc = G, credit assessment = KI, address verification = PAB\n\n`750`: No negative features, score >450 <500., scoring_rc = G, credit assessment = KI, address verification = PAB\n\n`560`: No negative features, score >= 500., scoring_rc = G, credit assessment = KI, address verification = PKI\n\n`550`: No negative features, score >450 <500., scoring_rc = G, credit assessment = KI, address verification = PKI\n\n`540`: A soft feature, cleared., scoring_rc = G, credit assessment = Feature cleared, address verification = Any\n\n`530`: No negative features, score not possible., scoring_rc = G, credit assessment = KI, address verification = Any\n\n`460`: No negative features, score >=500., scoring_rc = G, credit assessment = KI, address verification = PPF\n\n`450`: No negative features, score >450 <500., scoring_rc = G, credit assessment = KI, address verification = PPF\n\n`370`: No negative features, score >=500., scoring_rc = Y, credit assessment = KI, address verification = PNZ\n\n`360`: No negative features, score >450 <500., scoring_rc = Y, credit assessment = KI, address verification = PNZ\n\n`350`: No negative features, score <=450., scoring_rc = Y, credit assessment = KI, address verification = Any\n\n`340`: Medium feature(s), cleared or more than one soft feature, cleared., scoring_rc = Y, credit assessment = Feature cleared, address verification = Any\n\n`320`: A message with reservations, soft., scoring_rc = Y, credit assessment = Mwr, address verification = Any\n\n`310`: A soft feature., scoring_rc = Y, credit assessment = Feature, address verification = Any\n\n`250`: Message with reservations marked a) hard/medium or b) more than one data record exist., scoring_rc = Y, credit assessment = Mwr, address verification = Any\n\n`120`: Person registered as deceased., scoring_rc = R, credit assessment = +++, address verification = Any\n\n`110`: Requested address is registered as risk address., scoring_rc = R, credit assessment = TKZ 5, address verification = Any\n\n`100`: Person with negative feature(s)medium or hard or more than one soft., scoring_rc = R, credit assessment = Features, address verification = Any\n ", "example" : "550" }, "negative_criteria" : { "type" : "array", "description" : "If `scoring_rc`=`Y` or `scoring_rc`=`R`, several possible.", "items" : { "$ref" : "#/components/schemas/NegativeCriterionResponse" } } } }, "NegativeCriterionResponse" : { "required" : [ "date", "kind" ], "type" : "object", "properties" : { "kind" : { "type" : "string", "description" : "The codes of the negative features supplied in the response. The following values are valid:\n\n**Soft Negative Features:**\n\n`IA`: Debt-collecting delinquency procedure initiated.\n\n`AM`: Ongoing extra judicial debt-collecting delinquency procedure after partial payment or in the case of payments in instalments.\n\n`IE`: Suspension of the extra judicial debt-collecting delinquency procedure due to futility.\n\n**Medium Negative Features:**\n\n`MB`: Application for default summons.\n\n`VB`: Application for enforcement order.\n\n`TR`: Payer by instalments after claims entitlement.\n\n`ZWA`: Enforcement by writ of movables.\n\n`ZWI`: Enforcement by writ of immovables.\n\n`FRP`: Effectless attachment.\n\n`FRP`: Effectless attachment.\n\n`LP`: Attachment of salary or other claims due to a garnishee order.\n\n`UBV`: Address unknown (having left liabilities of monetary or goods credits).\n\n**Hard Negative Features:**\n\n`HB`: Arrest warrant to enforce affidavit.\n\n`HV`: Execution of arrest warrant to enforce affidavit.\n\n`EV`: Affidavit (“oath of manifestation”).\n\n`EEV`: Amendment of affidavit.\n\n`WEV`: Repeated affidavit, § 903 ZPO (Code of Civil Procedure).\n\n`SVV`: Refusal of asset information according to §882c para. 1 no. 1 ZPO.\n\n`SAV`: Recognisable futility of enforcement according to §882c para. 1 no. 2 ZPO.\n\n`SNZ`: Non-payer according to §882c para. 1 no. 3 ZPO.\n\n`IVE`: Attempt of out-of-court settlement within the scope of insolvency proceedings.\n\n`ISP`: Settlement of debts procedure initiated / application for initiation of insolvency proceedings.\n\n`IVS`: Order of preliminary measures of protection in the insolvency proceedings.\n\n`IVA`: Repeal of preliminary measures of protection in the insolvency proceedings.\n\n`IBE`: Initiation of insolvency proceedings / decree.\n\n`IBA`: Dismissal or suspension of the insolvency proceedings for lack of assets, § 26 Para. 2 InsO (Insolvency Statute).\n\n`IWP`: Repeal of insolvency proceedings.\n\n`IRB`: Issuance of waiver of remaining debts.\n\n`IRV`: Refusal of waiver of remaining debts.\n\n`KON`: Dismissal of application for initiation of insolvency proceedings for lack of assets, §107 KO (Bankruptcy Act).\n\n`KER`: Initiation of bankruptcy proceedings, § 108 KO (Bankruptcy Act).\n\n`KEM`: Suspension of bankruptcy proceedings for lack of assets, §§ 202, 204 KO (Bankruptcy Act).\n\n`KAS`: Repeal of bankruptcy proceedings (after closing date), § 163 KO (Bankruptcy Act)\n\n`VGE`: Initiation of composition procedure, § 11 ff VerglO (Rules of conciliation).\n\n`VGA`: Dismissal of application for initiation of composition procedure.\n\n`VEM`: Suspension of composition procedure after repealing the scheme of arrangement, §99 ff VerglO (Rules of conciliation).\n\n`VAS`: Repeal of composition procedure, § 90 ff VerglO (Rules of conciliation).\n\n`GVA`: Dismissal of application for initiation of general enforcement for lack of assets, §4 Abs. 2 GesO (General enforcement policy).\n\n`GVE`: Initiation or order of general enforcement, § 5 GesO (General enforcement policy).\n\n`GEM`: Suspension of general enforcement proceedings.\n\n`GAS`: Repeal of general enforcement proceedings.\n\n**Other Negative Features:**\n\n`*`: Respective negative feature stated, if the claim based on the collection operation has been cleared effectively – that is by payment.\n\n`AE`: Note regarding address.\n\n`+++`: Person deceased.\n\n`HI`: Notes regarding person or company.\n\n`HA`: Notes regarding address.\n", "example" : "IA" }, "date" : { "type" : "string", "format" : "date", "example" : "2007-09-23" }, "doc_reference" : { "maxLength" : 14, "minLength" : 0, "pattern" : ".*", "type" : "string", "description" : "File reference of the feature.", "example" : "DFS-sf-12345" }, "completion_date" : { "type" : "string", "description" : "Clearing date of a feature.", "format" : "date", "example" : "2007-09-23" }, "completion_flag" : { "type" : "boolean", "description" : "Clearing sign of the feature." } }, "description" : "If `scoring_rc`=`Y` or `scoring_rc`=`R`, several possible." }, "EScoreRPPResponse" : { "required" : [ "bank_account", "event_id", "message", "rc", "tx_id" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "event_id" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string", "description" : "A unique ID for the event.", "example" : "E5686585867636541231230" }, "tx_id" : { "type" : "string", "description" : "Unique transaction identifier. Can be used to reference this transaction.", "example" : "020LMG10jxSI8FN0OC4vLR" }, "scoring_rc" : { "type" : "string", "description" : "Traffic light value that allows you a basic estimate of a customer's credit-worthiness. The following values are valid:\n\n`G`: green - There are no negative features.\n\n`Y`: yellow/amber - There is a soft negative feature.\n\n`R`: red - There are more than one soft negative features or at least one medium or hard negative feature.\n\n`U`: unknown\n", "example" : "G", "default" : "U", "enum" : [ "G", "Y", "R", "U" ] }, "bank_account" : { "$ref" : "#/components/schemas/BankAccount" }, "bank_account_validation_result" : { "maxLength" : 2, "minLength" : 0, "pattern" : "[0-9]+", "type" : "string", "description" : "Result of the validation. The following values are valid:\n\n`00`: The bank account details are valid.\n\n`01`: The bank account details are valid but the bank code belongs to a subsidiary of the Bundesbank.\n\n`02`: The bank code is marked as deleted and was replaced by the successor bank code.\n\n`03`: The BIC does not match the bank code included in the IBAN.\n\n`04`: The bank code does not match the bank code included in the IBAN.\n\n`05`: The account number does not match the account number included in the IBAN.\n\n`06`: The country code does not match the country code included in the IBAN.\n\n`07`: The IBAN could not be determined unambiguously or the account number could not be validated unambiguously. If possible, the bank account details should be verified manually.\n\n`08`: The BIC could not be determined.\n\n`10`: The IBAN check sum is invalid.\n\n`11`: The country code in the IBAN is invalid.\n\n`12`: The IBAN format is invalid.\n\n`13`: The BIC is invalid.\n\n`14`: The bank code is invalid.\n\n`15`: The IBAN cannot be determined.\n\n`16`: The account number is invalid.\n", "example" : "08" }, "bank_account_validation_message" : { "maxLength" : 30, "minLength" : 0, "pattern" : ".*", "type" : "string", "description" : "Description of the validation result." }, "rpp_match" : { "pattern" : "[01]", "type" : "string", "description" : "Hit in RPP. The following values are valid:\n\n`0`: no hit\n\n`1`: hit(s)\n", "example" : "1", "enum" : [ "0", "1" ] }, "rpp_result" : { "type" : "array", "description" : "Result of an RPP check.", "items" : { "$ref" : "#/components/schemas/RppResultResponse" } }, "error_code_name" : { "maxLength" : 33, "minLength" : 0, "pattern" : ".*", "type" : "string", "description" : "Error code of the RPP check.", "example" : "parsingError" }, "error_description" : { "maxLength" : 50, "minLength" : 0, "pattern" : ".*", "type" : "string", "description" : "Error description of the RPP check." } } }, "RppResultResponse" : { "type" : "object", "properties" : { "content_type" : { "maxLength" : 2, "minLength" : 0, "pattern" : "[0-9]+", "type" : "string", "description" : "Type of the notice. Is returned if `rpp_match=1`, that is if a return debit note is present. The following values are valid:\n\n`0`: Open return debit note.\n\n`1`: Settled return debit note.\n\n`2`: Historical return debit note.\n\n`3`: Institution/public bank details\n\n`5`: Client related negative list.\n\n`6`: Client related positive list.\n\n`7`: Cards blocked.\n\n`14`: Personal Account Protection (PAP).\n" }, "content_description" : { "maxLength" : 30, "minLength" : 0, "pattern" : ".*", "type" : "string", "description" : "Content description, for example RLS for a return debit note or NCA for publicly known bank details (\"non consumer account\").", "example" : "NCA" }, "content_code" : { "maxLength" : 2, "minLength" : 0, "pattern" : "[0-9]+", "type" : "string", "description" : "Reason of the notice. The following values are valid:\n\nIf eScoreContentType=0 (open/settled/historical return debit note): \n\n`1`: For want of cover / not paid.\n\n`2`: Account wrong.\n\n`3`: Objection.\n\n`5`: Account expired.\n\n`6`: other\n\n`7`: No information.\n\n`8`: No valid mandate.\n\nIf eScoreContentType=3 (institution/public bank details):\n\n`0`: Unclassified.\n\n`1`: Donations and aid organisations.\n\n`2`: Offices and public facilities.\n\n`3`: Societies.\n\n`4`: educational institutions and church\n\n`5`: Recreational institutions & tourism.\n\n`6`: Associations and foundations.\n\n`7`: Companies.\n\n`9`: eBay seller.\n\n`12`: Private person.\n\n`31`: Credit accounts.\n\nIf eScoreContentType=7 (cards locked):\n\n`0`: Debit card of the bank account was reported stolen/lost.\n\n`1`: There is an entry in the KUNO database for this bank account.\n\nIf eScoreContentType=14 (PAP):\n\n`1`: Donations and aid organisations.\n\n`2`: offices and public facilities\n\n`3`: Societies.\n\n`4`: Educational institutions and church.\n\n`5`: Recreational institutions & tourism.\n\n`6`: Associations and foundations.\n\n`7`: Companies.\n", "example" : "1" }, "no_of_matches" : { "maxLength" : 1, "minLength" : 0, "pattern" : "[0-9]+", "type" : "string", "description" : "Number of matches.", "example" : "1" }, "first_notice_date" : { "type" : "string", "description" : "Date of the first notice.", "format" : "date", "example" : "2007-08-24" }, "last_notice_date" : { "type" : "string", "description" : "Date of the last notice.", "format" : "date", "example" : "2007-08-24" } }, "description" : "Result of an RPP check." }, "EScoreRPPRequest" : { "required" : [ "bank_account" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "bank_account" : { "$ref" : "#/components/schemas/BankAccount" } } }, "EScoreScoringResponse" : { "required" : [ "address_note", "event_id", "message", "rc", "reason", "tx_id" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "event_id" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string", "description" : "A unique ID for the event.", "example" : "E5686585867636541231230" }, "tx_id" : { "type" : "string", "description" : "Unique transaction identifier. Can be used to reference this transaction.", "example" : "020LMG10jxSI8FN0OC4vLR" }, "scoring_rc" : { "type" : "string", "description" : "Traffic light value that allows you a basic estimate of a customer's credit-worthiness. The following values are valid:\n\n`G`: green - There are no negative features.\n\n`Y`: yellow/amber - There is a soft negative feature.\n\n`R`: red - There are more than one soft negative features or at least one medium or hard negative feature.\n\n`U`: unknown\n", "example" : "G", "default" : "U", "enum" : [ "G", "Y", "R", "U" ] }, "reason" : { "type" : "string", "description" : "Codes for the classification of the credit assessments. The following values are valid:\n\n`ABK`: Request for credit assessment before concluding a purchase contract (in particular purchase on account or by instalments.\n\n`ABV`: Request for credit assessment before concluding an insurance contract.\n\n`BZV`: Credit assessment within the scope of evaluating the reliability of an insurance broker or an insurance field representative.\n\n`BMT`: Credit assessment before opening or installing a mobile telecommunication account.\n\n`BFT`: Request for credit assessment before or in connection with the initiation or carrying out of debt-collecting measures.\n\n`ABI`: Request for credit assessment before takeover/purchase of a claim or before assuming del credere liability.\n\n`ABF`: Request for credit assessment before concluding a service contract.\n\n`ABD`: Request for credit assessment before concluding a contract for work and labour.\n\n`ABW`: Request for credit assessment before concluding a contract for work and labour.\n\n`ABL`: Request for credit assessment before concluding a lease or rental contract (chattels).\n\n`BKV`: Credit assessment before granting of credit.\n\n`BKE`: Credit assessment before opening an account.\n\n`BKA`: Credit assessment due to a credit or customer card application.\n\n`BBS`: Credit assessment before concluding a building loan contract.\n\n`BMV`: Credit assessment before concluding a rental contract (real estate).\n\n`BFV`: Credit assessment before concluding a franchising contract.\n\n`BER`: Credit assessment due to ascertainment order (credit agency company).\n", "example" : "ABD", "default" : "ABK", "enum" : [ "ABK", "ABV", "BZV", "BMT", "BFT", "ABI", "ABF", "ABD", "ABW", "ABL", "BKV", "BKE", "BKA", "BBS", "BMV", "BFV", "BER" ] }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "address" : { "$ref" : "#/components/schemas/CommonAddress" }, "address_note" : { "type" : "string", "description" : "Possible features for the result of address verification. The following values are valid:\n\n`PPB`: Confirmation on personal level. The address supplied (incl. name and first name) was completely correct or could be corrected completely. In this case only the freight routing code and possibly the corrected fields are returned to the initiator.\n\n`PHB`: Confirmation on household level. The address supplied (incl. name without first name) could be corrected completely or was completely correct on household level and had a first name, which is not rectifiable/known. In this case the corrected fields except the first name are returned to the initiator, as the first name could not be confirmed. The existence of the first name at this address could not be confirmed. In addition the field eScoreFreightRoutingCode is returned to the initiator as long as the freight routing code is available.\n\n`PAB`: Confirmation on address level. The address supplied (without name, without first name) could be corrected completely or on address level was already complete and had not rectifiable/known personal data. In this case the corrected fields except the first name and surname are returned to the initiator, as the first name and surname could not be confirmed. The existence of the first name and surname at this address could not be confirmed. In addition the field eScoreFreightRoutingCode is returned to the initiator as long as the freight routing code is available.\n\n`PNZ`: The person at the address supplied is known, but at this address is not or no longer deliverable. This corresponds to a confirmation on address level (PAB), however, with the above-mentioned limitation, that the person queried is undeliverable there.\n\n`PPV`: The person at the address supplied is deceased according to the Deutsche Post (German mail).\n\n`PKI`: The response of the Deutsche Post (German mail) is possibly contradictory and/or ambiguous. Therefore the person/address is not assessed!\n\n`PPF`: The address is postally wrong.\n\n`PNP`: The address cannot be checked because it contains structural errors, for example the name is missing.\n\n`PUG`: The address is formally correct, but the building is not known.\n\n`PUZ`: Outdated address. The person moved away, but the new address is known.\n", "example" : "PPB", "enum" : [ "PPB", "PHB", "PAB", "PNZ", "PPV", "PKI", "PPF", "PNP", "PUG", "PUZ" ] }, "freight_routing_code" : { "maxLength" : 12, "minLength" : 0, "pattern" : ".*", "type" : "string", "description" : "Freight routing code of the Deutsche Post AG (German mail).", "example" : "04109056012" }, "score" : { "type" : "string", "description" : "Subtly graduated result of the credit assessment. The following values are valid:\n\n**score - Performs a Credit Assessment (ES0012).:**\n\n`550`: There are no negative features., scoring_rc = G, credit assessment = KI\n\n`540`: A soft feature, cleared., scoring_rc = G, credit assessment = Feature cleared\n\n`340`: Medium feature(s), cleared or more than one soft feature cleared., scoring_rc = Y, credit assessment = Feature cleared\n\n`320`: A message with reservations, soft., scoring_rc = Y, credit assessment = Mwr\n\n`310`: A soft feature., scoring_rc = Y, credit assessment = Feature\n\n`250`: Message with reservations marked a) hard/medium or b) more than one data record exist., scoring_rc = Y, credit assessment = Mwr\n\n`120`: Person registered as deceased., scoring_rc = R, credit assessment = +++\n\n`110`: Requested address is registered as risk address., scoring_rc = R, credit assessment = TKZ 5\n\n`100`: Person with negative feature(s) medium or hard or more than one soft., scoring_rc = R, credit assessment = Features\n\n**score - Performs an integrated Address Verification, Credit Assessment, and Scoring (ES0015).:**\n\n`980`: No negative features, score >= 500., scoring_rc = G, credit assessment = KI, address verification = PPB\n\n`970`: No negative features, score >= 500., scoring_rc = G, credit assessment = KI, address verification = PHB\n\n`960`: No negative features, score >450 <500., scoring_rc = G, credit assessment = KI, address verification = PPB\n\n`950`: No negative features, score >450 <500., scoring_rc = G, credit assessment = KI, address verification = PHB\n\n`760`: No negative features, score >= 500., scoring_rc = G, credit assessment = KI, address verification = PAB\n\n`750`: No negative features, score >450 <500., scoring_rc = G, credit assessment = KI, address verification = PAB\n\n`560`: No negative features, score >= 500., scoring_rc = G, credit assessment = KI, address verification = PKI\n\n`550`: No negative features, score >450 <500., scoring_rc = G, credit assessment = KI, address verification = PKI\n\n`540`: A soft feature, cleared., scoring_rc = G, credit assessment = Feature cleared, address verification = Any\n\n`530`: No negative features, score not possible., scoring_rc = G, credit assessment = KI, address verification = Any\n\n`460`: No negative features, score >=500., scoring_rc = G, credit assessment = KI, address verification = PPF\n\n`450`: No negative features, score >450 <500., scoring_rc = G, credit assessment = KI, address verification = PPF\n\n`370`: No negative features, score >=500., scoring_rc = Y, credit assessment = KI, address verification = PNZ\n\n`360`: No negative features, score >450 <500., scoring_rc = Y, credit assessment = KI, address verification = PNZ\n\n`350`: No negative features, score <=450., scoring_rc = Y, credit assessment = KI, address verification = Any\n\n`340`: Medium feature(s), cleared or more than one soft feature, cleared., scoring_rc = Y, credit assessment = Feature cleared, address verification = Any\n\n`320`: A message with reservations, soft., scoring_rc = Y, credit assessment = Mwr, address verification = Any\n\n`310`: A soft feature., scoring_rc = Y, credit assessment = Feature, address verification = Any\n\n`250`: Message with reservations marked a) hard/medium or b) more than one data record exist., scoring_rc = Y, credit assessment = Mwr, address verification = Any\n\n`120`: Person registered as deceased., scoring_rc = R, credit assessment = +++, address verification = Any\n\n`110`: Requested address is registered as risk address., scoring_rc = R, credit assessment = TKZ 5, address verification = Any\n\n`100`: Person with negative feature(s)medium or hard or more than one soft., scoring_rc = R, credit assessment = Features, address verification = Any\n ", "example" : "550" }, "informa_score_value" : { "maxLength" : 3, "minLength" : 0, "pattern" : ".*", "type" : "string", "description" : "Generated scoring value of the InFoScore Consumer Data GmbH.", "example" : "480" }, "negative_criteria" : { "type" : "array", "description" : "If `scoring_rc`=`Y` or `scoring_rc`=`R`, several possible.", "items" : { "$ref" : "#/components/schemas/NegativeCriterionResponse" } } } }, "FormNoTxResponse" : { "required" : [ "message", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "redirect_url" : { "maxLength" : 1024, "minLength" : 0, "type" : "string", "description" : "URL to redirect the customer to.", "example" : "https://staging.pushpayments.db.com/pay/eyJwYXlsb2FkIjp7InYiOjEsImlwaS" } }, "description" : "Values required to initialize a form interaction." }, "Callback" : { "type" : "object", "properties" : { "notify_url" : { "maxLength" : 500, "minLength" : 1, "type" : "string", "description" : "URL for the shop notification.", "example" : "https://www.example.com/notify/e1234123489" }, "additional_data" : { "maxLength" : 255, "minLength" : 0, "type" : "string", "description" : "Freely allocatable field. Will be returned in the shop notification.", "example" : "SESSION_1234X" }, "skip" : { "type" : "boolean", "description" : "If true the shop notification is skipped.", "default" : false } }, "description" : "Data for the shop notification." }, "FormCustomerContinuation" : { "required" : [ "success_url" ], "type" : "object", "properties" : { "redirect" : { "type" : "boolean", "description" : "If `true` the customer will be redirected directly. If `false` a page with a link \"back to the shop\" is shown to the customer. \nFor paydirekt and PayPal the customer will always be redirected directly to the shop.", "example" : true }, "success_url" : { "type" : "string", "description" : "URL the customer should be redirected to after a successful form service payment.", "example" : "https://www.example.com/success" }, "error_url" : { "type" : "string", "description" : "URL the customer should be redirected to after a failed form service payment.", "example" : "https://www.example.com/error" }, "notification_failed_url" : { "type" : "string", "description" : "URL the customer should be redirected to after a successful form service transaction for which the notification of your application failed.", "example" : "https://www.example.com/notificationFailed" } }, "description" : "Includes data for redirecting a customer after a form service payment." }, "FormData" : { "type" : "object", "properties" : { "retries" : { "maximum" : 100, "minimum" : 0, "type" : "integer", "description" : "Specifies how often the customer may retry the payment if the payment fails. Default: 0.", "format" : "int32" }, "locale" : { "type" : "string", "description" : "Language of the form to be displayed according to ISO 639-1. The following languages are available:\n `bg` - Bulgarian,\n `ca` - Catalan,\n `cs` - Czech,\n `da` - Danish,\n `de` - German,\n `el` - Greek,\n `en` - English,\n `es` - Spanish,\n `et` - Estonian,\n `eu` - Basque,\n `fi` - Finnish,\n `fr` - French,\n `gl` - Galician,\n `hr` - Croatian,\n `hu` - Hungarian,\n `it` - Italian,\n `ja` - Japanese,\n `lt` - Lithuanian,\n `lv` - Latvian,\n `mt` - Maltese,\n `nl` - Dutch,\n `pl` - Polish,\n `pt` - Portuguese,\n `ro` - Romanian,\n `ru` - Russian,\n `sk` - Slovak,\n `sl` - Slovenian,\n `sv` - Swedish.\n If not submitted, the German form will be displayed. Additional \"locales\" with\n modified text exist for donations: `de_DE_sp` (donation, German) and `en_GB_sp`\n (donation, English).", "example" : "en" }, "label" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FormLabel" } }, "theme_properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FormThemeProperty" } } }, "description" : "Data to customize forms with labels, theme, style properties etc." }, "FormLabel" : { "required" : [ "key", "value" ], "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "The form label ID to be modified.", "enum" : [ "LABEL_AMOUNT", "LABEL_DATE", "LABEL_CANCEL", "LABEL_IBAN", "LABEL_MERCHANT", "LABEL_SUBMIT", "LABEL_WAIT", "MESSAGE_PAYMENT_CANCELED", "MESSAGE_PLEASE_GO", "MESSAGE_BACK_TO_CHECKOUT", "MERCHANTNAME", "TITLE_PAYMENT_DATA", "TITLE_PAYMENT_SUCCESSFUL", "TITLE_PSD2_ACCOUNT_INFO", "TITLE_PSD2_AUTHORISATION_REQUIRED", "TITLE_PSD2_AUTHORISE_AIS", "TITLE_PSD2_AUTHORISE_PIS", "TITLE_PAYMENT_CANCELED", "TITLE_CHECKOUT" ] }, "value" : { "type" : "string", "description" : "The new form label value." } }, "description" : "Custom label to be displayed in the form instead of the standard text." }, "FormRegisterAliasRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "alias" : { "maxLength" : 50, "minLength" : 0, "type" : "string", "description" : "The alias value. If no value is set an alias is created by the system.", "example" : "221f56ca355d8e6c42517749cf79ceb8" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" } }, "description" : "Request data to register a means of payment alias using the form service." }, "FormThemeProperty" : { "required" : [ "selector", "value" ], "type" : "object", "properties" : { "selector" : { "type" : "string", "description" : "For a number of elements custom CSS attributes can be applied.\n \nProperties ending with `ZINDEX`, `BOX_SHADOW`, `FONT_FAMILY`, `LETTER_SPACING` or `COLOR` refer\nto the following CSS attributes:\n\n\n* https://www.w3schools.com/cssref/pr_pos_z-index.asp[`z-index`] Example: `4321`\n* https://www.w3.org/TR/css-backgrounds-3/#box-shadow[`box-shadow`] Example: `0rem 0.375rem 1.5rem 0rem rgba(16,32,64,0.8)`\n* https://www.w3.org/TR/css-fonts-3/#font-family-desc[`font-family`] Example: `IBM Plex Sans`\n* https://www.w3.org/TR/CSS22/text.html#spacing-props[`letter-spacing`] Example: `0.027rem`\n* https://www.w3.org/TR/css-color-3/#rgb-color[`color`] Example: `srgb(192,32,32)`\n\nName of the theme properties:\n\n\n* `PREDEFINED`: the main theming. Available options are `dark` or `bright`\n* `GLOBAL_ZINDEX`: Global z-index. This z-index has to be higher than any z-index that may occur on page.\n* `POPUP_BOX_SHADOW`: Box shadow for whole popup.\n* `GLOBAL_FONT_FAMILY`: The one and only font family to use for any text in popup.\n* `GLOBAL_LETTER_SPACING`: Letter spacing for regular text.\n* `GLOBAL_FINEPRINT_LETTER_SPACING`: Letter spacing for fine print like caption above input fields.\n* `GLOBAL_INTERACTIVE_COLOR` Interactive color for elements like buttons or links.\n* `GLOBAL_INTERACTIVE_HOVER_COLOR` Color to use for hovering above interactive elements.\n* `MODAL_BACKGROUND_COLOR` Background color for modal element that covers everything below the popup.\n* `CARD_BACKGROUND_COLOR` Background color for main card.\n* `CARD_COLOR` Text color for main card. In css notation.\n* `HEADER_BACKGROUND_COLOR` Background color for header.\n* `FOOTER_BACKGROUND_COLOR` Background color for footer. Important for mobile view.\n* `BUTTON_SECONDARY_BACKGROUND_COLOR` Secondary colors may have a special background color instead of being transparent.\n* `BUTTON_PRIMARY_COLOR` Text color for primary buttons.\n* `INPUT_BACKGROUND_COLOR` Background color for input fields.\n* `INPUT_CAPTION_COLOR` Text color of captions above input fields.\n* `INPUT_PLACEHOLDER_COLOR` Text color for placeholders inside input fields.\n* `INPUT_BORDER_COLOR` The border color around input fields.\n* `INPUT_TEXT_COLOR` The text color for user entered values.\n\n", "enum" : [ "PREDEFINED", "GLOBAL_ZINDEX", "POPUP_BOX_SHADOW", "GLOBAL_FONT_FAMILY", "GLOBAL_LETTER_SPACING", "GLOBAL_FINEPRINT_LETTER_SPACING", "GLOBAL_INTERACTIVE_COLOR", "GLOBAL_INTERACTIVE_HOVER_COLOR", "MODAL_BACKGROUND_COLOR", "CARD_BACKGROUND_COLOR", "CARD_COLOR", "HEADER_BACKGROUND_COLOR", "FOOTER_BACKGROUND_COLOR", "BUTTON_SECONDARY_BACKGROUND_COLOR", "BUTTON_PRIMARY_COLOR", "INPUT_BACKGROUND_COLOR", "INPUT_CAPTION_COLOR", "INPUT_PLACEHOLDER_COLOR", "INPUT_BORDER_COLOR", "INPUT_TEXT_COLOR" ] }, "value" : { "type" : "string", "description" : "The property value." } }, "description" : "Custom theme property to be displayed in the form instead of the standard presentation." }, "FormResponse" : { "required" : [ "message", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "redirect_url" : { "maxLength" : 1024, "minLength" : 0, "type" : "string", "description" : "URL to redirect the customer to.", "example" : "https://staging.pushpayments.db.com/pay/eyJwYXlsb2FkIjp7InYiOjEsImlwaS" }, "tx_id" : { "type" : "string", "description" : "Unique transaction identifier. Can be used to reference this transaction.", "example" : "020LMG10jxSI8FN0OC4vLR" } }, "description" : "Values required to initialize a form interaction. Contains a reference to the created transaction." }, "FormRegisterAliasKlarnaRequest" : { "required" : [ "amount_total", "basket", "billing_address", "form_customer_continuation" ], "type" : "object", "properties" : { "alias" : { "maxLength" : 50, "minLength" : 0, "type" : "string", "description" : "The alias value. If no value is set an alias is created by the system.", "example" : "221f56ca355d8e6c42517749cf79ceb8" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "basket" : { "$ref" : "#/components/schemas/Basket" } } }, "EnhancedMandate" : { "required" : [ "reference", "signed_on" ], "type" : "object", "properties" : { "reference" : { "maxLength" : 35, "minLength" : 1, "pattern" : "[0-9a-zA-Z +?/\\-:().,']+", "type" : "string", "description" : "Reference number, unique identification of the SEPA mandate. A forward slash '/' is not allowed as the first or last character of the mandate reference number. Inside the mandate reference number two consecutive forward slashes are not allowed.", "example" : "M2013-987/1-AB" }, "mandate_name" : { "maxLength" : 70, "minLength" : 1, "pattern" : "[0-9a-zA-Z +?/\\-:().,']+", "type" : "string", "description" : "Name of the recipient that was used in the SEPA mandate. If not submitted, the name that is configured in the standing data of the shop will be used.", "example" : "Smith and Jones" }, "signed_on" : { "type" : "string", "description" : "Date when the SEPA mandate was issued. Only needed for provided mandates. Full-date notation as defined by RFC 3339, section 5.6", "format" : "date", "example" : "2017-01-01" }, "mandate_sequence_type" : { "type" : "string", "description" : "Sequence type of a payment. If not submitted a single payment is assumed.\n\n * `ONEOFF`: single payment\n * `FIRST`: first payment of a sequence\n * `RECURRING`: follow-up payment\n * `FINAL`: last payment of a sequence\n", "example" : "FIRST", "enum" : [ "ONEOFF", "FIRST", "RECURRING", "FINAL" ] }, "previous_reference" : { "maxLength" : 35, "minLength" : 1, "pattern" : "[0-9a-zA-Z +?/\\-:().,']+", "type" : "string", "description" : "Previous mandate reference number if the SEPA mandate is modified. Only in the case of recurring payments with the first payment after the mandate changed. A forward slash '/' is not allowed as the first or last character of the mandate reference number. Inside the mandate reference number two consecutive forward slashes are not allowed.", "example" : "M2013-987/1-AB" }, "previous_creditor_id" : { "type" : "string", "description" : "Previous creditor ID if the SEPA mandate is modified. Only in the case of recurring payments with the first payment after the mandate changed." }, "previous_bic" : { "maxLength" : 11, "minLength" : 11, "pattern" : "[A-Z]{6}[A-Z2-9][A-NP-Z0-9][A-Z0-9]{3}", "type" : "string", "description" : "Previous BIC of the customer if the SEPA mandate is modified. Only in the case of recurring payments with the first payment after the mandate changed. Is determined by {phrase-directpos} in the case of a German previous IBAN. Mandatory in case of a previous IBAN (field previous_iban) from another country.", "example" : "VZVDDED1XXX" }, "previous_iban" : { "maxLength" : 34, "minLength" : 15, "pattern" : "[A-Z]{2}[0-9]{2}[A-Z0-9*]{11,30}", "type" : "string", "description" : "Previous IBAN of the customer if the SEPA mandate is modified. Only in the case of recurring payments with the first payment after the mandate changed.", "example" : "DE17215730140403340300" }, "mandate_type" : { "type" : "string", "description" : "Type of mandate.\n \n * `PROVIDED`: The merchant manages mandate and prenotifications themselves and provides the mandate data.\n * `MANAGED`: The merchant uses the offered mandate management and prenotification service.\n \n Default: `PROVIDED`\n", "example" : "PROVIDED", "enum" : [ "PROVIDED", "MANAGED" ] }, "mandate_options" : { "type" : "array", "description" : "Mandate options.", "example" : [ "RISKCHECK" ], "items" : { "type" : "string", "description" : "Additional mandate options.\n \n * `RISKCHECK`: Mandate is created for customer direct debit with additional risk checks. Only available if this option has been activated for the shop.\n ", "example" : "[\"RISKCHECK\"]", "enum" : [ "RISKCHECK" ] } }, "mandate_id" : { "maxLength" : 32, "minLength" : 32, "type" : "string", "description" : "Unique identifier of a managed mandate.", "example" : "89c3d6b532be80339839f1605201f2c7" }, "approval_by" : { "type" : "string", "description" : "Indicates how the managed mandate needs to be approved by the customer.\n \n * `CLICK`: The hosted page displays a button which the customer has to click.\n * `EMAIL`: The hosted page sends the customer a PIN to the given email, which the customer then has to enter.\n * `SMS`: The hosted page sends the customer an SMS to the given phone number, which the customer then has to enter.\n * `AIS`: The hosted page uses an account information service to approve the mandate. For this, the customer is redirected to an account information service where they have to enter their online banking credentials.\n * `DYNAMIC`: The hosted page chooses one of the above approval methods based on the transaction amount.\n", "example" : "CLICK", "enum" : [ "CLICK", "EMAIL", "SMS", "AIS", "DYNAMIC" ] } } }, "FormCheckoutConfiguration" : { "required" : [ "checkout_entry_sorting_order" ], "type" : "object", "properties" : { "credit_card_data" : { "$ref" : "#/components/schemas/FormCheckoutCreditCardData" }, "google_pay_credit_card_data" : { "$ref" : "#/components/schemas/FormCheckoutCreditCardData" }, "direct_debit_data" : { "$ref" : "#/components/schemas/FormDirectDebitData" }, "request_to_pay_data" : { "$ref" : "#/components/schemas/FormRequestToPayData" }, "sofort_data" : { "$ref" : "#/components/schemas/FormSofortUeberweisungData" }, "paypal_data" : { "$ref" : "#/components/schemas/FormPayPalData" }, "giropay_data" : { "$ref" : "#/components/schemas/FormGiropayData" }, "paydirekt_data" : { "$ref" : "#/components/schemas/FormPaydirektData" }, "klarna_data" : { "$ref" : "#/components/schemas/FormKlarnaData" }, "psd2_pis_data" : { "$ref" : "#/components/schemas/FormPSD2PaymentData" }, "checkout_entry_sorting_order" : { "type" : "array", "items" : { "type" : "string", "description" : "The order in which the payment methods of the checkout_page_configuration are displayed. Possible values: \n \n* `CREDITCARD`\n* `DIRECTDEBIT`\n* `REQUEST_TO_PAY`\n* `SOFORTUEBERWEISUNG`\n* `PAYPAL`\n* `GIROPAY`\n* `PAYDIREKT`\n* `KLARNA`\n* `GOOGLEPAY`\n* `PSD2`\n", "example" : "CREDITCARD", "enum" : [ "CREDITCARD", "DIRECTDEBIT", "REQUEST_TO_PAY", "SOFORTUEBERWEISUNG", "PAYPAL", "GIROPAY", "PAYDIREKT", "KLARNA", "GOOGLEPAY", "PSD2" ] } } }, "description" : "Contains required and optional data for each payment method that should be offered." }, "FormCheckoutCreditCardData" : { "type" : "object", "properties" : { "tds_20_data" : { "$ref" : "#/components/schemas/TDS20Data" }, "recurring_payment" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[/0-9a-zA-Z_.:,+*$%-]+", "type" : "string", "description" : "Identifier of a recurring credit card payment.", "example" : "07H987Tx3PF9VxL5G7RfNp" }, "series_flag" : { "type" : "string", "description" : "Designates a payment as part of a series of payments.\n\n* `INSTALMENT`: for example in the case of paying a fixed sum in multiple partial payments.\n* `RECURRING`: for example in the case of a subscription or standing order.\n* `UCOF`: when a card number alias is created for future payments with the same credit card. In this case use _alias_action_ with _action_ `CREATE` with the first payment and the card number alias with the following payments. You can use the _tx_action_ `verify-mop` with the first UCOF transaction to register a card number alias without a payment.", "enum" : [ "INSTALMENT", "RECURRING", "UCOF" ] }, "sequence_type" : { "type" : "string", "description" : "If this payment is part of a sequence of payments\n\n * `FIRST`: first payment of a sequence\n * `RECURRING`: follow-up payment\n * `FINAL`: last payment of a sequence\n", "enum" : [ "FINAL", "FIRST", "RECURRING" ] }, "processing_options" : { "type" : "array", "description" : "Defines an additional processing option for credit card.", "example" : [ "RISKCHECK" ], "items" : { "type" : "string", "description" : "Additional processing option for a credit card transaction.\n\n* `RISKCHECK`: before the transaction a risk check is performed. Only available if this \noption has been activated for the shop.\n ", "example" : "RISKCHECK", "enum" : [ "RISKCHECK" ] } } }, "description" : "Base credit card data to initialize a form checkout service interaction." }, "FormCheckoutRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "account_information" : { "$ref" : "#/components/schemas/AccountInformation" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "merchant_risk_indicators" : { "$ref" : "#/components/schemas/MerchantRiskIndicators" }, "merchant_defined_information" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RiskCheckMerchantDefinedInformation" } }, "travel_information" : { "$ref" : "#/components/schemas/RiskCheckTravelInformation" }, "risk_check_additional_information" : { "$ref" : "#/components/schemas/RiskCheckAdditionalInformation" }, "bank_account" : { "$ref" : "#/components/schemas/BankAccount" }, "processing_options" : { "type" : "array", "items" : { "type" : "string", "description" : "Specific options for checkout page processing. Valid values are:\n\n * `COOKIES_ACCEPTED`: The customer has already agreed to the use of cookies.\n * `STORE_CHECKOUT_PAGE_PREFERENCES`: The customer has agreed to store checkout page preferences in cookie value. For this, the customer must also have agreed to the use of cookies.\n ", "example" : "COOKIES_ACCEPTED", "enum" : [ "COOKIES_ACCEPTED", "STORE_CHECKOUT_PAGE_PREFERENCES" ] } }, "checkout_page_configuration" : { "$ref" : "#/components/schemas/FormCheckoutConfiguration" } }, "description" : "Request data that is being used after selecting a payment method on the checkout page." }, "FormDirectDebitData" : { "required" : [ "mandate" ], "type" : "object", "properties" : { "mandate" : { "$ref" : "#/components/schemas/EnhancedMandate" }, "address" : { "$ref" : "#/components/schemas/CommonAddress" }, "due_date" : { "type" : "string", "description" : "Due date of a direct debit payment. Full-date notation as defined by\nRFC 3339, section 5.6. The due date has to be at least three TARGET2 business days (not on weekends or the so\ncalled TARGET2 or TARGET holidays) after the current date. If you leave this field empty the direct debit is carried\nout as soon as possible.", "format" : "date" }, "debit_method" : { "type" : "string", "description" : "Direct debit method. If not specified, an SDD will be carried out.\n\n\n* `SDD`: SEPA Core Direct Debit\n* `B2B`: SEPA Business to Business Direct Debit\n\n\n ", "example" : "B2B", "enum" : [ "SDD", "B2B" ] }, "processing_options" : { "type" : "array", "description" : "Defines an additional processing option for direct debit.", "example" : [ "CHECKLIST", "RISKCHECK" ], "items" : { "type" : "string", "description" : "Additional processing option for direct debit.\n\n* `CHECKLIST`: before the direct debit a blacklist is checked. Only available if this\noption has been activated for the shop.\n* `RISKCHECK`: before the direct debit a risk check is performed. Only available if this \noption has been activated for the shop.\n ", "example" : "CHECKLIST", "enum" : [ "CHECKLIST", "RISKCHECK" ] } } }, "description" : "Data to initialize a direct debit form service interaction." }, "FormGiropayData" : { "type" : "object", "properties" : { "ext_merchant_tag" : { "pattern" : "^[a-zA-Z0-9]{0,20}$", "type" : "string", "description" : "Optional field that can be freely used by the merchant. Will be passed on to giropay.", "example" : "ref12345" }, "labelled_text" : { "maxItems" : 5, "minItems" : 0, "type" : "array", "items" : { "$ref" : "#/components/schemas/GiropayLabelledText" } } }, "description" : "Data to initialize a giropay form service interaction." }, "FormKlarnaData" : { "type" : "object", "description" : "Data to initialize a Klarna form service interaction. Currently contains no fields. See the user guide for when to generate this object." }, "FormPSD2PaymentData" : { "type" : "object", "properties" : { "iban" : { "maxLength" : 22, "minLength" : 22, "pattern" : "DE[0-9]{20}", "type" : "string", "description" : "The international bank account number of a German bank account.", "example" : "DE17215730140403340300" }, "due_date" : { "type" : "string", "description" : "Due date of the credit transfer. Full-date notation as defined by\nRFC 3339, section 5.6. If you leave this field empty the credit transfer is carried\nout as soon as possible.", "format" : "date" }, "alias_action" : { "$ref" : "#/components/schemas/AliasAction" }, "processing_options" : { "type" : "array", "items" : { "type" : "string", "description" : "Defines an additional processing option for credit transfers. One of\n\n * `INSTANT`: Process as instant payment.\n * `INSTANT_IF_POSSIBLE`: Process as instant payment if possible.\n", "enum" : [ "INSTANT", "INSTANT_IF_POSSIBLE" ] } } }, "description" : "Data to initialize a PSD2 payment form service interaction." }, "FormPayPalData" : { "type" : "object", "properties" : { "merchant_id" : { "type" : "string", "description" : "Business identifier of a merchant.", "example" : "merchant1234" } }, "description" : "Data to initialize a PayPal form service interaction." }, "FormPaydirektData" : { "type" : "object", "properties" : { "customer_id" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string", "description" : "Technical identification number of a customer.", "example" : "C1234-AX" }, "minimum_age" : { "maximum" : 999, "minimum" : 0, "type" : "integer", "description" : "The client must at a minimum be this old in order to legally conduct the transaction.", "format" : "int32", "example" : 18 }, "processing_options" : { "type" : "array", "items" : { "type" : "string", "description" : "Paydirekt specific options for payment processing. Valid values are:\n\n* `OVERCAPTURE`: In case of pre-authorization: The capturable money amount may exceed the total gross amount of purchased\ngoods (that is excluding shipping fee) up to a maximum of 10%. This special functionality must be explicitly activated for a merchant's account. \n ", "example" : "OVERCAPTURE", "enum" : [ "OVERCAPTURE" ] } } }, "description" : "Data to initialize a paydirekt form service interaction." }, "FormRequestToPayData" : { "type" : "object", "properties" : { "customer_id" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string", "description" : "Technical identification number of a customer.", "example" : "C1234-AX" }, "iban" : { "maxLength" : 34, "minLength" : 15, "pattern" : "[A-Z]{2}[0-9]{2}[A-Z0-9*]{11,30}", "type" : "string", "description" : "The international bank account number of a bank account.", "example" : "DE17215730140403340300" }, "processing_options" : { "type" : "array", "items" : { "type" : "string", "description" : "Defines an additional processing option for credit transfers. One of\n\n * `INSTANT`: Process as instant payment.\n * `INSTANT_IF_POSSIBLE`: Process as instant payment if possible.\n", "enum" : [ "INSTANT", "INSTANT_IF_POSSIBLE" ] } } }, "description" : "Data to initialize a request to pay form service interaction." }, "FormSofortUeberweisungData" : { "type" : "object", "properties" : { "bank_account" : { "$ref" : "#/components/schemas/BankAccount" } }, "description" : "Data to initialize a Sofortüberweisung form service interaction." }, "GiropayLabelledText" : { "required" : [ "label", "text" ], "type" : "object", "properties" : { "label" : { "pattern" : "^[a-zA-Z0-9 ']{0,30}$", "type" : "string", "description" : "Will be prefixing the value of the text field.", "example" : "Merchant name" }, "text" : { "pattern" : "^[a-zA-Z0-9 ']{0,80}$", "type" : "string", "description" : "Optional line of text that will be included into the giropay login page.", "example" : "Merchant's fine goods" } }, "description" : "Additional line of text that will be included into the giropay login page." }, "FormCreditCardData" : { "type" : "object", "properties" : { "tds_20_data" : { "$ref" : "#/components/schemas/TDS20Data" }, "recurring_payment" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[/0-9a-zA-Z_.:,+*$%-]+", "type" : "string", "description" : "Identifier of a recurring credit card payment.", "example" : "07H987Tx3PF9VxL5G7RfNp" }, "series_flag" : { "type" : "string", "description" : "Designates a payment as part of a series of payments.\n\n* `INSTALMENT`: for example in the case of paying a fixed sum in multiple partial payments.\n* `RECURRING`: for example in the case of a subscription or standing order.\n* `UCOF`: when a card number alias is created for future payments with the same credit card. In this case use _alias_action_ with _action_ `CREATE` with the first payment and the card number alias with the following payments. You can use the _tx_action_ `verify-mop` with the first UCOF transaction to register a card number alias without a payment.", "enum" : [ "INSTALMENT", "RECURRING", "UCOF" ] }, "sequence_type" : { "type" : "string", "description" : "If this payment is part of a sequence of payments\n\n * `FIRST`: first payment of a sequence\n * `RECURRING`: follow-up payment\n * `FINAL`: last payment of a sequence\n", "enum" : [ "FINAL", "FIRST", "RECURRING" ] }, "processing_options" : { "type" : "array", "description" : "Defines an additional processing option for credit card.", "example" : [ "RISKCHECK" ], "items" : { "type" : "string", "description" : "Additional processing option for a credit card transaction.\n\n* `RISKCHECK`: before the transaction a risk check is performed. Only available if this \noption has been activated for the shop.\n ", "example" : "RISKCHECK", "enum" : [ "RISKCHECK" ] } } }, "description" : "Base credit card for a form service interaction." }, "FormCreditCardRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "account_information" : { "$ref" : "#/components/schemas/AccountInformation" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "merchant_risk_indicators" : { "$ref" : "#/components/schemas/MerchantRiskIndicators" }, "merchant_defined_information" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RiskCheckMerchantDefinedInformation" } }, "travel_information" : { "$ref" : "#/components/schemas/RiskCheckTravelInformation" }, "risk_check_additional_information" : { "$ref" : "#/components/schemas/RiskCheckAdditionalInformation" }, "alias_action" : { "$ref" : "#/components/schemas/AliasAction" }, "credit_card_data" : { "$ref" : "#/components/schemas/FormCreditCardData" } }, "description" : "Request data to initialize a form service interaction." }, "FormDirectDebitRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "account_information" : { "$ref" : "#/components/schemas/AccountInformation" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "merchant_risk_indicators" : { "$ref" : "#/components/schemas/MerchantRiskIndicators" }, "merchant_defined_information" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RiskCheckMerchantDefinedInformation" } }, "travel_information" : { "$ref" : "#/components/schemas/RiskCheckTravelInformation" }, "risk_check_additional_information" : { "$ref" : "#/components/schemas/RiskCheckAdditionalInformation" }, "alias_action" : { "$ref" : "#/components/schemas/AliasAction" }, "direct_debit_data" : { "$ref" : "#/components/schemas/FormDirectDebitData" } }, "description" : "Request data to initialize a form service direct debit interaction." }, "FormGiropayRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "bank_account" : { "$ref" : "#/components/schemas/BankAccount" }, "giropay_data" : { "$ref" : "#/components/schemas/FormGiropayData" } } }, "FormKlarnaRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "alias_action" : { "$ref" : "#/components/schemas/AliasAction" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" } } }, "FormP24Request" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "preferred_lanuage" : { "type" : "string", "description" : "The 2-letter language code (e.g. de) of the language preferred when presenting payment pages to the consumer.", "example" : "de" } }, "description" : "Request data that is being used for P24 transaction init." }, "FormPSD2AuthorizationRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "psd2_pis_data" : { "$ref" : "#/components/schemas/FormPSD2PaymentData" } }, "description" : "Request data to initialize a form service interaction." }, "FormPSD2ReversalResponse" : { "required" : [ "message", "outcome", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "redirect_url" : { "maxLength" : 1024, "minLength" : 0, "type" : "string", "description" : "URL to redirect the customer to.", "example" : "https://staging.pushpayments.db.com/pay/eyJwYXlsb2FkIjp7InYiOjEsImlwaS" }, "tx_id" : { "type" : "string", "description" : "Unique transaction identifier. Can be used to reference this transaction.", "example" : "020LMG10jxSI8FN0OC4vLR" }, "outcome" : { "type" : "string", "description" : "Indicates the outcome of the PSD2 reversal transaction.\n \n* `PROCESSED`: The reversal has been processed, no further action is required.\n Consult attribute `processed` for details of the processed transaction.\n* `REDIRECT_REQUIRED`: The customer has to authorize the reversal.\n", "enum" : [ "PROCESSED", "REDIRECT_REQUIRED" ] }, "processed" : { "$ref" : "#/components/schemas/PaymentResponse" } } }, "FormPSD2ReversalRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" } }, "description" : "Request data to initialize a form service interaction." }, "FormPayPalRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "paypal_data" : { "$ref" : "#/components/schemas/FormPayPalData" } } }, "FormPaydirektRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "paydirekt_data" : { "$ref" : "#/components/schemas/FormPaydirektData" } } }, "FormPSD2AccountInfoRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "bic" : { "maxLength" : 11, "minLength" : 11, "pattern" : "[A-Z]{6}[A-Z2-9][A-NP-Z0-9][A-Z0-9]{3}", "type" : "string", "description" : "The business identifier code (BIC) of the bank. Identifies the bank if `bank_id` is not submitted.", "example" : "VZVDDED1XXX" }, "bank_code" : { "maxLength" : 8, "minLength" : 8, "pattern" : "[0-9]{8}", "type" : "string", "description" : "The bank code (Bankleitzahl, BLZ) of the bank. In rare cases the bank code is required in\naddition to the BIC to identify the bank.", "example" : "38011000" }, "bank_id" : { "maxLength" : 16, "minLength" : 1, "pattern" : "[A-Za-z0-9_-]+", "type" : "string", "description" : "The ID of a bank as returned in the response of a previous bank search.", "example" : "bG0E" }, "requested_details" : { "type" : "array", "description" : "To request additional details of the bank account, for example the owner.", "example" : [ "OWNER" ], "items" : { "type" : "string", "description" : "Specifies which additional bank account details are requested.\n\n* `OWNER`: the account owner\n* `BALANCE`: the account balance,\n* `TRANSACTIONS`: transactions of the bank account", "example" : "OWNER", "enum" : [ "OWNER", "BALANCE", "TRANSACTIONS" ] } }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "transaction_filter" : { "$ref" : "#/components/schemas/PSD2TransactionFilter" } }, "description" : "Includes data to find a customer's bank account details." }, "PSD2TransactionFilter" : { "type" : "object", "properties" : { "date_from" : { "type" : "string", "description" : "Starting date of the transaction list. Full-date notation as defined by RFC 3339, section 5.6.", "format" : "date", "example" : "2021-07-13" }, "date_to" : { "type" : "string", "description" : "End date of the transaction list. Full-date notation as defined by RFC 3339, section 5.6.", "format" : "date", "example" : "2021-07-14" }, "booking_status" : { "type" : "array", "description" : "The requested booking status(es). Not all banks allow `PENDING` or `BOOKED` and `PENDING`.", "example" : [ "BOOKED" ], "items" : { "type" : "string", "description" : "Booking status of a transaction\n\n* `BOOKED`\n* `PENDING`", "example" : "BOOKED", "enum" : [ "BOOKED", "PENDING" ] } } }, "description" : "Contains properties to filter the transactions if `requested_details` includes `TRANSACTIONS`.\nIf `booking_status` is not submitted `BOOKED` transactions will be requested from the customer's bank." }, "FormRequestToPayRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "request_to_pay_data" : { "$ref" : "#/components/schemas/FormRequestToPayData" } } }, "FormSofortUeberweisungRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "sofort_data" : { "$ref" : "#/components/schemas/FormSofortUeberweisungData" } } }, "WeChatPayResponse" : { "required" : [ "message", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "redirect_url" : { "maxLength" : 1024, "minLength" : 0, "type" : "string", "description" : "URL to redirect the customer to.", "example" : "https://staging.pushpayments.db.com/pay/eyJwYXlsb2FkIjp7InYiOjEsImlwaS" }, "tx_id" : { "type" : "string", "description" : "Unique transaction identifier. Can be used to reference this transaction.", "example" : "020LMG10jxSI8FN0OC4vLR" }, "payment_purpose" : { "type" : "string", "description" : "Reflects what the consumer will see on the proof of payment.", "example" : "47X6G4V" }, "settlement_amount" : { "type" : "string", "description" : "The amount in the settlement currency of the transaction. The amount is calculated by WeChatPay. In minor units according to ISO 4217.", "example" : "160" }, "settlement_currency" : { "type" : "string", "description" : "The settlement currency of the transaction.", "example" : "USD" }, "cny_amount" : { "type" : "string", "description" : "The amount deducted from the consumer’s wallet. In CNY major units.", "example" : "7.84" }, "expiry_timestamp" : { "type" : "string", "description" : "The expiry time of the transaction.", "example" : "1574869035" }, "fix_rate" : { "type" : "string", "description" : "This exchange rate is guaranteed for potential refunds.", "example" : "6.44145" }, "qr_code_url" : { "type" : "string", "description" : "The string used for generating the payment QR code image." }, "src_amount" : { "type" : "string", "description" : "The total amount debited from the consumer's WeChat Wallet.", "example" : "784" }, "src_currency" : { "type" : "string", "description" : "The currency of the consumer's WeChat wallet.", "example" : "CNY" } } }, "FormWeChatPayRequest" : { "required" : [ "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "preferred_lanuage" : { "type" : "string", "description" : "The 2-letter language code (e.g. de) of the language preferred when presenting payment pages to the consumer.", "example" : "de" } }, "description" : "Request data that is being used for WeChat Pay transaction init." }, "GooglePayRequest" : { "required" : [ "amount_total", "means_of_payment_google_pay" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "account_information" : { "$ref" : "#/components/schemas/AccountInformation" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "merchant_risk_indicators" : { "$ref" : "#/components/schemas/MerchantRiskIndicators" }, "merchant_defined_information" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RiskCheckMerchantDefinedInformation" } }, "travel_information" : { "$ref" : "#/components/schemas/RiskCheckTravelInformation" }, "risk_check_additional_information" : { "$ref" : "#/components/schemas/RiskCheckAdditionalInformation" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "alias_action" : { "$ref" : "#/components/schemas/AliasAction" }, "means_of_payment_google_pay" : { "$ref" : "#/components/schemas/MeansOfPaymentGooglePay" }, "processing_options" : { "uniqueItems" : true, "type" : "array", "description" : "Defines an additional processing option for Google Pay™ transactions.", "example" : [ "RISKCHECK" ], "items" : { "type" : "string", "description" : "Additional processing option for headless 3-D Secure transactions.\n\n* `FALLBACK_ON_SSL`: process the transaction flagged as channel-encrypted (SSL, 3-D Secure authentication \nwas not performed) instead of 3-D Secure in case 3-D Secure authentication could not be performed.\n* `RISKCHECK`: process risk check transaction before start of 3-D Secure authentication. In case of declined risk check\nno credit card transaction is started\n", "example" : "FALLBACK_ON_SSL", "enum" : [ "FALLBACK_ON_SSL", "RISKCHECK" ] } }, "recurring_payment" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[/0-9a-zA-Z_.:,+*$%-]+", "type" : "string", "description" : "Identifier of a recurring credit card payment.", "example" : "07H987Tx3PF9VxL5G7RfNp" }, "sequence_type" : { "type" : "string", "description" : "If this payment is part of a sequence of payments\n\n * `FIRST`: first payment of a sequence\n * `RECURRING`: follow-up payment\n * `FINAL`: last payment of a sequence\n", "enum" : [ "FINAL", "FIRST", "RECURRING" ] }, "series_flag" : { "type" : "string", "description" : "Designates a payment as part of a series of payments.\n\n* `INSTALMENT`: for example in the case of paying a fixed sum in multiple partial payments.\n* `RECURRING`: for example in the case of a subscription or standing order.\n* `UCOF`: when a card number alias is created for future payments with the same credit card. In this case use _alias_action_ with _action_ `CREATE` with the first payment and the card number alias with the following payments. You can use the _tx_action_ `verify-mop` with the first UCOF transaction to register a card number alias without a payment.", "enum" : [ "INSTALMENT", "RECURRING", "UCOF" ] }, "tds_20_data" : { "$ref" : "#/components/schemas/TDS20Data" } }, "description" : "The payment request of the Google Pay™ API." }, "MeansOfPaymentGooglePay" : { "type" : "object", "properties" : { "googlepay_token" : { "maxLength" : 5000, "minLength" : 1, "pattern" : "[a-zA-Z0-9:,\\/+=_\\-\\\\\\{\\}\\[\\]\\\"\r\n\t ]*", "type" : "string", "description" : "The complete token generated by Google Pay™ as contained in paymentData.paymentMethodData.tokenizationData.token. Note: use for example JSON.stringify before sending.", "example" : "{\\\"signature\\\":\\\"MEUCIQD8RtwzL8/Mzjm1wpQYXrZedFp++ZyqNI6fE4i+eZWVyAIgTLIJWwzx2vYpYxJAiY4ze5c9Ja96+cljw9JCOYG6q/M\\\\u003d\\\",\\\"intermediateSigningKey\\\":{\\\"signedKey\\\":\\\"{\\\\\\\"keyValue\\\\\\\":\\\\\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2zv+MrfoTlZ4ccBmOCyPf2mV59d1KtpenaoI/QOXY/GWptmRapfFiE9r864vw9ggpUf8ZZbs3T/SmNgA95fyQw\\\\\\\\u003d\\\\\\\\u003d\\\\\\\",\\\\\\\"keyExpiration\\\\\\\":\\\\\\\"1646865007568\\\\\\\"}\\\",\\\"signatures\\\":[\\\"MEQCIEa8OSuqEqFHzYIBF0rYJAYvp8Tuxt4m5Eia4kw8SvKkAiB0Jolsc583JA1nghgbM2rSQ4fme+ZwzwRvYZNvsjVsxQ\\\\u003d\\\\u003d\\\"]},\\\"protocolVersion\\\":\\\"ECv2\\\",\\\"signedMessage\\\":\\\"{\\\\\\\"encryptedMessage\\\\\\\":\\\\\\\"0Ey+Y+F/9Wu6qLxo1tlEJaadbEV8dLLwgGWsrWId/7AKQVVO9lnzuoE6Z286ttquMc+X9BRGGpLQ6VPAuxdKBrDPeMd8cQoM/fqDLnq7oLQk3aKkcpULav3YusBqit33j2VAE3BcqjUmKz7QueoHUzUDEkYgmiasPujQ9TgsBYOFioXw6kOLy2NZZImIV8FzlI2deDgVG8+oW6P/G2VhEzY2KU+BSZ5ukepDeYyLOd/BIGxzqyoVRTkyG7m3PxZl0Ofp0qjwS816ruxBpXsWHQjuZgtSn7JWz2WPuevE8YT9JGm5mjzIaCxOq1QTKKyeKR0r0hXLkXtGd5NEvn9y/a1/tRtQtvQerTp/aFdjSX3IazmVfFpFqOnWD76TIi8mNAwtKuDyDfUMHMKATpJZhaFhw5/25bUbEdkTGjBBQpkpzGfxBlbnvEtCLUjCjzwppIi50FSu4IxPj9PhDxtMB+UWmhDzM4Lq/OzK/xol7cYfPkLhccHlht+SHqNz2aOOZw8qVlgyYAScOYaJtUGtBGtyJJ00yKDXC/xnXPewt8QKGuNr/i/PpUg2Ma1t7iXKHh+oa+3hB8De\\\\\\\",\\\\\\\"ephemeralPublicKey\\\\\\\":\\\\\\\"BEmwMBAo38JnpnZexSNBbgsLMXg0xF5SKqBb/nptzFsaFPQjI70yKMLXv4bEa3kJ15VBLiaDsketAHe7B4Hp7go\\\\\\\\u003d\\\\\\\",\\\\\\\"tag\\\\\\\":\\\\\\\"zOz55zo9efgTP/e6hxdylmDsXVqfxXfyuUrWzrAEDuc\\\\\\\\u003d\\\\\\\"}\\\"}" } }, "description" : "The means of payment that will be used. Only a Google Pay™ token is valid." }, "Headless3DSecureFinalRequest" : { "type" : "object", "properties" : { "PaRes" : { "type" : "string", "description" : "3-D Secure Payer Authentication Response received from the ACS." }, "cres" : { "type" : "string", "description" : "3-D Secure challenge response data received from the ACS." } }, "description" : "3-D Secure challenge response data. Make sure only one of the attributes are set depending on the 3-D Secure version." }, "Headless3DSecureInitializeRequest" : { "required" : [ "amount_total", "means_of_payment", "tds_20_data" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "account_information" : { "$ref" : "#/components/schemas/AccountInformation" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "merchant_risk_indicators" : { "$ref" : "#/components/schemas/MerchantRiskIndicators" }, "merchant_defined_information" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RiskCheckMerchantDefinedInformation" } }, "travel_information" : { "$ref" : "#/components/schemas/RiskCheckTravelInformation" }, "risk_check_additional_information" : { "$ref" : "#/components/schemas/RiskCheckAdditionalInformation" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "alias_action" : { "$ref" : "#/components/schemas/AliasAction" }, "means_of_payment" : { "$ref" : "#/components/schemas/MeansOfPaymentCreditCard" }, "recurring_payment" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[/0-9a-zA-Z_.:,+*$%-]+", "type" : "string", "description" : "Identifier of a recurring credit card payment.", "example" : "07H987Tx3PF9VxL5G7RfNp" }, "series_flag" : { "type" : "string", "description" : "Designates a payment as part of a series of payments.\n\n* `INSTALMENT`: for example in the case of paying a fixed sum in multiple partial payments.\n* `RECURRING`: for example in the case of a subscription or standing order.\n* `UCOF`: when a card number alias is created for future payments with the same credit card. In this case use _alias_action_ with _action_ `CREATE` with the first payment and the card number alias with the following payments. You can use the _tx_action_ `verify-mop` with the first UCOF transaction to register a card number alias without a payment.", "enum" : [ "INSTALMENT", "RECURRING", "UCOF" ] }, "sequence_type" : { "type" : "string", "description" : "If this payment is part of a sequence of payments\n\n * `FIRST`: first payment of a sequence\n * `RECURRING`: follow-up payment\n * `FINAL`: last payment of a sequence\n", "enum" : [ "FINAL", "FIRST", "RECURRING" ] }, "tds_20_data" : { "$ref" : "#/components/schemas/TDS20Data" }, "processing_options" : { "uniqueItems" : true, "type" : "array", "description" : "Defines an additional processing option for headless 3-D Secure transactions.", "example" : [ "FALLBACK_ON_SSL", "RISKCHECK" ], "items" : { "type" : "string", "description" : "Additional processing option for headless 3-D Secure transactions.\n\n* `FALLBACK_ON_SSL`: process the transaction flagged as channel-encrypted (SSL, 3-D Secure authentication \nwas not performed) instead of 3-D Secure in case 3-D Secure authentication could not be performed.\n* `RISKCHECK`: process risk check transaction before start of 3-D Secure authentication. In case of declined risk check\nno credit card transaction is started\n", "example" : "FALLBACK_ON_SSL", "enum" : [ "FALLBACK_ON_SSL", "RISKCHECK" ] } } } }, "MeansOfPaymentCreditCard" : { "type" : "object", "properties" : { "token" : { "maxLength" : 500, "minLength" : 0, "pattern" : "[a-zA-Z0-9/+=_-]*", "type" : "string", "description" : "The token value.", "example" : "eyJ0IjoiSFcyaS13cTB3PT0iLCJzIjoiaWIybzFRMHEifQ" }, "alias" : { "type" : "string", "description" : "A previously registered alias.", "example" : "221f56ca355d8e6c42517749cf79ceb8" }, "credit_card" : { "$ref" : "#/components/schemas/CreditCard" } }, "description" : "The means of payment that will be used. Exactly one of the given means is valid." }, "IFrameInitializeResponse" : { "required" : [ "message", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "client_session" : { "maxLength" : 255, "minLength" : 0, "pattern" : "[a-zA-Z0-9/+=_-]*", "type" : "string", "description" : "The iFrame client session ID.", "example" : "8qOMTG3gdTwb8cjQtKW8fx" }, "client_configuration" : { "maxLength" : 2000, "minLength" : 0, "pattern" : "[a-zA-Z0-9/+=_-]*", "type" : "string", "description" : "The iFrame client configuration.", "example" : "eyJob3N0IjoiaHR0cDovL2hvc3Q6ODA4MCIsIm9wdGlvbnMiLi4u" } }, "description" : "Contains data to initialize an iFrame interaction with JavaScript." }, "IFrameInitializeRequest" : { "required" : [ "amount_total" ], "type" : "object", "properties" : { "tds_20_data" : { "$ref" : "#/components/schemas/TDS20Data" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "processing_options" : { "type" : "array", "description" : "Defines an additional processing option for iFrame interaction.", "example" : [ "MOTO" ], "items" : { "type" : "string", "description" : "Additional processing option for an iFrame interaction.\n\n* `MOTO`: A credit card token should be created for use in a MOTO payment transaction. \n This skips the 3D-Secure process.", "example" : "MOTO", "enum" : [ "MOTO" ] } } }, "description" : "Request data to initialize an iFrame interaction." }, "PSD2Bank" : { "required" : [ "name", "psd2_supported" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Temporary system identifier for this bank - if PSD2 is supported." }, "name" : { "type" : "string", "description" : "Name of the bank." }, "town" : { "type" : "string", "description" : "Town where the bank is located." }, "bic" : { "maxLength" : 11, "minLength" : 8, "pattern" : "[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?", "type" : "string", "description" : "BIC (business identifier code)." }, "bank_code" : { "type" : "string", "description" : "German bank code (Bankleitzahl, BLZ)." }, "psd2_supported" : { "type" : "boolean", "description" : "If true this bank can be used for the PSD2 account information and payment initiation services." }, "capabilities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PSD2CapabilityEnum" } } }, "description" : "Contains bank details." }, "PSD2BankResults" : { "type" : "object", "properties" : { "metadata" : { "$ref" : "#/components/schemas/PagedMetadata" }, "banks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PSD2Bank" } } } }, "PSD2CapabilityEnum" : { "type" : "string", "description" : " * `AVAILABLE_ACCOUNTS`: PSD2 account information service AIS can be used to find all the customer's accounts with this bank.\n * `AVAILABLE_ACCOUNTS_WITH_BALANCE`: AIS can be used to find all the customer's account including the balances\n * `BANK_OFFERED_CONSENT`: AIS can be used to find the customer's accounts with this bank. If the customer has more than one account the bank will display the list of accounts and the customer chooses the accounts for which she/he wants to grant access.\n * `GLOBAL_CONSENT`: AIS can be used to get the customer's consent to access all accounts.", "enum" : [ "AVAILABLE_ACCOUNTS", "AVAILABLE_ACCOUNTS_WITH_BALANCE", "BANK_OFFERED_CONSENT", "GLOBAL_CONSENT" ] }, "PagedMetadata" : { "type" : "object", "properties" : { "limit" : { "type" : "integer", "format" : "int32" }, "offset" : { "type" : "integer", "format" : "int32" }, "total" : { "type" : "integer", "format" : "int32" } } }, "PSD2Account" : { "type" : "object", "properties" : { "iban" : { "maxLength" : 34, "minLength" : 15, "pattern" : "[A-Z]{2}[0-9]{2}[A-Z0-9*]{11,30}", "type" : "string", "description" : "The international bank account number of a bank account.", "example" : "DE17215730140403340300" }, "bban" : { "type" : "string", "description" : "Used for payment accounts which have no IBAN." }, "pan" : { "maxLength" : 35, "minLength" : 0, "type" : "string", "description" : "Primary Account Number (PAN) of a card, can be tokenized by the ASPSP due to PCI DSS\nrequirements." }, "masked_pan" : { "maxLength" : 35, "minLength" : 0, "type" : "string", "description" : "Primary Account Number (PAN) of a card in a masked form." }, "msisdn" : { "maxLength" : 35, "minLength" : 0, "type" : "string", "description" : "An alias to access a payment account via a registered mobile phone number." }, "currency" : { "pattern" : "[A-Z]{3}", "type" : "string", "description" : "ISO 4217 currency code, three uppercase letters.", "example" : "EUR" } } }, "PSD2AccountDetails" : { "type" : "object", "properties" : { "iban" : { "type" : "string", "description" : "The international bank account number of a bank account.", "example" : "DE17215730140403340300" }, "currency" : { "pattern" : "[A-Z]{3}", "type" : "string", "description" : "ISO 4217 currency code, three uppercase letters.", "example" : "EUR" }, "name" : { "maxLength" : 35, "minLength" : 0, "type" : "string", "description" : "Name of the account given by the bank or the PSU in online-banking." }, "owner_name" : { "maxLength" : 140, "minLength" : 0, "type" : "string", "description" : "Name(s) of the account owner(s)." }, "product" : { "maxLength" : 35, "minLength" : 0, "type" : "string", "description" : "Product name of the bank for this account, proprietary definition." }, "status" : { "type" : "string", "description" : "Status of the account\n\n* `ENABLED`: account is available\n* `DELETED`: account is terminated\n* `BLOCKED`: account is blocked for example for legal reasons", "enum" : [ "ENABLED", "DELETED", "BLOCKED" ] }, "usage" : { "type" : "string", "description" : "Specifies the usage of the account\n\n* `PRIV`: private personal account\n* `ORGA`: professional account\n* `TEST_USAGE`: returned by Sparkassen sandbox", "enum" : [ "PRIV", "ORGA", "TEST_USAGE" ] }, "details" : { "maxLength" : 500, "minLength" : 0, "type" : "string", "description" : "Specifications that might be provided by the ASPSP such as characteristics of the account or\ncharacteristics of the relevant card." }, "balances" : { "type" : "array", "description" : "Balance(s) of the account. There might be more than one balance with different types.", "items" : { "$ref" : "#/components/schemas/PSD2Balance" } }, "transactions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PSD2Transaction" } } }, "description" : "Contains details of a customer's bank account." }, "PSD2AccountInfoResponse" : { "required" : [ "message", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "accounts_as_of" : { "type" : "string", "description" : "Date and time of the account information request. Date-time notation as defined by RFC 3339,\nsection 5.6.", "format" : "date-time", "example" : "2021-07-14T08:59:12Z" }, "transaction_filter" : { "$ref" : "#/components/schemas/PSD2TransactionFilter" }, "accounts" : { "type" : "array", "description" : "Bank account details which were stored in a previous step.", "items" : { "$ref" : "#/components/schemas/PSD2AccountDetails" } } } }, "PSD2Balance" : { "required" : [ "amount", "type" ], "type" : "object", "properties" : { "amount" : { "$ref" : "#/components/schemas/AmountCurrency" }, "type" : { "type" : "string", "description" : "The following balance types are excluding credit limits unless the `credit_limit_included` element\nis present and equals true in the corresponding balance element.\nThis definition is following ISO20022 logic for defining balance types.\n\n* `CLOSING_BOOKED`: Balance of the account at the end of the pre-agreed account reporting\nperiod. It is the sum of the opening booked balance at the beginning of\nthe period and all entries booked to the account during the pre-agreed\naccount reporting period. For card-accounts, this is composed of invoiced, but not yet paid entries\n* `EXPECTED`: Balance composed of booked entries and pending items known at the\ntime of calculation, which projects the end of day balance if everything\nis booked on the account and no other entry is posted.\nFor card accounts, this is composed of invoiced, but not yet paid entries,\nnot yet invoiced but already booked entries and pending items (not yet booked),\n* `OPENING_BOOKED`: Book balance of the account at the beginning of the account reporting\nperiod. It always equals the closing book balance from the previous\nreport.\n* `INTERIM_AVAILABLE`: Available balance calculated in the course of the account servicer’s\nbusiness day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis\nof booked credit and debit items during the calculation time/period\nspecified.\nFor card-accounts, this is composed of invoiced, but not yet paid entries and not yet invoiced but already booked entries\n* `INTERIM_BOOKED`: Balance calculated in the course of the account servicer's business day,\nat the time specified, and subject to further changes during the business\nday. The interim balance is calculated on the basis of booked credit and\ndebit items during the calculation time/period specified.\n* `FORWARD_AVAILABLE`: Forward available balance of money that is at the disposal of the\naccount owner on the date specified.\n* `NON_INVOICED`: Only for card accounts, to be defined yet.\n* `PREVIOUSLY_CLOSED`: Balance of the account at the previously closed account reporting period.", "example" : "CLOSING_BOOKED", "enum" : [ "CLOSING_BOOKED", "EXPECTED", "OPENING_BOOKED", "INTERIM_AVAILABLE", "INTERIM_BOOKED", "FORWARD_AVAILABLE", "NON_INVOICED", "PREVIOUSLY_CLOSED" ] }, "credit_limit_included" : { "type" : "boolean", "description" : "A flag indicating if the credit limit of the corresponding account is included in\n the calculation of the balance, where applicable." }, "last_change" : { "type" : "string", "description" : "This data element might be used to indicate for example with the expected or\nbooked balance that no action is known on the account, which is not yet booked.\nDate-time notation as defined by RFC 3339, section 5.6.", "format" : "date-time", "example" : "2021-07-14T08:59:12Z" }, "reference_date" : { "type" : "string", "description" : "Indicates the date of the balance. Full-date notation as defined by RFC 3339, section 5.6.", "format" : "date", "example" : "2021-07-14" } } }, "PSD2CurrencyExchange" : { "type" : "object", "properties" : { "source_currency" : { "type" : "string", "description" : "Currency from which an amount is to be converted in a currency conversion.", "example" : "USD" }, "exchange_rate" : { "type" : "string", "description" : "Factor used to convert an amount from one currency into another. This reflects the\nprice at which one currency was bought with another currency." }, "unit_currency" : { "pattern" : "[A-Z]{3}", "type" : "string", "description" : "Currency in which the rate of exchange is expressed in a currency exchange. In the\nexample 1 EUR = xxx CUR, the unit currency is EUR.", "example" : "EUR" }, "target_currency" : { "pattern" : "[A-Z]{3}", "type" : "string", "description" : "Currency into which an amount is to be converted in a currency conversion.", "example" : "EUR" }, "quotation_date" : { "type" : "string", "description" : "Date at which an exchange rate is quoted.", "format" : "date" }, "contract_identification" : { "type" : "string", "description" : "Unique identification to unambiguously identify the foreign exchange contract." } } }, "PSD2Remittance" : { "type" : "object", "properties" : { "reference" : { "maxLength" : 35, "minLength" : 0, "type" : "string" }, "reference_type" : { "maxLength" : 35, "minLength" : 0, "type" : "string" }, "reference_issuer" : { "maxLength" : 35, "minLength" : 0, "type" : "string" } } }, "PSD2Transaction" : { "required" : [ "amount", "booking_status" ], "type" : "object", "properties" : { "end_to_end_id" : { "maxLength" : 35, "minLength" : 0, "type" : "string", "description" : "Unique end to end identifier." }, "mandate_id" : { "maxLength" : 35, "minLength" : 0, "type" : "string", "description" : "Identification of mandates, for example, a SEPA mandate ID." }, "check_id" : { "maxLength" : 35, "minLength" : 0, "type" : "string", "description" : "Identification of a check." }, "creditor_id" : { "maxLength" : 35, "minLength" : 0, "type" : "string", "description" : "Identification of creditors, for example, a SEPA Creditor ID." }, "booking_date" : { "type" : "string", "description" : "The date when an entry is posted to an account on the ASPSPs books.", "format" : "date" }, "value_date" : { "type" : "string", "description" : "Date at which assets become available to the account owner in case\nof a credit entry, or cease to be available to the account owner in case of a debit entry.\nUsage: If entry status is pending and value date is present, then the value date refers to an expected/requested\nvalue date.", "format" : "date" }, "amount" : { "$ref" : "#/components/schemas/AmountCurrency" }, "currency_exchange" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PSD2CurrencyExchange" } }, "creditor_name" : { "maxLength" : 70, "minLength" : 0, "type" : "string", "description" : "Name of the creditor of a \"debited\" transaction." }, "creditor_account" : { "$ref" : "#/components/schemas/PSD2Account" }, "creditor_agent" : { "maxLength" : 11, "minLength" : 11, "pattern" : "[A-Z]{6}[A-Z2-9][A-NP-Z0-9][A-Z0-9]{3}", "type" : "string", "description" : "A BIC.", "example" : "VZVDDED1XXX" }, "ultimate_creditor" : { "maxLength" : 70, "minLength" : 0, "type" : "string", "description" : "Name of the ultimate creditor of a \"debited\" transaction." }, "debtor_name" : { "maxLength" : 70, "minLength" : 0, "type" : "string", "description" : "Name of the debtor of a \"credited\" transaction." }, "debtor_account" : { "$ref" : "#/components/schemas/PSD2Account" }, "debtor_agent" : { "maxLength" : 11, "minLength" : 11, "pattern" : "[A-Z]{6}[A-Z2-9][A-NP-Z0-9][A-Z0-9]{3}", "type" : "string", "description" : "A BIC.", "example" : "VZVDDED1XXX" }, "ultimate_debtor" : { "maxLength" : 70, "minLength" : 0, "type" : "string", "description" : "Name of the ultimate debtor of a \"credited\" transaction." }, "remittance_information_unstructured" : { "type" : "array", "description" : "Unstructured remittance information.", "items" : { "type" : "string", "description" : "Unstructured remittance information." } }, "remittance_information_structured" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PSD2Remittance" } }, "entry_reference" : { "type" : "string", "description" : "Entry reference, for example from camt.052 message." }, "additional_information" : { "type" : "string", "description" : "Might be used by the ASPSP to transport additional transaction related\n information to the PSU." }, "purpose_code" : { "type" : "string", "description" : "ExternalPurpose1Code according to ISO 20022." }, "bank_transaction_code" : { "type" : "string", "description" : "Bank transaction code as used by the ASPSP and using the sub-elements of\nthis structured code defined by ISO20022." }, "proprietary_bank_transaction_code" : { "type" : "string", "description" : "Proprietary bank transaction code as used within a community or within an\nASPSP, for example for MT94x based transaction reports." }, "balance_after_transaction" : { "$ref" : "#/components/schemas/PSD2Balance" }, "booking_status" : { "type" : "string", "description" : "Booking status of a transaction\n\n* `BOOKED`\n* `PENDING`", "example" : "BOOKED", "enum" : [ "BOOKED", "PENDING" ] } }, "description" : "A transaction of a bank account." }, "PaymentCreditCardRequestInitial" : { "required" : [ "amount_total", "means_of_payment" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "account_information" : { "$ref" : "#/components/schemas/AccountInformation" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "merchant_risk_indicators" : { "$ref" : "#/components/schemas/MerchantRiskIndicators" }, "merchant_defined_information" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RiskCheckMerchantDefinedInformation" } }, "travel_information" : { "$ref" : "#/components/schemas/RiskCheckTravelInformation" }, "risk_check_additional_information" : { "$ref" : "#/components/schemas/RiskCheckAdditionalInformation" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "alias_action" : { "$ref" : "#/components/schemas/AliasAction" }, "aid" : { "maxLength" : 32, "minLength" : 0, "type" : "string", "description" : "Approval number of authorizing party.", "example" : "a34232" }, "means_of_payment" : { "$ref" : "#/components/schemas/MeansOfPaymentCreditCard" }, "recurring_payment" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[/0-9a-zA-Z_.:,+*$%-]+", "type" : "string", "description" : "Identifier of a recurring credit card payment.", "example" : "07H987Tx3PF9VxL5G7RfNp" }, "series_flag" : { "type" : "string", "description" : "Designates a payment as part of a series of payments.\n\n* `INSTALMENT`: for example in the case of paying a fixed sum in multiple partial payments.\n* `RECURRING`: for example in the case of a subscription or standing order.\n* `UCOF`: when a card number alias is created for future payments with the same credit card. In this case use _alias_action_ with _action_ `CREATE` with the first payment and the card number alias with the following payments. You can use the _tx_action_ `verify-mop` with the first UCOF transaction to register a card number alias without a payment.", "enum" : [ "INSTALMENT", "RECURRING", "UCOF" ] }, "sequence_type" : { "type" : "string", "description" : "If this payment is part of a sequence of payments\n\n * `FIRST`: first payment of a sequence\n * `RECURRING`: follow-up payment\n * `FINAL`: last payment of a sequence\n", "enum" : [ "FINAL", "FIRST", "RECURRING" ] }, "entry_channel" : { "type" : "string", "description" : "Indicates the channel where the credit card data is recorded. The transaction is \n processed as an eCommerce transaction if no value is set.\n\n * `ECOM`: eCommerce\n * `MOTO`: Mail Order/Telephone Order\n", "enum" : [ "ECOM", "MOTO" ] }, "tds_external_data" : { "$ref" : "#/components/schemas/TDSExternalData" }, "processing_options" : { "type" : "array", "description" : "Defines an additional processing option for credit card.", "example" : [ "RISKCHECK" ], "items" : { "type" : "string", "description" : "Additional processing option for a credit card transaction.\n\n* `RISKCHECK`: before the transaction a risk check is performed. Only available if this \noption has been activated for the shop.\n ", "example" : "RISKCHECK", "enum" : [ "RISKCHECK" ] } } } }, "TDS10ExternalData" : { "type" : "object", "properties" : { "cavv" : { "maxLength" : 28, "minLength" : 0, "type" : "string", "description" : "3-D Secure field. Determined by ACS. Contains a 20 byte value that has beenBase64 encoded, giving a 28 character result.", "example" : "AAABAElUFUhRd3IHRFQVAAAAAAA=" }, "ucaf" : { "maxLength" : 80, "minLength" : 0, "type" : "string", "description" : "3-D Secure field. Base64 encoded binary data.", "example" : "jA/edkhsKdv1ARADDZlme6PCY+Y=" }, "xid" : { "maxLength" : 28, "minLength" : 0, "type" : "string", "description" : "3-D Secure field. Unique transaction identifier determined by merchant. Contains a 20 byte statistically unique value that has been Base64 encoded, giving a 28 character result.", "example" : "ICAgICAgIDExOTAwMTg3MTUxMzc" } }, "description" : "3-D Secure data provided by an MPI for 3DS version 1." }, "TDS20ExternalData" : { "type" : "object", "properties" : { "tds_ds_trans_id" : { "maxLength" : 36, "minLength" : 0, "type" : "string", "description" : "Unique transaction identifier assigned by the 3-D Secure 2.0 Directory Server.", "example" : "f81d4fae-7dec-11d0-a765-00a0c91e6bf6" }, "tds_authentication_value" : { "maxLength" : 28, "minLength" : 0, "pattern" : "[a-zA-Z0-9+/]*={0,2}", "type" : "string", "description" : "Assigned by the 3-D Secure 2.0 Directory Server or ACS (authenticationValue).Contains a 20 byte value that has been Base64 encoded, giving a 28 characterresult.", "example" : "ICAgICAgIDExOTAwMTg3MTUxMzc=" }, "tds_eci" : { "maxLength" : 2, "minLength" : 2, "type" : "string", "description" : "The Electronic Commerce Indicator (eci) provided by the 3-D Secure 2.0 directory server or ACS." } }, "description" : "3-D Secure data provided by a 3DS Server for 3DS version 2." }, "TDSExternalData" : { "type" : "object", "properties" : { "tds_20_external_data" : { "$ref" : "#/components/schemas/TDS20ExternalData" }, "tds_10_external_data" : { "$ref" : "#/components/schemas/TDS10ExternalData" }, "tds_trans_status" : { "type" : "string", "description" : "The 3D-Secure transaction status.\n\n* `Y`: Full\n* `A`: Attempt\n", "example" : "A", "enum" : [ "Y", "A" ] }, "tds_version" : { "type" : "string", "description" : "The 3D-Secure version.\n\n* `V1`: Version 1 (1.0.2)\n* `V2_1`: Version 2.1.0\n* `V2_2`: Version 2.2.0\n \n", "example" : "V2_1", "enum" : [ "V1", "V2_1", "V2_2" ] } }, "description" : "3-D Secure data provided by an MPI/3DS Server." }, "MeansOfPaymentDirectDebit" : { "type" : "object", "properties" : { "token" : { "maxLength" : 500, "minLength" : 0, "pattern" : "[a-zA-Z0-9/+=_-]*", "type" : "string", "description" : "The token value.", "example" : "eyJ0IjoiSFcyaS13cTB3PT0iLCJzIjoiaWIybzFRMHEifQ" }, "alias" : { "type" : "string", "description" : "A previously registered alias.", "example" : "221f56ca355d8e6c42517749cf79ceb8" }, "bank_account" : { "$ref" : "#/components/schemas/BankAccount" } }, "description" : "The means of payment that will be used. Exactly one of the given means is valid." }, "PaymentDirectDebitRequestInitial" : { "required" : [ "amount_total", "mandate", "means_of_payment" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "account_information" : { "$ref" : "#/components/schemas/AccountInformation" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "merchant_risk_indicators" : { "$ref" : "#/components/schemas/MerchantRiskIndicators" }, "merchant_defined_information" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RiskCheckMerchantDefinedInformation" } }, "travel_information" : { "$ref" : "#/components/schemas/RiskCheckTravelInformation" }, "risk_check_additional_information" : { "$ref" : "#/components/schemas/RiskCheckAdditionalInformation" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "alias_action" : { "$ref" : "#/components/schemas/AliasAction" }, "means_of_payment" : { "$ref" : "#/components/schemas/MeansOfPaymentDirectDebit" }, "mandate" : { "$ref" : "#/components/schemas/EnhancedMandate" }, "address" : { "$ref" : "#/components/schemas/CommonAddress" }, "due_date" : { "type" : "string", "description" : "Due date of a direct debit payment. Full-date notation as defined by\nRFC 3339, section 5.6. The due date has to be at least three TARGET2 business days (not on weekends or the so\ncalled TARGET2 or TARGET holidays) after the current date. If you leave this field empty the direct debit is carried\nout as soon as possible.", "format" : "date" }, "debit_method" : { "type" : "string", "description" : "Direct debit method. If not specified, an SDD will be carried out.\n\n\n* `SDD`: SEPA Core Direct Debit\n* `B2B`: SEPA Business to Business Direct Debit\n\n\n ", "example" : "B2B", "enum" : [ "SDD", "B2B" ] }, "processing_options" : { "type" : "array", "description" : "Defines an additional processing option for direct debit.", "example" : [ "CHECKLIST", "RISKCHECK" ], "items" : { "type" : "string", "description" : "Additional processing option for direct debit.\n\n* `CHECKLIST`: before the direct debit a blacklist is checked. Only available if this\noption has been activated for the shop.\n* `RISKCHECK`: before the direct debit a risk check is performed. Only available if this \noption has been activated for the shop.\n ", "example" : "CHECKLIST", "enum" : [ "CHECKLIST", "RISKCHECK" ] } } } }, "PaymentDiagnosisEventResponse" : { "required" : [ "message", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "transactions" : { "type" : "array", "description" : "All transactions that are assigned to this event.", "items" : { "$ref" : "#/components/schemas/PaymentDiagnosisResponse" } }, "payment_link_info" : { "$ref" : "#/components/schemas/PaymentLinkInfo" } }, "description" : "Response contains all transactions belonging to the event." }, "PaymentDiagnosisResponse" : { "required" : [ "event_id", "message", "rc", "timestamp", "tx_id" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "event_id" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string", "description" : "A unique ID for the event.", "example" : "E5686585867636541231230" }, "tx_id" : { "type" : "string", "description" : "Unique transaction identifier. Can be used to reference this transaction.", "example" : "020LMG10jxSI8FN0OC4vLR" }, "riskmanagement_info" : { "$ref" : "#/components/schemas/RiskmanagementInfoResponse" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "kind" : { "type" : "string", "description" : "The type of transaction.", "enum" : [ "DIRECTDEBIT", "CREDITCARD", "CREDITCARD_3DS20", "CREDITTRANSFER", "SOFORTUEBERWEISUNG", "PAYPAL", "PAYDIREKT", "WECHATPAY", "P24", "GIROPAY", "KLARNA", "PSD2" ] }, "tx_action" : { "type" : "string", "description" : "The action of a transaction.", "enum" : [ "authorization", "capture", "credit", "preauthorization", "refund", "reversal", "risk_check", "verify-mop", "payment", "avs", "avspayment" ] }, "alias_info" : { "$ref" : "#/components/schemas/AliasInfo" }, "back_rc" : { "maxLength" : 255, "minLength" : 0, "type" : "string", "description" : "Response code of a backend system, for example the GICC response code.", "example" : "00" }, "timestamp" : { "type" : "string", "description" : "Timestamp of the transaction.", "format" : "date-time" }, "transaction_info" : { "$ref" : "#/components/schemas/TransactionInfo" }, "children" : { "type" : "array", "description" : "A list of all transactions that were sent as follow-up transactions.", "nullable" : true, "items" : { "$ref" : "#/components/schemas/PaymentDiagnosisResponse" } } }, "description" : "Response contains transaction details and all child transactions if present." }, "PaymentLinkInfo" : { "type" : "object", "properties" : { "status" : { "type" : "string", "description" : "The payment link status\n\n * `LINK_INITIALIZED`: payment link is initialized\n * `LINK_DEACTIVATED`: payment link is deactivated\n * `LINK_EXPIRED`: payment link has exceeded its validity period\n * `PAYMENT_SUCCESSFUL`: payment link was used for a successful payment\n", "example" : "PAYMENT_SUCCESSFUL", "enum" : [ "LINK_INITIALIZED", "LINK_DEACTIVATED", "LINK_EXPIRED", "PAYMENT_SUCCESSFUL" ] }, "expires" : { "type" : "string", "description" : "Specifies until when the payment link is usable.", "format" : "date-time" } }, "description" : "Contains information about the created or updated payment link." }, "MeansOfPaymentKlarna" : { "required" : [ "alias" ], "type" : "object", "properties" : { "alias" : { "type" : "string", "description" : "A previously registered alias.", "example" : "221f56ca355d8e6c42517749cf79ceb8" } }, "description" : "The means of payment that will be used. Exactly one of the given means is valid." }, "PaymentKlarnaRequestInitial" : { "required" : [ "amount_total", "means_of_payment" ], "type" : "object", "properties" : { "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "means_of_payment" : { "$ref" : "#/components/schemas/MeansOfPaymentKlarna" } } }, "PaymentRequestSubsequent" : { "required" : [ "kind" ], "type" : "object", "properties" : { "kind" : { "type" : "string", "description" : "The type of transaction.", "enum" : [ "DIRECTDEBIT", "CREDITCARD", "CREDITCARD_3DS20", "CREDITTRANSFER", "SOFORTUEBERWEISUNG", "PAYPAL", "PAYDIREKT", "WECHATPAY", "P24", "GIROPAY", "KLARNA", "PSD2" ] }, "changed_amount" : { "type" : "integer", "description" : "The changed transaction amount for follow-up transactions.", "format" : "int64", "example" : 200 }, "due_date" : { "type" : "string", "description" : "Optional in the case of a direct debit capture. Due date of a direct debit payment. Full-date notation as defined by\nRFC 3339, section 5.6. The due date has to be at least three TARGET2 business days (not on weekends or the so\ncalled TARGET2 or TARGET holidays) after the current date. If you leave this field empty the direct debit is carried\nout as soon as possible.", "format" : "date" }, "description" : { "type" : "string", "description" : "The description of the transaction.", "example" : "The description of the transaction." }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "shipping_info" : { "$ref" : "#/components/schemas/ShippingInfo" } } }, "ShippingInfo" : { "type" : "object", "properties" : { "shipping_company" : { "type" : "string", "description" : "Name of the shipping company (as specific as possible).", "example" : "DHL" }, "shipping_method" : { "type" : "string", "description" : "Shipping method.", "example" : "PickUpStore", "enum" : [ "PickUpStore", "Home", "BoxReg", "BoxUnreg", "PickUpPoint", "Own", "Postal", "DHLPackstation", "Digital", "Undefined" ] }, "tracking_number" : { "type" : "string", "description" : "Tracking number for the shipment.", "example" : "123456789" }, "tracking_uri" : { "type" : "string", "description" : "URI where the customer can track their shipment.", "example" : "https://www.dhl.com/de/express/sendungsverfolgung.html?brand=DHL&AWB=123456789" }, "return_shipping_company" : { "type" : "string", "description" : "Name of the shipping company for the return shipment (as specific as possible).", "example" : "DHL US" }, "return_tracking_number" : { "type" : "string", "description" : "Tracking number for the return shipment.", "example" : "123456789" }, "shipping_delay" : { "type" : "integer", "description" : "Delay before the order will be shipped.", "format" : "int64", "example" : 5 } } }, "PaymentLinkResponse" : { "required" : [ "message", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "payment_link" : { "maxLength" : 1024, "minLength" : 0, "type" : "string", "description" : "The payment link url, which is used by the customer to pay.", "example" : "https://www.example.com/web-api/Payment.po?extid=eyJwYXlsb2FkIjp7InYiOjEsImlwaS" } } }, "PaymentLinkRequest" : { "required" : [ "expires", "form_customer_continuation" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "form_data" : { "$ref" : "#/components/schemas/FormData" }, "form_customer_continuation" : { "$ref" : "#/components/schemas/FormCustomerContinuation" }, "callback" : { "$ref" : "#/components/schemas/Callback" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" }, "account_information" : { "$ref" : "#/components/schemas/AccountInformation" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "merchant_risk_indicators" : { "$ref" : "#/components/schemas/MerchantRiskIndicators" }, "merchant_defined_information" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RiskCheckMerchantDefinedInformation" } }, "travel_information" : { "$ref" : "#/components/schemas/RiskCheckTravelInformation" }, "risk_check_additional_information" : { "$ref" : "#/components/schemas/RiskCheckAdditionalInformation" }, "bank_account" : { "$ref" : "#/components/schemas/BankAccount" }, "processing_options" : { "type" : "array", "items" : { "type" : "string", "description" : "Specific options for checkout page processing. Valid values are:\n\n * `COOKIES_ACCEPTED`: The customer has already agreed to the use of cookies.\n * `STORE_CHECKOUT_PAGE_PREFERENCES`: The customer has agreed to store checkout page preferences in cookie value. For this, the customer must also have agreed to the use of cookies.\n ", "example" : "COOKIES_ACCEPTED", "enum" : [ "COOKIES_ACCEPTED", "STORE_CHECKOUT_PAGE_PREFERENCES" ] } }, "checkout_page_configuration" : { "$ref" : "#/components/schemas/FormCheckoutConfiguration" }, "expires" : { "type" : "string", "description" : "Specifies until when the payment link is valid and usable.", "format" : "date-time" } }, "description" : "Request data that is being used to create a payment link." }, "PaymentLinkEventResponse" : { "required" : [ "message", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "payment_link_info" : { "$ref" : "#/components/schemas/PaymentLinkInfo" }, "payment_link_url" : { "type" : "string" } }, "description" : "Response contains all information about payment link belonging to the event." }, "PaymentLinkManagementUpdateRequest" : { "type" : "object", "properties" : { "expires" : { "type" : "string", "format" : "date-time" } }, "description" : "The request to be executed on the paymentlink management API ." }, "RiskmanagementEntryResponse" : { "required" : [ "message", "rc" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "tx_id" : { "type" : "string", "description" : "Unique transaction identifier. Can be used to reference this transaction.", "example" : "6388615628286356704005" }, "status" : { "type" : "string", "description" : "The status of the external processed risk check transaction.", "example" : "COMPLETED" }, "utc_time" : { "type" : "string", "description" : "The UTC time of the risk check.", "example" : "2021-11-11T11:36:03Z" }, "error_information" : { "$ref" : "#/components/schemas/RiskmanErrorInformation" } } }, "RiskmanagementEntryRequest" : { "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "account_information" : { "$ref" : "#/components/schemas/AccountInformation" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "merchant_risk_indicators" : { "$ref" : "#/components/schemas/MerchantRiskIndicators" }, "merchant_defined_information" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RiskCheckMerchantDefinedInformation" } }, "travel_information" : { "$ref" : "#/components/schemas/RiskCheckTravelInformation" }, "risk_check_additional_information" : { "$ref" : "#/components/schemas/RiskCheckAdditionalInformation" }, "credit_card_data" : { "$ref" : "#/components/schemas/CreditCard" }, "bank_account" : { "$ref" : "#/components/schemas/BankAccount" }, "address" : { "$ref" : "#/components/schemas/CommonAddress" }, "delivery_email_address" : { "type" : "string", "description" : "The delivery email address which has to be added to or removed from a list." }, "reason" : { "type" : "string", "description" : "The reason why to add an entry to the list or remove an entry from the list.", "example" : "SUSPECTED", "enum" : [ "FRAUD_CHARGEBACK", "NON_FRAUD_CHARGEBACK", "SUSPECTED", "CREDITBACK" ] }, "action" : { "type" : "string", "description" : "The action to perform with the list.", "example" : "ADD", "enum" : [ "ADD", "DELETE" ] }, "list_name" : { "type" : "string", "description" : "The list name where to perform the action.", "example" : "NEGATIVE", "enum" : [ "NEGATIVE", "POSITIVE" ] } }, "description" : "Denotes a set of data elements like addresses or credit card PAN to add to the negative or positive list." }, "RiskmanagementScoringResponse" : { "required" : [ "event_id", "message", "rc", "tx_id" ], "type" : "object", "properties" : { "rc" : { "type" : "string", "description" : "Response code of the transaction. \"0\" in the case of a successful transaction. Other values signify errors.", "example" : "0" }, "message" : { "type" : "string", "description" : "Success or error message, text for the response code.", "example" : "Transaction approved." }, "event_id" : { "maxLength" : 50, "minLength" : 1, "pattern" : "[\\/0-9a-zA-Z_.:,\\-+*$%]+", "type" : "string", "description" : "A unique ID for the event.", "example" : "E5686585867636541231230" }, "tx_id" : { "type" : "string", "description" : "Unique transaction identifier. Can be used to reference this transaction.", "example" : "020LMG10jxSI8FN0OC4vLR" }, "riskmanagement_info" : { "$ref" : "#/components/schemas/RiskmanagementInfoResponse" } } }, "RiskmanagementScoringRequest" : { "required" : [ "amount_total" ], "type" : "object", "properties" : { "billing_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "basket" : { "$ref" : "#/components/schemas/Basket" }, "device_information" : { "$ref" : "#/components/schemas/DeviceInformation" }, "shipping_address" : { "$ref" : "#/components/schemas/CommonAddress" }, "merchant_information" : { "$ref" : "#/components/schemas/MerchantInformation" }, "account_information" : { "$ref" : "#/components/schemas/AccountInformation" }, "customer_information" : { "$ref" : "#/components/schemas/CustomerInformation" }, "merchant_risk_indicators" : { "$ref" : "#/components/schemas/MerchantRiskIndicators" }, "merchant_defined_information" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RiskCheckMerchantDefinedInformation" } }, "travel_information" : { "$ref" : "#/components/schemas/RiskCheckTravelInformation" }, "risk_check_additional_information" : { "$ref" : "#/components/schemas/RiskCheckAdditionalInformation" }, "credit_card_data" : { "$ref" : "#/components/schemas/CreditCard" }, "bank_account" : { "$ref" : "#/components/schemas/BankAccount" }, "address" : { "$ref" : "#/components/schemas/CommonAddress" }, "amount_total" : { "$ref" : "#/components/schemas/AmountCurrency" } }, "description" : "Denotes a set of data elements like addresses or credit card PAN to add to the negative or positive list." } }, "securitySchemes" : { "bearerAuth" : { "type" : "http", "scheme" : "bearer", "bearerFormat" : "JWT" } } } }