{"components":{"responses":{"4XX_Client_Error_Response":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorResponse"}}},"description":"error response for all http error codes in range 4XX"},"5XX_Server_Error_Response":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorResponse"}}},"description":"error response for all http error codes in range 5XX"}},"schemas":{"AssignmentDto":{"properties":{"assignableLeftoverAmount":{"$ref":"#/components/schemas/MoneyDto"},"assignmentVersion":{"description":"Version of the assignment","format":"int32","nullable":true,"type":"integer"},"paymentBatchItemIdent":{"description":"Ident of the BatchItem which was assigned","nullable":true,"type":"string"}},"required":["assignableLeftoverAmount"],"type":"object"},"AvailableMigrationsDto":{"properties":{"migrations":{"description":"List of available migrations.\nMust not be null.","items":{"description":"List of available migrations","type":"string"},"type":"array"}},"required":["migrations"],"type":"object"},"BatchItemRequestDto":{"properties":{"baseAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount of money paid with this batch item. Must match settlement item or transaction base currency, otherwise the settlement item wil be rejected","type":"object"},"creditDebitIndicator":{"description":"A description, whether this batch item is a DEBIT, removing money from the account or a CREDIT, adding money to the account.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| CREDIT |\n| DEBIT  |","example":"DEBIT","type":"string"},"ident":{"description":"Unique identifier of a batch item. Will be set automatically if not provided","nullable":true,"type":"string"},"originalAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount of money paid with this batch item. Represented in the original currency of a transaction. In case original currency is different than the base currency, an exchange rate must also be provided, otherwise the settlement item will be rejected. When original amount is not provided in a request, Batch item is created with original amount equal to the base amount.","nullable":true,"type":"object"},"properties":{"description":"Key-value-pairs of properties of a batch item - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"},"nullable":true,"type":"array"},"text":{"description":"Any additional information about a batch item like purpose, description, payment title, etc.","nullable":true,"type":"string"}},"required":["baseAmount","creditDebitIndicator"],"type":"object"},"CategorizationRuleCreationRequest":{"description":"Creates JSONata rules to map a Settlement to the correct transaction category used for automatic assignment.","properties":{"description":{"description":"Description of the rule.","nullable":true,"type":"string"},"ident":{"description":"Unique identifier to identify the rule.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"jsonataExpression":{"description":"JSONata rule. Must return a Boolean value when applied to a PaymentDto. If the result is TRUE this rule is applied.\nMust not be blank.\nSize must be between 1 and 512.","maxLength":512,"minLength":1,"type":"string"},"priority":{"description":"Priority of application. Lower number will be processed earlier. First match will be applied.\nMust not be null.\nMust be greater than 0.","format":"int32","type":"integer"},"resultingPaymentCategoryName":{"description":"Name of an existing payment category. See payment categories endpoint.\nMust not be blank.","minLength":1,"type":"string"}},"required":["ident","jsonataExpression","priority","resultingPaymentCategoryName"],"type":"object"},"CategorizationRuleResponse":{"description":"JSONata rules to map a Settlement to the correct transaction category used for automatic assignment.","properties":{"description":{"description":"Description of the rule.","nullable":true,"type":"string"},"ident":{"description":"Unique identifier to identify the rule.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"jsonataExpression":{"description":"JSONata rule. Must return a Boolean value when applied to a PaymentDto. If the result is TRUE this rule is applied.\nMust not be blank.\nSize must be between 1 and 512.","maxLength":512,"minLength":1,"type":"string"},"merchantPaymentAccountIdent":{"description":"Unique identifier to identify the merchant payment account.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"priority":{"description":"Priority of application. Lower number will be processed earlier. First match will be applied.\nMust not be null.\nMust be greater than 0.","format":"int32","type":"integer"},"resultingPaymentCategoryName":{"description":"Name of an existing payment category. See payment categories endpoint.\nMust not be blank.","minLength":1,"type":"string"}},"required":["ident","jsonataExpression","merchantPaymentAccountIdent","priority","resultingPaymentCategoryName"],"type":"object"},"CategorizationRuleUpdateRequest":{"description":"Updates JSONata rules to map a Settlement to the correct transaction category used for automatic assignment.","properties":{"description":{"description":"Description of the rule.","nullable":true,"type":"string"},"jsonataExpression":{"description":"JSONata rule. Must return a Boolean value when applied to a PaymentDto. If the result is TRUE this rule is applied.\nMust not be blank.\nSize must be between 1 and 512.","maxLength":512,"minLength":1,"type":"string"},"priority":{"description":"Priority of application. Lower number will be processed earlier. First match will be applied.\nMust not be null.\nMust be greater than 0.","format":"int32","type":"integer"},"resultingPaymentCategoryName":{"description":"Name of an existing payment category. See payment categories endpoint.\nMust not be blank.","minLength":1,"type":"string"}},"required":["jsonataExpression","priority","resultingPaymentCategoryName"],"type":"object"},"CreateCredentialsDto":{"properties":{"password":{"description":"Must not be empty.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"username":{"description":"Must not be empty.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["password","username"],"type":"object"},"CreateCustomerSpecificSettlementIdentConfigurationDto":{"properties":{"counters":{"description":"Set of counters used to generate customer specific settlement idents, based on settlement criteria specified by generation mode.","items":{"$ref":"#/components/schemas/CreateSettlementIdentCounterDto"},"nullable":true,"type":"array","uniqueItems":true},"generationMode":{"description":"Mode of generating customer specific settlement ident.\nMust not be null.\nMust be one of:\n|                     |\n| ------------------- |\n| COUNTER_BY_CURRENCY |\n| SIMPLE_COUNTER      |\n| NO_IDENT            |","type":"string"}},"required":["generationMode"],"type":"object"},"CreateEbicsSettlementConfig":{"allOf":[{"$ref":"#/components/schemas/CreateSettlementConfig"},{"properties":{"ebicsKeys":{"description":"Must not be null.\nSize must be between 0 and 16384.","maxLength":16384,"type":"string"},"iban":{"description":"Size must be between 0 and 255.","maxLength":255,"type":"string"},"partnerId":{"description":"Must not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"passphrase":{"description":"Must not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"userId":{"description":"Must not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"type":"object"}],"description":"Configuration of payment account that is required to fetch settlements via Ebics protocol.","nullable":true,"required":["ebicsKeys","partnerId","passphrase","protocolType","settlementSourceId","userId"],"type":"object"},"CreateEbicsSettlementSource":{"allOf":[{"$ref":"#/components/schemas/CreateSettlementSource"},{"properties":{"hostId":{"description":"The host id of the bank.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"type":"object"}],"description":"Ebics settlement source that except standard properties contains also host id of the bank.","required":["fileType","host","hostId","name","protocolType"],"type":"object"},"CreateFee":{"description":"Create Fee request body.","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"Money amount of a fee. Must be expressed in a payment base currency, otherwise the payment will be rejected.","type":"object"},"type":{"description":"Type of a fee. Must by one of the possible fee types specified in Nitrobox.\nMust not be null.\nMust be one of:\n|              |\n| ------------ |\n| COMMISSION   |\n| MARKUP       |\n| SCHEME_FEES  |\n| INTERCHANGE  |\n| STANDARD_FEE |","type":"string"}},"required":["amount","type"],"type":"object"},"CreateMerchantPaymentAccount":{"description":"A CreateMerchantPaymentAccount is used to create a merchant payment account representing an account kept by a bank/PSP on behalf of its customer.","properties":{"active":{"description":"Specifies if a merchant payment account is active, that means if payments from this account are processed in system.\nMust not be null.","type":"boolean"},"additionallyAcceptedCurrencies":{"description":"List of currencies accepted by the MerchantPaymentAccount in addition to the base currency.","items":{"enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"nullable":true,"type":"array","uniqueItems":true},"country":{"description":"The country where the MerchantPaymentAccount is valid. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.\nMust not be null.","example":"DEU","type":"string"},"currency":{"description":"The currency used for this merchant payment account. Must be one of:.\nMust not be null.","example":"EUR","type":"string"},"ident":{"description":"Unique external reference for the merchant payment account.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"Name of the merchant payment account.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"paymentCollectionConfig":{"$ref":"#/components/schemas/PaymentCollectionConfig"},"paymentServiceProviderId":{"description":"Id of the payment service provider.\nMust not be null.","format":"int64","type":"integer"},"settlementConfig":{"oneOf":[{"$ref":"#/components/schemas/CreateEbicsSettlementConfig"},{"$ref":"#/components/schemas/CreateRestApiSettlementConfig"},{"$ref":"#/components/schemas/CreateSftpSettlementConfig"}]},"settlementsCreationDisabled":{"default":false,"description":"Specifies if creation of settlements is disabled for a merchant payment account. When set to true, account statement filesof this account are loaded from PSP/bank but settlements are not created in NBX.","type":"boolean"},"settlementsProcessingSchedule":{"$ref":"#/components/schemas/CreateSettlementsProcessingScheduleDto"}},"required":["active","country","currency","ident","name","paymentServiceProviderId"],"type":"object"},"CreateMerchantPaymentGateway":{"description":"A CreateMerchantPaymentGateway is used to create a MerchantPaymentGateway that is used to route payments to a MerchantPaymentAccount based on the currency.","properties":{"currencyToAccountMapping":{"additionalProperties":{"description":"List of Assignments consisting of a CurrencyCode and an ident of a MerchantPaymentAccount used for routing, e.g. \"PLN\": \"MerchantPaymentAccountIdent\".","nullable":true,"type":"string"},"description":"List of Assignments consisting of a CurrencyCode and an ident of a MerchantPaymentAccount used for routing, e.g. \"PLN\": \"MerchantPaymentAccountIdent\".","nullable":true,"type":"object"},"ident":{"description":"Unique external reference for the MerchantPaymentGateway.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"Name of the MerchantPaymentGateway.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"paymentServiceProviderId":{"description":"The id of the payment service provider.\nMust not be null.","format":"int64","type":"integer"}},"required":["ident","name","paymentServiceProviderId"],"type":"object"},"CreatePaymentProviderDto":{"properties":{"name":{"description":"Name of the payment service provider.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"settlementSources":{"description":"Settlement sources","items":{"oneOf":[{"$ref":"#/components/schemas/CreateEbicsSettlementSource"},{"$ref":"#/components/schemas/CreateRestApiSettlementSource"},{"$ref":"#/components/schemas/CreateSftpSettlementSource"}]},"nullable":true,"type":"array"},"type":{"description":"Type of the payment service provider.\nMust not be null.\nMust be one of:\n|               |\n| ------------- |\n| ADYEN         |\n| CONTOWORKS    |\n| COMMERZBANK   |\n| GOCARDLESS    |\n| KLARNA        |\n| MOLLIE        |\n| OPTILE        |\n| STRIPE        |\n| VWFS_SMARTPAY |\n| WORLDLINE     |\n| SBA           |\n| OTHER         |","type":"string"}},"required":["name","type"],"type":"object"},"CreatePaymentTransactionDto":{"description":"A payment transaction describes a financial transaction that happened on a payment account.","properties":{"baseAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"The amount, that is actually transferred to this account in the accounts base currency. Must be represented in the same currency as an enclosing payment account, otherwise the payment transaction request will be rejected.","type":"object"},"batchItems":{"description":"List of batch items that will be updated","items":{"$ref":"#/components/schemas/BatchItemRequestDto"},"nullable":true,"type":"array"},"bookingDate":{"description":"The date of the account transaction. ISO 8601 date time format. When no offset is provided (e.g. 2021-03-19T13:34:01), UTC is automatically used.\nMust not be null.","example":"2021-02-25T13:30:22+02:00","format":"date-time","type":"string"},"creationDate":{"description":"The date of a creation of a payment. ISO 8601 date time format. When no offset is provided (e.g. 2021-03-19T13:34:01), UTC is automatically used.","example":"2021-02-25T13:30:22+02:00","format":"date-time","nullable":true,"type":"string"},"creditDebitIndicator":{"description":"A description, whether this payment transaction is a DEBIT, removing money from the account or a CREDIT, adding money to the account.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| CREDIT |\n| DEBIT  |","example":"DEBIT","type":"string"},"customerSpecificIdent":{"description":"Is an optional customer specific ident, that can be used to identify this payment transaction.\nSize must be between 0 and 255.","example":"2593935f-cf9a-4a53-b754-ee92d91b82ef","maxLength":255,"nullable":true,"type":"string"},"exchangeRate":{"description":"Exchange rate used to calculate original and base amounts.\n* Exchange rate must be provided when the original currency is different from the base currency.\n* The rate should fulfill following calculation: originalAmount / exchangeRate = baseAmount, with an error margin of 0.01.\n* Exchange rate value needs to be expressed with max 5 decimals. E.g.: 4.54321.\n* If an original amount is not provided in a request, special 'self' exchange rate is automatically created with a value of 1.00000.\nMust be greater than or equal to 0.0.\nMust be a number with up to 10 integral digits and up to 5 fractional digits.","exclusiveMinimum":true,"minimum":0,"nullable":true,"type":"number"},"externalIdent":{"description":"External reference that needs to be unique within a payment account. Generally it is provided by a Payment Service Provider or a bank. Cannot be amended after the initial POST.\nMust not be blank.\nSize must be between 0 and 255.","example":"2593935f-cf9a-4a53-b754-ee92d91b82ef","maxLength":255,"type":"string"},"fees":{"description":"Any fees imposed on this payment.","items":{"$ref":"#/components/schemas/CreateFee"},"nullable":true,"type":"array"},"ident":{"description":"Unique identifier of a payment transaction, autogenerated by Nitrobox if omitted.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"originalAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"The original amount, that was transferred to this account before converting it to the accounts base currency.Represented in the original currency of a transaction.In case original currency is different than the base currency, an exchange rate must also be provided,otherwise the payment transaction will be rejected. When original amount is not provided in a request, payment is created with original amount equal to the base amount.","nullable":true,"type":"object"},"paymentCategory":{"description":"Name of a payment category that this payment is classified to. Must be one of the categories defined in Nitrobox, otherwise the payment will be rejected.Category selection have an influence on how the payment is processed further.\nMust not be blank.\nSize must be between 0 and 255.","example":"BANK_FEE","maxLength":255,"type":"string"},"properties":{"description":"Key-Value-Pairs of properties of a settlement - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"},"nullable":true,"type":"array"},"recipient":{"description":"The recipient of the payment transfer.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"sender":{"description":"The sender of the payment transfer.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"status":{"description":"The status this payment transaction is in.\nMust not be null.\nMust be one of:\n|                |\n| -------------- |\n| RECEIVED       |\n| ERROR          |\n| REFUSED        |\n| AUTHORIZED     |\n| EXPIRED        |\n| CANCELLED      |\n| CAPTURED       |\n| CAPTURE_FAILED |\n| SETTLED        |\n| REFUNDED       |\n| CHARGEBACK     |","example":"CAPTURED","type":"string"},"text":{"description":"Any additional information about a payment like purpose, description, payment title, etc. This is often used for matching the payment to a document.\nSize must be between 0 and 1400.","maxLength":1400,"nullable":true,"type":"string"},"valueDate":{"description":"The date on which the account transaction takes effect. ISO 8601 date time format. When no offset is provided (e.g. 2021-03-19T13:34:01), UTC is automatically used.\nMust not be null.","example":"2021-02-25T13:30:22+02:00","format":"date-time","type":"string"}},"required":["baseAmount","bookingDate","creditDebitIndicator","externalIdent","paymentCategory","status","valueDate"],"type":"object"},"CreateRestApiSettlementConfig":{"allOf":[{"$ref":"#/components/schemas/CreateSettlementConfig"},{"properties":{"oAuthClientId":{"type":"string","writeOnly":true},"oAuthClientSecret":{"type":"string","writeOnly":true},"oauthClientId":{"type":"string"},"oauthClientSecret":{"type":"string"}},"type":"object"}],"description":"Payment account configuration specific for fetching settlements by means of a REST API with OAuth authorization.","nullable":true,"required":["protocolType","settlementSourceId"],"type":"object"},"CreateRestApiSettlementSource":{"allOf":[{"$ref":"#/components/schemas/CreateSettlementSource"},{"properties":{"connectTimeoutInMillis":{"format":"int32","type":"integer"},"readTimeoutInMillis":{"format":"int32","type":"integer"},"retryFirstBackoffInMillis":{"format":"int32","type":"integer"},"retryMaxAttempts":{"format":"int32","type":"integer"},"retryMaxBackoffInMillis":{"format":"int32","type":"integer"},"tokenUrl":{"description":"The token url to authenticate.\nMust not be null.","type":"string"}},"type":"object"}],"description":"REST API settlement source that except standard properties contains also an URL to obtain an oAuth token.","required":["fileType","host","name","protocolType","tokenUrl"],"type":"object"},"CreateSettlementConfig":{"description":"Payment account configuration that is used to connect to settlement server via some specified protocol. The supported protocols are: SFTP, EBICS and HTTP.","discriminator":{"mapping":{"EBICS":"#/components/schemas/CreateEbicsSettlementConfig","HTTP":"#/components/schemas/CreateRestApiSettlementConfig","SFTP":"#/components/schemas/CreateSftpSettlementConfig"},"propertyName":"protocolType"},"properties":{"protocolType":{"description":"Protocol type of this settlement config. Should be the same as protocol of source.\nMust not be null.\nMust be one of:\n|       |\n| ----- |\n| EBICS |\n| SFTP  |\n| HTTP  |","type":"string"},"settlementSourceId":{"description":"Reference to settlements source.\nMust not be null.","format":"int64","type":"integer"}},"required":["protocolType","settlementSourceId"],"type":"object"},"CreateSettlementIdentCounterDto":{"properties":{"maxValue":{"description":"Maximum value that this counter may reach.\nMust not be null.","format":"int64","type":"integer"},"minValue":{"description":"Minimum value, will be used as a starting value for a counter.\nMust not be null.","format":"int64","type":"integer"},"name":{"description":"Unique counter name.\nMust not be blank.","minLength":1,"type":"string"},"settlementAttributeValues":{"description":"Set of settlement attribute values, used by ident generation mode.","items":{"type":"string"},"nullable":true,"type":"array","uniqueItems":true}},"required":["maxValue","minValue","name"],"type":"object"},"CreateSettlementItem":{"description":"Create Settlement Item request body.","properties":{"baseAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount of money paid with this settlement item. Must be represented in the same currency as an enclosing payment account, otherwise the settlement item will be rejected.","type":"object"},"batchItems":{"description":"Sub items that are batched together in this settlement item. If specified, their sum must match the settlement item.","items":{"$ref":"#/components/schemas/SettlementBatchItemDto"},"nullable":true,"type":"array"},"bookingDate":{"description":"The date of the account transaction. ISO 8601 date time format. E.g. 2021-03-19T13:34:01Z+01:00. When no offset is provided (e.g. 2021-03-19T13:34:01), UTC is automatically used.\nMust not be null.","format":"date-time","type":"string"},"creationDate":{"description":"The date of a creation of a settlement item. ISO 8601 date time format. E.g. 2021-03-19T13:34:01Z+01:00.","format":"date-time","nullable":true,"type":"string"},"creditDebitIndicator":{"description":"Indicates whether a settlement item is a DEBIT or CREDIT.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| CREDIT |\n| DEBIT  |","type":"string"},"exchangeRate":{"description":"Exchange rate used to calculate original and base amounts.\n* Exchange rate must be provided when the original currency is different from the base currency.\n* The rate should fulfill following calculation: originalAmount / exchangeRate = baseAmount, with an error margin of 0.01.\n* Exchange rate value needs to be expressed with max 5 decimals. E.g.: 4.54321.\n* If an original amount is not provided in a request, special 'self' exchange rate is automatically created with a value of 1.00000.\nMust be greater than or equal to 0.0.\nMust be a number with up to 10 integral digits and up to 5 fractional digits.","exclusiveMinimum":true,"minimum":0,"nullable":true,"type":"number"},"externalIdent":{"description":"A settlement item identifier, unique within a payment account. May be provided by a PSP.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"fees":{"description":"Any fees imposed on this payment.","items":{"$ref":"#/components/schemas/CreateFee"},"nullable":true,"type":"array"},"ident":{"description":"Unique identifier of a settlement item, autogenerated by Nitrobox if omitted.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"originalAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount of money paid with this settlement item. Represented in the original currency of a transaction. In\ncase original currency is different than the base currency, an exchange rate must also be provided, otherwise the\nsettlement item will be rejected. When original amount is not provided in a request, Settlement item is created\nwith original amount equal to the base amount.\n","nullable":true,"type":"object"},"paymentCategory":{"default":"UNCATEGORISED","deprecated":true,"description":"DEPRECATED.\nThe payment category to which a newly created payment - settled by this settlement item - is classified. This does not apply to existing payments. Must be one of the categories defined in Nitrobox, otherwise the settlement item will be rejected.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"paymentTransactionIdent":{"description":"An identifier of a payment transaction which is settled with this settlement item.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"properties":{"description":"Key-value-pairs of properties of a settlement - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"},"nullable":true,"type":"array"},"recipient":{"description":"Information about the recipient of a settled payment.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"sender":{"description":"Information about the sender of a settled payment.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"settlementItemIdentifier":{"description":"In case the settlement report which is a source of this settlement item, is of a more complex format (e.g. XML file),the settlement item identifier should allow to unambiguously specify a place of a settlement item in this document.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"settlementLineNumber":{"description":"In case the settlement report which is a source of this settlement item, is a simple entry based document (e.g. CSV file), the settlement line number should specify a particular line where the settlement item is placed in the file.\nMust be greater than 0.","format":"int32","nullable":true,"type":"integer"},"text":{"description":"Any additional information about a settlement item like purpose, description, payment title, etc.\nSize must be between 0 and 1400.","maxLength":1400,"nullable":true,"type":"string"},"valueDate":{"description":"The date on which the account transaction takes effect. ISO 8601 date time format. E.g. 2021-03-19T13:34:01Z+01:00. When no offset is provided (e.g. 2021-03-19T13:34:01), UTC is automatically used.","format":"date-time","nullable":true,"type":"string"}},"required":["baseAmount","bookingDate","creditDebitIndicator","externalIdent"],"type":"object"},"CreateSettlementReportDto":{"properties":{"fileName":{"description":"Unique filename of the settlement statement provided by a Payment Service Provider or a bank.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"ident":{"description":"Identifier that is unique on payment account level. Can be identical to statementReference or fileName.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"statementCreationDate":{"description":"A date when the settlement statement was created by a Payment Service Provider or a bank.\nMust not be null.","format":"date-time","type":"string"},"statementReference":{"description":"Unique business pointer to the settlement statement provided by a Payment Service Provider or a bank. In case of some PSPs may be identical to the filename.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["fileName","ident","statementCreationDate","statementReference"],"type":"object"},"CreateSettlementSource":{"description":"A settlement source is a configuration of settlements provider, usually it is server configuration like host, port etc.\nThe configuration may contain different properties for different protocols. The supported protocols are Sftp and Ebics.","discriminator":{"mapping":{"EBICS":"#/components/schemas/CreateEbicsSettlementSource","HTTP":"#/components/schemas/CreateRestApiSettlementSource","SFTP":"#/components/schemas/CreateSftpSettlementSource"},"propertyName":"protocolType"},"properties":{"fileType":{"description":"Format of files that are fetched from the source.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| CSV    |\n| EPA    |\n| CAMT53 |\n| CAMT54 |\n| MT940  |","type":"string"},"host":{"description":"Host of the source server.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"name":{"description":"Human readable name.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"port":{"description":"Port of the source server.","format":"int32","nullable":true,"type":"integer"},"protocolType":{"description":"Protocol type of this settlement source.\nMust not be null.\nMust be one of:\n|       |\n| ----- |\n| EBICS |\n| SFTP  |\n| HTTP  |","type":"string"}},"required":["fileType","host","name","protocolType"],"type":"object"},"CreateSettlementsProcessingScheduleDto":{"description":"A schedule specifying the time when settlement statements from this account will be loaded from PSP and processed.","nullable":true,"properties":{"cronExpression":{"description":"Cron expression specifies when the settlements should be loaded.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["cronExpression"],"type":"object"},"CreateSftpSettlementConfig":{"allOf":[{"$ref":"#/components/schemas/CreateSettlementConfig"},{"properties":{"credentials":{"$ref":"#/components/schemas/CreateCredentialsDto"},"remoteDirectory":{"description":"Must not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"type":"object"}],"description":"Payment account configuration specific for fetching settlements from sftp server.","nullable":true,"required":["credentials","protocolType","remoteDirectory","settlementSourceId"],"type":"object"},"CreateSftpSettlementSource":{"allOf":[{"$ref":"#/components/schemas/CreateSettlementSource"}],"description":"Sftp settlement source that except standard properties contains also path to remote directory on the server.","required":["fileType","host","name","protocolType"],"type":"object"},"CreateTenantPaymentCategoryConfig":{"properties":{"assignable":{"description":"Specifies if this category is assignable.\nMust not be null.","type":"boolean"},"enabled":{"description":"Specifies if this category is enabled to be used for the tenant's payments.\nMust not be null.","type":"boolean"},"name":{"description":"Unique payment category name.\nMust not be empty.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["assignable","enabled","name"],"type":"object"},"CredentialsDto":{"properties":{"username":{"description":"The username","nullable":true,"type":"string"}},"type":"object"},"CustomerPaymentAccountCreationRequest":{"description":"A CustomerPaymentAccount with payment details that is assigned to a specific debtorIdent.","properties":{"accountCreationDate":{"description":"Date when the payment account was created at the payment provider. Required e.g. for some external mandate managements in the SEPA environment.","example":"2021-02-25T13:30:22+02:00","format":"date-time","nullable":true,"type":"string"},"accountHolderName":{"description":"Account holder name used for the charging.\nSize must be between 0 and 255.","example":"John Doe","maxLength":255,"nullable":true,"type":"string"},"debtorIdent":{"description":"Unique external reference to identify the Debtor.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"myDebtorIdent","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"displayName":{"description":"Name for the customer payment account displayed on invoices. Do not send full payment data like credit card no, IBAN, etc. (e.g. \"**** **** *** *234\").\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"ident":{"description":"Unique identifier of a customer payment account, autogenerated by Nitrobox if omitted.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"merchantPaymentGatewayIdent":{"description":"Unique reference to identify the merchant payment gateway that is associated with this account.\nMust not be null.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"myMerchantPaymentGatewayIdent","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"deprecated":true,"description":"DEPRECATED.\nName of the customer payment account.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"paymentCardType":{"description":"The vendor of the credit card.\nMust be one of:\n|                 |\n| --------------- |\n| VISA            |\n| MASTERCARD      |\n| JCB             |\n| AMERICANEXPRESS |\n| DINERSCLUB      |\n| OTHER           |\n| YANDEXBANKCARD  |\n| DISCOVERCARD    |\n| CARTE_BANCAIRE  |","example":"MASTERCARD","nullable":true,"type":"string"},"paymentMethod":{"description":"Payment method associated with the customerPaymentAccount via the paymentProviderReference. The specification is only for further explanation and has no effect on the actual selection of the payment method. This is determined entirely by specifying the paymentProviderReference or additionally by the paymentMethodReference.\nMust be one of:\n|              |\n| ------------ |\n| DIRECT_DEBIT |\n| CREDIT_CARD  |\n| PAY_PAL      |","example":"DIRECT_DEBIT","nullable":true,"type":"string"},"paymentMethodReference":{"description":"External reference to identify the authorization or mandate of the payment method at the payment provider. This is optional because some payment providers require a general customer reference (paymentProviderReference) and a payment method reference (paymentMethodReference) in order to process a payment.\nSize must be between 0 and 255.","example":"myToken","maxLength":255,"nullable":true,"type":"string"},"paymentProviderReference":{"description":"External reference to identify the account at the payment provider. For example the IBAN when using DIRECT_DEBIT as PaymentProviderType.\nMust not be null.\nSize must be between 0 and 255.","example":"DE07123412341234123412","maxLength":255,"type":"string"}},"required":["debtorIdent","merchantPaymentGatewayIdent","paymentProviderReference"],"type":"object"},"CustomerPaymentAccountRequest":{"description":"A CustomerPaymentAccount with payment details that is assigned to a specific debtorIdent.","properties":{"accountCreationDate":{"description":"Date when the payment account was created at the payment provider. Required e.g. for some external mandate managements in the SEPA environment.","example":"2021-02-25T13:30:22+02:00","format":"date-time","nullable":true,"type":"string"},"accountHolderName":{"description":"Account holder name used for the charging.\nSize must be between 0 and 255.","example":"John Doe","maxLength":255,"nullable":true,"type":"string"},"displayName":{"description":"Name for the customer payment account displayed on invoices. Do not send full payment data like credit card no, IBAN, etc. (e.g. \"**** **** *** *234\").\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"merchantPaymentGatewayIdent":{"description":"Unique reference to identify the merchant payment gateway that is associated with this account.\nMust not be null.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"myMerchantPaymentGatewayIdent","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"deprecated":true,"description":"DEPRECATED.\nName of the customer payment account.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"paymentCardType":{"description":"The vendor of the credit card.\nMust be one of:\n|                 |\n| --------------- |\n| VISA            |\n| MASTERCARD      |\n| JCB             |\n| AMERICANEXPRESS |\n| DINERSCLUB      |\n| OTHER           |\n| YANDEXBANKCARD  |\n| DISCOVERCARD    |\n| CARTE_BANCAIRE  |","example":"MASTERCARD","nullable":true,"type":"string"},"paymentMethod":{"description":"Payment method associated with the customerPaymentAccount via the paymentProviderReference. The specification is only for further explanation and has no effect on the actual selection of the payment method. This is determined entirely by specifying the paymentProviderReference or additionally by the paymentMethodReference.\nMust be one of:\n|              |\n| ------------ |\n| DIRECT_DEBIT |\n| CREDIT_CARD  |\n| PAY_PAL      |","example":"DIRECT_DEBIT","nullable":true,"type":"string"},"paymentMethodReference":{"description":"External reference to identify the authorization or mandate of the payment method at the payment provider. This is optional because some payment providers require a general customer reference (paymentProviderReference) and a payment method reference (paymentMethodReference) in order to process a payment.\nSize must be between 0 and 255.","example":"myToken","maxLength":255,"nullable":true,"type":"string"},"paymentProviderReference":{"description":"External reference to identify the account at the payment provider. For example the IBAN when using DIRECT_DEBIT as PaymentProviderType.\nMust not be null.\nSize must be between 0 and 255.","example":"DE07123412341234123412","maxLength":255,"type":"string"}},"required":["merchantPaymentGatewayIdent","paymentProviderReference"],"type":"object"},"CustomerPaymentAccountResponse":{"description":"A CustomerPaymentAccount with payment details that is assigned to a specific debtorIdent. ","properties":{"accountCreationDate":{"description":"Date when the payment account was created at the payment provider. Required e.g. for some external mandate managements in the SEPA environment.","example":"2021-02-25T13:30:22+02:00","format":"date-time","nullable":true,"type":"string"},"accountHolderName":{"description":"Account holder name used for the charging.\nSize must be between 0 and 255.","example":"John Doe","maxLength":255,"nullable":true,"type":"string"},"debtorIdent":{"description":"Unique external reference to identify the Debtor.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"myDebtorIdent","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"displayName":{"description":"Name for the customer payment account displayed on invoices. Do not send full payment data like credit card no, IBAN, etc. (e.g. \"**** **** *** *234\").\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"healthStatus":{"description":"Health status of this customer payment account.\nMust not be null.\nMust be one of:\n|         |\n| ------- |\n| GOOD    |\n| AVERAGE |\n| POOR    |","example":"GOOD","type":"string"},"ident":{"description":"Unique internal reference to identify this CustomerPaymentAccount.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"c9414238-8d55-4bcc-8945-e085d1326e2b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"merchantPaymentGatewayIdent":{"description":"Unique reference to identify the merchant payment gateway that is associated with this account.\nMust not be null.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"myMerchantPaymentGatewayIdent","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"paymentCardType":{"description":"The vendor of the credit card.\nMust be one of:\n|                 |\n| --------------- |\n| VISA            |\n| MASTERCARD      |\n| JCB             |\n| AMERICANEXPRESS |\n| DINERSCLUB      |\n| OTHER           |\n| YANDEXBANKCARD  |\n| DISCOVERCARD    |\n| CARTE_BANCAIRE  |","example":"MASTERCARD","nullable":true,"type":"string"},"paymentMethod":{"description":"Payment method associated with the customerPaymentAccount via the paymentProviderReference. The specification is only for further explanation and has no effect on the actual selection of the payment method. This is determined entirely by specifying the paymentProviderReference or additionally by the paymentMethodReference.\nMust be one of:\n|              |\n| ------------ |\n| DIRECT_DEBIT |\n| CREDIT_CARD  |\n| PAY_PAL      |","example":"DIRECT_DEBIT","nullable":true,"type":"string"},"paymentMethodReference":{"description":"External reference to identify the authorization or mandate of the payment method at the payment provider. This is optional because some payment providers require a general customer reference (paymentProviderReference) and a payment method reference (paymentMethodReference) in order to process a payment.\nSize must be between 0 and 255.","example":"myToken","maxLength":255,"nullable":true,"type":"string"},"paymentProviderReference":{"description":"External reference to identify the account at the payment provider. For example the IBAN when using DIRECT_DEBIT as PaymentProviderType.\nMust not be null.\nSize must be between 0 and 255.","example":"DE07123412341234123412","maxLength":255,"type":"string"},"tenantId":{"description":"Unique internal reference to identify the Tenant.","example":1,"format":"int64","nullable":true,"type":"integer"}},"required":["debtorIdent","healthStatus","ident","merchantPaymentGatewayIdent","paymentProviderReference"],"type":"object"},"EbicsConnectionResponse":{"description":"Ebic connections responses","properties":{"merchantPaymentAccountIdent":{"description":"Unique merchant payment account identifier.\nMust not be blank.","minLength":1,"type":"string"},"success":{"description":"Success indicator of ebics connection attempt.\nMust not be null.","type":"boolean"}},"required":["merchantPaymentAccountIdent","success"],"type":"object"},"EbicsSettlementConfig":{"allOf":[{"$ref":"#/components/schemas/SettlementConfig"}],"description":"Ebics settlement source that except standard properties contains also host id of the bank.","nullable":true,"required":["id","protocolType","settlementSourceId"],"type":"object"},"EbicsSettlementSource":{"allOf":[{"$ref":"#/components/schemas/SettlementSource"},{"properties":{"hostId":{"description":"The host id of the bank.\nMust not be null.","type":"string"}},"type":"object"}],"description":"Ebics settlement source that except standard properties contains also host id of the bank.","required":["fileType","host","hostId","id","name","port","protocolType"],"type":"object"},"EmbeddedCustomerPaymentAccountDto":{"description":"A PaymentIntent is an intent to move an amount from one account to another within a PSP.","properties":{"accountCreationDate":{"description":"Date when the payment account was created at the payment provider. Required e.g. for some external mandate managements in the SEPA environment.","example":"2021-02-25T13:30:22+02:00","format":"date-time","nullable":true,"type":"string"},"accountHolderName":{"description":"Account holder name used for the charging.","example":"John Doe","nullable":true,"type":"string"},"debtorIdent":{"description":"Unique external reference to identify the Debtor.\nMust not be blank.","example":"myDebtorIdent","minLength":1,"type":"string"},"ident":{"description":"Unique identifier of a customer payment account, autogenerated by Nitrobox if omitted.\nMust not be blank.","minLength":1,"type":"string"},"name":{"deprecated":true,"description":"DEPRECATED.\nName of the customer payment account","nullable":true,"type":"string"},"paymentCardType":{"description":"The vendor of the credit card.\nMust be one of:\n|                 |\n| --------------- |\n| VISA            |\n| MASTERCARD      |\n| JCB             |\n| AMERICANEXPRESS |\n| DINERSCLUB      |\n| OTHER           |\n| YANDEXBANKCARD  |\n| DISCOVERCARD    |\n| CARTE_BANCAIRE  |","example":"MASTERCARD","nullable":true,"type":"string"},"paymentMethod":{"description":"Payment method associated with the customerPaymentAccount via the paymentProviderReference. The specification is only for further explanation and has no effect on the actual selection of the payment method. This is determined entirely by specifying the paymentProviderReference or additionally by the paymentMethodReference.\nMust be one of:\n|              |\n| ------------ |\n| DIRECT_DEBIT |\n| CREDIT_CARD  |\n| PAY_PAL      |","example":"DIRECT_DEBIT","nullable":true,"type":"string"},"paymentMethodReference":{"description":"External reference to identify the authorization or mandate of the payment method at the payment provider. This is optional because some payment providers require a general customer reference (paymentProviderReference) and a payment method reference (paymentMethodReference) in order to process a payment.","example":"myToken","nullable":true,"type":"string"},"paymentProviderReference":{"description":"External reference to identify the account at the payment provider. For example the IBAN when using DIRECT_DEBIT as PaymentProviderType.\nMust not be null.\nMust not be blank.","example":"DE07123412341234123412","minLength":1,"type":"string"}},"required":["debtorIdent","ident","paymentProviderReference"],"type":"object"},"EmbeddedMerchantPaymentAccountDto":{"description":"A MerchantPaymentAccount is a specialized financial account that enables businesses (merchants) to accept and process payments from customers.","properties":{"ident":{"description":"Unique identifier of a merchant payment account.\nMust not be blank.","minLength":1,"type":"string"},"paymentServiceProviderType":{"description":"Type of the payment service provider.\nMust not be null.\nMust be one of:\n|               |\n| ------------- |\n| ADYEN         |\n| CONTOWORKS    |\n| COMMERZBANK   |\n| GOCARDLESS    |\n| KLARNA        |\n| MOLLIE        |\n| OPTILE        |\n| STRIPE        |\n| VWFS_SMARTPAY |\n| WORLDLINE     |\n| SBA           |\n| OTHER         |","type":"string"}},"required":["ident","paymentServiceProviderType"],"type":"object"},"ExchangeRateDto":{"description":"Exchange rate used to calculate original and base amounts.\n* The rate should fulfill following calculation: originalAmount / exchangeRate = baseAmount, with an error margin of 0.01. ","nullable":true,"properties":{"originalCurrency":{"description":"original currency.\nMust not be null.","type":"string"},"targetCurrency":{"description":"target/base currency.\nMust not be null.","type":"string"},"value":{"description":"Exchange rate.\nMust not be null.","type":"number"}},"required":["originalCurrency","targetCurrency","value"],"type":"object"},"Fee":{"description":"Fee response body.","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"Money amount of a fee","type":"object"},"id":{"deprecated":true,"description":"DEPRECATED.\nAlways null","format":"int32","nullable":true,"type":"integer"},"type":{"description":"Type of a fee.\nMust not be null.\nMust be one of:\n|              |\n| ------------ |\n| COMMISSION   |\n| MARKUP       |\n| SCHEME_FEES  |\n| INTERCHANGE  |\n| STANDARD_FEE |","type":"string"}},"required":["amount","type"],"type":"object"},"GlobalErrorResponse":{"description":"error response providing details about the error occurred","properties":{"errors":{"description":"optional list of multiple errors occurred","items":{"type":"object"},"nullable":true,"type":"array"},"message":{"description":"message describing the error","nullable":true,"type":"string"},"path":{"description":"URL path where the error occurred","nullable":true,"type":"string"},"status":{"description":"textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400","type":"string"},"timestamp":{"description":"timestamp in UTC when the error occurred","format":"date-time","type":"string"},"uuid":{"description":"UUID generated by the server to identify the error occurred, should be stated in case of any inquiries","format":"uuid","nullable":true,"type":"string"}},"required":["status","timestamp"],"type":"object"},"InternalEbicsConnectionResponseDto":{"properties":{"connectionResponses":{"description":"Ebic connections responses.\nMust not be null.","items":{"$ref":"#/components/schemas/EbicsConnectionResponse"},"type":"array"}},"required":["connectionResponses"],"type":"object"},"InternalSettlementCreatedEvent":{"properties":{"paymentCategory":{"description":"The name of the payment category","nullable":true,"type":"string"},"settlementId":{"description":"The id of the settlement.\nMust not be null.","format":"int64","type":"integer"},"tenantId":{"$ref":"#/components/schemas/TenantId"}},"required":["settlementId","tenantId"],"type":"object"},"JobInfo":{"description":"Result list.","properties":{"jobKey":{"description":"The key of the job","nullable":true,"type":"string"},"triggers":{"description":"The job triggers","items":{"$ref":"#/components/schemas/TriggerInfo"},"nullable":true,"type":"array"}},"type":"object"},"JsonNode":{"type":"object"},"MerchantPaymentAccount":{"description":"A MerchantPaymentAccount representing an Account kept by a bank/PSP on behalf of its customer.","properties":{"active":{"description":"Specifies if a MerchantPaymentAccount is active, that means if payments from this account are processed in system.\nMust not be null.","type":"boolean"},"additionallyAcceptedCurrencies":{"description":"List of currencies accepted by the MerchantPaymentAccount in addition to the base currency.\nMust not be null.","items":{"description":"List of currencies accepted by the MerchantPaymentAccount in addition to the base currency.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"type":"array","uniqueItems":true},"country":{"description":"The country where the MerchantPaymentAccount is valid. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.\nMust not be null.","example":"DEU","type":"string"},"currency":{"description":"The currency used for this MerchantPaymentAccount. Must be one of:.\nMust not be null.","example":"EUR","type":"string"},"id":{"description":"Unique id of the MerchantPaymentAccount","format":"int64","nullable":true,"type":"integer"},"ident":{"description":"Unique external reference for the MerchantPaymentAccount.\nMust not be blank.","minLength":1,"type":"string"},"name":{"description":"Merchant payment account name.\nMust not be blank.","minLength":1,"type":"string"},"paymentCollectionConfig":{"$ref":"#/components/schemas/PaymentCollectionConfig"},"paymentServiceProviderId":{"description":"The id of the payment service provider.\nMust not be null.","format":"int64","type":"integer"},"settlementConfig":{"oneOf":[{"$ref":"#/components/schemas/EbicsSettlementConfig"},{"$ref":"#/components/schemas/RestApiSettlementConfig"},{"$ref":"#/components/schemas/SftpSettlementConfig"}]},"settlementSourceId":{"description":"The id of the settlement source","format":"int64","nullable":true,"type":"integer"},"settlementsCreationDisabled":{"description":"Specifies if creation of settlements is disabled for a merchant payment account. When set to true, account statement files\n of this account are loaded from PSP/bank but settlements are not created in NBX.\nMust not be null.","type":"boolean"},"settlementsProcessingSchedule":{"$ref":"#/components/schemas/SettlementsProcessingScheduleDto"}},"required":["active","additionallyAcceptedCurrencies","country","currency","ident","name","paymentCollectionConfig","paymentServiceProviderId","settlementsCreationDisabled"],"type":"object"},"MerchantPaymentAccountInfo":{"description":"A merchant payment account kept by a bank/PSP on behalf of its customer","properties":{"acceptedCurrencies":{"deprecated":true,"description":"DEPRECATED: Please use Field additionallyAcceptedCurrencies. This field was deprecated due to misleading naming compared to the MerchantPaymentAccountDto.","items":{"deprecated":true,"description":"DEPRECATED: Please use Field additionallyAcceptedCurrencies. This field was deprecated due to misleading naming compared to the MerchantPaymentAccountDto.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"nullable":true,"type":"string"},"nullable":true,"type":"array","uniqueItems":true},"additionallyAcceptedCurrencies":{"description":"List of currencies accepted by the MerchantPaymentAccount in addition to the base currency.\nMust not be null.","items":{"description":"List of currencies accepted by the MerchantPaymentAccount in addition to the base currency.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"type":"array","uniqueItems":true},"country":{"description":"The country where the MerchantPaymentAccount is valid. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.\nMust not be null.","example":"DEU","type":"string"},"currency":{"description":"Base currency of a Payment Account. Three letters ISO-4217 format.\nMust not be null.","example":"EUR","type":"string"},"id":{"description":"Deprecated. Legacy attribute.","format":"int64","nullable":true,"type":"integer"},"ident":{"description":"Unique merchant payment account identifier.\nMust not be blank.","minLength":1,"type":"string"},"name":{"description":"Merchant payment account name.\nMust not be blank.","minLength":1,"type":"string"},"paymentProvider":{"description":"One of Payment Provider types supported in Nitrobox.\nMust not be null.\nMust be one of:\n|               |\n| ------------- |\n| ADYEN         |\n| CONTOWORKS    |\n| COMMERZBANK   |\n| GOCARDLESS    |\n| KLARNA        |\n| MOLLIE        |\n| OPTILE        |\n| STRIPE        |\n| VWFS_SMARTPAY |\n| WORLDLINE     |\n| SBA           |\n| OTHER         |","type":"string"},"paymentProviderName":{"description":"The name of the Payment Provider that the account belongs to.\nMust not be blank.","minLength":1,"type":"string"}},"required":["additionallyAcceptedCurrencies","country","currency","ident","name","paymentProvider","paymentProviderName"],"type":"object"},"MerchantPaymentGateway":{"description":"A MerchantPaymentGateway is used to route PaymentIntents to a MerchantPaymentAccount based on the currency.","properties":{"currencyToAccountMapping":{"additionalProperties":{"description":"List of Assignments consisting of a CurrencyCode and an ident of a MerchantPaymentAccount used for routing, e.g. \"PLN\": \"MerchantPaymentAccountIdent\".","nullable":true,"type":"string"},"description":"List of Assignments consisting of a CurrencyCode and an ident of a MerchantPaymentAccount used for routing, e.g. \"PLN\": \"MerchantPaymentAccountIdent\".","nullable":true,"type":"object"},"ident":{"description":"Unique external reference for the MerchantPaymentGateway.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"Name of the MerchantPaymentGateway.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"paymentProvider":{"$ref":"#/components/schemas/PaymentServiceProviderDto"},"paymentServiceProviderId":{"description":"The id of the payment service provider.\nMust not be null.","format":"int64","type":"integer"}},"required":["ident","name","paymentProvider","paymentServiceProviderId"],"type":"object"},"MigrationParametersRequest":{"properties":{"batchSize":{"description":"Migration type.\nMust not be null.\nMust be greater than 0.","format":"int32","type":"integer"},"delayBetweenBatches":{"description":"Delay between batches.\nMust not be null.","type":"string"},"lockAtLeastFor":{"description":"Lock minimum duration.\nMust not be null.","type":"string"},"lockAtMostFor":{"description":"Lock timeout.\nMust not be null.","type":"string"},"tenantIds":{"description":"Tenant ids to migrate","items":{"description":"Tenant ids to migrate","format":"int64","type":"integer"},"type":"array","uniqueItems":true}},"required":["batchSize","delayBetweenBatches","lockAtLeastFor","lockAtMostFor","tenantIds"],"type":"object"},"MigrationStatusDto":{"properties":{"itemsToMigrate":{"description":"Number of items to migrate.\nMust not be null.","format":"int64","type":"integer"},"itemsToSetup":{"description":"Number of items to setup.\nMust not be null.","format":"int64","type":"integer"}},"required":["itemsToMigrate","itemsToSetup"],"type":"object"},"MoneyDto":{"description":"A monetary amount with an amount and a currency.","properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"description":"Currency code. Three letters ISO-4217 format.\nMust not be null.","example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"OutboxEntryResponse":{"description":"Outbox Entry","properties":{"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"deleteAt":{"description":"The delete timestamp","format":"date-time","nullable":true,"type":"string"},"failures":{"description":"Number of failures.\nMust not be null.\nMust be greater than or equal to 0.","format":"int32","minimum":0,"type":"integer"},"id":{"description":"The ID of the outbox entry.\nMust not be null.\nMust not be blank.","minLength":1,"type":"string"},"ident":{"description":"The ident of the outbox entry. An entry does not necessarily require an ident. It serves as a convenience feature only.","nullable":true,"type":"string"},"lastFailureMessage":{"description":"Last failure message","nullable":true,"type":"string"},"nextRetryAt":{"description":"The next retry timestamp","format":"date-time","nullable":true,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/JsonNode"}],"description":"The payload","nullable":true,"type":"object"},"status":{"description":"The status of the outbox entry.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"statusHistory":{"default":[],"description":"The status history.\nMust not be null.","items":{"$ref":"#/components/schemas/StatusHistory"},"type":"array"},"statusTimestamp":{"description":"The timestamp of the last status change.\nMust not be null.","format":"date-time","type":"string"},"tracingAttributes":{"additionalProperties":{"default":"{}","description":"Tracing attributes","type":"string"},"default":{},"description":"Tracing attributes.\nMust not be null.","type":"object"}},"required":["createdAt","failures","id","status","statusHistory","statusTimestamp","tracingAttributes"],"type":"object"},"PageInfo":{"description":"Meta data about the current page and query.","properties":{"number":{"description":"Page number of total pages available.","format":"int32","type":"integer"},"size":{"description":"Size of the page as specified by the query.","format":"int32","type":"integer"},"totalElements":{"description":"Total count of all elements available for the query.","format":"int64","type":"integer"},"totalPages":{"description":"Total count of all pages available for the query.","format":"int32","type":"integer"}},"required":["number","size","totalElements","totalPages"],"type":"object"},"PagedResponseCategorizationRuleResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/CategorizationRuleResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseCustomerPaymentAccountResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/CustomerPaymentAccountResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseJobInfo":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/JobInfo"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseMerchantPaymentAccount":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/MerchantPaymentAccount"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseMerchantPaymentGateway":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/MerchantPaymentGateway"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseOutboxEntryResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OutboxEntryResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponsePaymentCategory":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/PaymentCategory"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponsePaymentIntentDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/PaymentIntentDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponsePaymentIntentTaskDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/PaymentIntentTaskDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponsePaymentTransactionBatchItemDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/PaymentTransactionBatchItemDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponsePaymentTransactionDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/PaymentTransactionDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseSettlement":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/Settlement"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseSettlementReport":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/SettlementReport"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseSettlementReportWithMerchantPaymentAccount":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/SettlementReportWithMerchantPaymentAccount"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PaymentCategory":{"description":"Category which a payment can be classified into.","properties":{"assignable":{"description":"Specifies if a payment of this category can be assigned to an invoice or a creditmemo.\nMust not be null.","type":"boolean"},"default":{"description":"Specifies if a category is a default category, serving as a fallback when a payment is not classified into any of other categories.\nMust not be null.","type":"boolean"},"enabled":{"description":"Specifies if this category is enabled to be used for the tenant's payments.\nMust not be null.","type":"boolean"},"name":{"description":"Unique category name.\nMust not be null.","type":"string"}},"required":["assignable","default","enabled","name"],"type":"object"},"PaymentCategoryDto":{"description":"Category which a payment can be classified into. Category selection has an influence on how the payment is processed further.","nullable":true,"properties":{"assignable":{"description":"Specifies if a payment of this category can be assigned to an invoice or a creditmemo.\nMust not be null.","type":"boolean"},"default":{"description":"Specifies if a category is a default category, serving as a fallback when a payment is not classified into any of other categories.\nMust not be null.","type":"boolean"},"enabled":{"description":"Specifies if this category is enabled to be used for the tenant's payments.\nMust not be null.","type":"boolean"},"id":{"deprecated":true,"description":"DEPRECATED.\nId of the payment category.\nMust not be null.","format":"int64","type":"integer"},"name":{"description":"Unique category name.\nMust not be null.","type":"string"}},"required":["assignable","default","enabled","id","name"],"type":"object"},"PaymentCollectionConfig":{"description":"A PaymentCollectionConfig is used to define the date of the payment collection.","nullable":true,"properties":{"charging":{"description":"Defines when charging shall be triggered.\nMust not be null.\nMust be one of:\n|                      |\n| -------------------- |\n| IMMEDIATELY          |\n| ON_DOCUMENT_DUE_DATE |","example":"IMMEDIATELY","type":"string"},"payout":{"description":"Defines when a payout shall be triggered.\nMust not be null.\nMust be one of:\n|                      |\n| -------------------- |\n| IMMEDIATELY          |\n| ON_DOCUMENT_DUE_DATE |","example":"IMMEDIATELY","type":"string"},"refund":{"description":"Defines when refund shall be triggered.\nMust not be null.\nMust be one of:\n|                      |\n| -------------------- |\n| IMMEDIATELY          |\n| ON_DOCUMENT_DUE_DATE |","example":"IMMEDIATELY","type":"string"}},"required":["charging","payout","refund"],"type":"object"},"PaymentIntentCreationRequest":{"properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"The amount that shall be transferred","type":"object"},"billingGroupIdent":{"description":"An identifier of business segment.\nMust not be null.","type":"string"},"businessSegmentIdent":{"deprecated":true,"description":"An identifier of business segment. DEPRECATED: use billingGroupIdent","nullable":true,"type":"string"},"customerPaymentAccountIdent":{"description":"An unique identifier of CustomerPaymentAccount.\nMust not be null.","type":"string"},"ident":{"description":"An unique identifier of PaymentIntent.\nMust not be null.","type":"string"},"referenceIdent":{"description":"An identifier of the referenced entity.","nullable":true,"type":"string"},"referenceKey":{"deprecated":true,"description":"Type of the referenced entity. Please use referenceType","example":"DOCUMENT","nullable":true,"type":"string"},"referenceType":{"description":"Type of the referenced entity.","example":"DOCUMENT","nullable":true,"type":"string"},"statementDescriptor":{"description":"The descriptor of resulting Statement.","nullable":true,"type":"string"},"type":{"description":"The type of PaymentIntent.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| CHARGING |\n| REFUND   |\n| PAYOUT   |","type":"string"}},"required":["amount","billingGroupIdent","customerPaymentAccountIdent","ident","type"],"type":"object"},"PaymentIntentDetailsDto":{"description":"A PaymentIntent is an intent to move an amount from one account to another within a PSP. The PaymentIntentDetail contains additional CustomerPaymentAccount data.","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount which shall be used for the PaymentIntent","type":"object"},"billingGroupIdent":{"description":"An identifier of a billing group.","nullable":true,"type":"string"},"businessSegmentIdent":{"deprecated":true,"description":"An identifier of business segment. DEPRECATED: use billingGroupIdent","nullable":true,"type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"customerPaymentAccountDto":{"$ref":"#/components/schemas/EmbeddedCustomerPaymentAccountDto"},"dateCreated":{"deprecated":true,"description":"DEPRECATED please use createdAt. Removal planned after 2025-06-01. The date-time format was missing the timezone offset.","format":"date-time","nullable":true,"type":"string"},"dateModified":{"deprecated":true,"description":"DEPRECATED please use lastModifiedAt. Removal planned after 2025-06-01. The date-time format was missing the timezone offset.","format":"date-time","nullable":true,"type":"string"},"ident":{"description":"An identifier of this PaymentIntent.\nMust not be blank.","minLength":1,"type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"merchantPaymentAccount":{"$ref":"#/components/schemas/EmbeddedMerchantPaymentAccountDto"},"paymentIntentResponse":{"description":"Payment intent responses.\nMust not be null.","items":{"$ref":"#/components/schemas/PaymentIntentResponseDto"},"type":"array"},"paymentTransaction":{"allOf":[{"$ref":"#/components/schemas/PaymentTransactionDto"}],"description":"The payment transaction created for this payment intent.","nullable":true,"type":"object"},"referenceIdent":{"description":"An identifier of the referenced entity.","nullable":true,"type":"string"},"referenceKey":{"deprecated":true,"description":"DEPRECATED.\nType of the referenced entity. Please use referenceType","example":"DOCUMENT","nullable":true,"type":"string"},"referenceType":{"description":"Type of the referenced entity.","example":"DOCUMENT","nullable":true,"type":"string"},"statementDescriptor":{"description":"The descriptor to be used for the PaymentIntent.","nullable":true,"type":"string"},"status":{"description":"Current PaymentIntentStatus.\nMust not be null.\nMust be one of:\n|             |\n| ----------- |\n| CREATED     |\n| IN_PROGRESS |\n| RETRY       |\n| FAILED      |\n| SUBMITTED   |\n| CANCELLED   |\n| PROCESSED   |","type":"string"},"type":{"description":"The type of PaymentIntent.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| CHARGING |\n| REFUND   |\n| PAYOUT   |","type":"string"}},"required":["amount","createdAt","customerPaymentAccountDto","ident","lastModifiedAt","merchantPaymentAccount","paymentIntentResponse","status","type"],"type":"object"},"PaymentIntentDto":{"description":"A PaymentIntent is an intent to move an amount from one account to another within a PSP.","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount which used for the PaymentIntent","type":"object"},"billingGroupIdent":{"description":"An identifier of a billing group.","nullable":true,"type":"string"},"businessSegmentIdent":{"deprecated":true,"description":"An identifier of business segment. DEPRECATED: use billingGroupIdent","nullable":true,"type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"customerPaymentAccount":{"$ref":"#/components/schemas/EmbeddedCustomerPaymentAccountDto"},"customerPaymentAccountIdent":{"deprecated":true,"description":"DEPRECATED.\nAn identifier of customer PaymentChargingAccount.","nullable":true,"type":"string"},"dateCreated":{"deprecated":true,"description":"DEPRECATED please use createdAt. Removal planned after 2025-06-01. The date-time format was missing the timezone offset.","format":"date-time","nullable":true,"type":"string"},"dateModified":{"deprecated":true,"description":"DEPRECATED please use lastModifiedAt. Removal planned after 2025-06-01. The date-time format was missing the timezone offset.","format":"date-time","nullable":true,"type":"string"},"ident":{"description":"An identifier of this PaymentIntent.\nMust not be blank.","minLength":1,"type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"merchantPaymentAccount":{"$ref":"#/components/schemas/EmbeddedMerchantPaymentAccountDto"},"merchantPaymentAccountIdent":{"deprecated":true,"description":"DEPRECATED.\nAn unique identifier of the merchants PaymentAccount.","nullable":true,"type":"string"},"paymentIntentResponse":{"description":"Payment intent response.\nMust not be null.","items":{"$ref":"#/components/schemas/PaymentIntentResponseDto"},"type":"array"},"paymentTransaction":{"allOf":[{"$ref":"#/components/schemas/PaymentTransactionDto"}],"description":"The payment transaction created for this payment intent.","nullable":true,"type":"object"},"referenceIdent":{"description":"An identifier of the referenced entity.","nullable":true,"type":"string"},"referenceKey":{"deprecated":true,"description":"DEPRECATED.\nType of the referenced entity. Please use referenceType","example":"DOCUMENT","nullable":true,"type":"string"},"referenceType":{"description":"Type of the referenced entity.","example":"DOCUMENT","nullable":true,"type":"string"},"statementDescriptor":{"description":"The descriptor to be used for the PaymentIntent.","nullable":true,"type":"string"},"status":{"description":"Current PaymentIntentStatus.\nMust not be null.\nMust be one of:\n|             |\n| ----------- |\n| CREATED     |\n| IN_PROGRESS |\n| RETRY       |\n| FAILED      |\n| SUBMITTED   |\n| CANCELLED   |\n| PROCESSED   |","type":"string"},"type":{"description":"The type of PaymentIntent.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| CHARGING |\n| REFUND   |\n| PAYOUT   |","type":"string"}},"required":["amount","createdAt","customerPaymentAccount","ident","lastModifiedAt","merchantPaymentAccount","paymentIntentResponse","status","type"],"type":"object"},"PaymentIntentResponseDto":{"description":"A PaymentIntentResponse is the relayed answer from the PSP to this specific PaymentIntent.","properties":{"baseAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"The amount, that is actually transferred to this account in the accounts base currency. Represented in the same currency as an enclosing payment account.","nullable":true,"type":"object"},"bookingDate":{"description":"The date of the account transaction. ISO 8601 date time format. ","example":"2021-02-25T13:30:22+02:00","format":"date-time","nullable":true,"type":"string"},"categoryName":{"description":"Name of a payment category that this payment is classified to. Category selection have an influence on how the payment is processed further.","example":"BANK_FEE","nullable":true,"type":"string"},"creationDate":{"description":"The date of a creation of a payment. ISO 8601 date time format. ","example":"2021-02-25T13:30:22+02:00","format":"date-time","nullable":true,"type":"string"},"customerSpecificIdent":{"description":"Is an optional customer specific ident, that can be used to identify this payment transaction.","nullable":true,"type":"string"},"exchangeRate":{"description":"Exchange rate used to calculate original and base amounts.","nullable":true,"type":"number"},"externalIdent":{"description":"External reference that needs to be unique within a payment account. Generally it is provided by a Payment Service Provider or a bank.","nullable":true,"type":"string"},"ident":{"description":"Unique identifier of the payment intent response.\nMust not be blank.","minLength":1,"type":"string"},"originalAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"The original amount, that was transferred to this account before converting it to the accounts base currency.Represented in the original currency of a transaction.","nullable":true,"type":"object"},"paymentIntentIdent":{"description":"Identifier of the corresponding payment intent.\nMust not be blank.","minLength":1,"type":"string"},"properties":{"description":"Additional properties returned by the PSP for this payment intent.","items":{"$ref":"#/components/schemas/PropertyDto"},"nullable":true,"type":"array"},"recipient":{"description":"The recipient of the payment transfer","nullable":true,"type":"string"},"retry":{"$ref":"#/components/schemas/PaymentIntentRetry"},"sender":{"description":"The sender of the payment transfer.","nullable":true,"type":"string"},"status":{"description":"Outcome of the processing at the PSP.\nMust not be null.\nMust be one of:\n|           |\n| --------- |\n| SUCCEEDED |\n| FAILED    |\n| INFO      |","type":"string"},"statusMessage":{"description":"Optional message about the outcome of the processing at the PSP.","nullable":true,"type":"string"},"valueDate":{"description":"The date on which the account transaction takes effect. ISO 8601 date time format. ","example":"2021-02-25T13:30:22+02:00","format":"date-time","nullable":true,"type":"string"}},"required":["ident","paymentIntentIdent","status"],"type":"object"},"PaymentIntentRetry":{"description":"Reference to the attempt for the payment intent","nullable":true,"properties":{"final":{"description":"Indicates final retry.\nMust not be null.","type":"boolean"},"ident":{"description":"Unique internal reference to identify this Attempt.\nMust not be blank.","example":"c9414238-8d55-4bcc-8945-e085d1326e2b","minLength":1,"type":"string"}},"required":["final","ident"],"type":"object"},"PaymentIntentScheduleConfigDto":{"properties":{"activePaymentIntentProcesssing":{"description":"Indicates if payment intent processing is active.\nMust not be null.","type":"boolean"},"activePaymentIntentTaskProcessing":{"description":"Indicates if payment intent task processing is active.\nMust not be null.","type":"boolean"}},"required":["activePaymentIntentProcesssing","activePaymentIntentTaskProcessing"],"type":"object"},"PaymentIntentTaskDto":{"description":"A PaymentIntentTask can create a payment intent, depending of its status at the due date.","properties":{"amount":{"description":"Current amount of this PaymentIntentTask. Can change until the due date, depending on other events, e.g., partial creditmemos.\nMust not be null.","type":"number"},"billingGroupIdent":{"description":"BillingGroupIdent related to this PaymentIntentTask.\nMust not be null.","type":"string"},"creationDate":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"creditDebitIndicator":{"description":"CreditDebitIndicator of this PaymentIntentTask.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| CREDIT |\n| DEBIT  |","type":"string"},"currency":{"description":"Currency of this PaymentIntentTask.\nMust not be null.","type":"string"},"customerPaymentAccountIdent":{"description":"CustomerPaymentAccountIdent which will be used for the resulting PaymentIntent.\nMust not be null.","type":"string"},"dueDate":{"description":"Due date of this PaymentIntentTask. The Date on which the Payment Intent will be created if the status is still fine.","format":"date","nullable":true,"type":"string"},"ident":{"description":"An identifier of this PaymentIntentTask.\nMust not be null.","type":"string"},"oposCaseIdent":{"description":"OposCase Ident related to this PaymentIntentTask.\nMust not be null.","type":"string"},"oposCaseVersion":{"description":"latest known Version of the OposCase related to this PaymentIntentTask.\nMust not be null.","format":"int64","type":"integer"},"paymentIntentIdent":{"description":"Ident of the PaymentIntent, if a paymentIntent was created on due date.","nullable":true,"type":"string"},"paymentIntentType":{"description":"Resulting PaymentIntentType.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| CHARGING |\n| REFUND   |\n| PAYOUT   |","type":"string"},"referenceIdent":{"description":"Current referenced ident of this PaymentIntentTask.\nMust not be null.","type":"string"},"referenceType":{"description":"Current referenced type of this PaymentIntentTask.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| DOCUMENT |","type":"string"},"status":{"description":"Current status of this PaymentIntentTask.\nMust not be null.\nMust be one of:\n|                      |                                                             |\n| -------------------- | ----------------------------------------------------------- |\n| WAITING_FOR_DUE_DATE | Payment Intent will be created when the due date is reached |\n| PROCESSED            | Payment Intent was created                                  |\n| FAILED               | Payment Intent creation failed                              |\n| CANCELLED            | Payment Intent creation cancelled                           |","type":"string"},"version":{"description":"Current version of this PaymentIntentTask.\nMust not be null.","format":"int64","type":"integer"}},"required":["amount","billingGroupIdent","creationDate","creditDebitIndicator","currency","customerPaymentAccountIdent","dueDate","ident","oposCaseIdent","oposCaseVersion","paymentIntentType","referenceIdent","referenceType","status","version"],"type":"object"},"PaymentIntentTaskUpdateDto":{"description":"A PaymentIntentTask can create a payment intent, depending of its status at the due date.","properties":{"customerPaymentAccountIdent":{"description":"CustomerPaymentAccountIdent which will be used for the resulting PaymentIntent.\nMust not be blank.","minLength":1,"type":"string"},"dueDate":{"description":"Due date of this PaymentIntentTask. The Date on which the Payment Intent will be created if the status is still fine.\nMust not be null.\nMust be in the future or present.","format":"date-time","type":"string"}},"required":["customerPaymentAccountIdent","dueDate"],"type":"object"},"PaymentServiceProviderDto":{"properties":{"id":{"description":"Id of the payment service provider","format":"int64","nullable":true,"type":"integer"},"name":{"description":"Name of the payment service provider.\nMust not be blank.","minLength":1,"type":"string"},"settlementSources":{"description":"Settlement sources","items":{"oneOf":[{"$ref":"#/components/schemas/SettlementSource"},{"$ref":"#/components/schemas/EbicsSettlementSource"},{"$ref":"#/components/schemas/SftpSettlementSource"}]},"nullable":true,"type":"array"},"type":{"description":"Type of the payment service provider.\nMust not be null.\nMust be one of:\n|               |\n| ------------- |\n| ADYEN         |\n| CONTOWORKS    |\n| COMMERZBANK   |\n| GOCARDLESS    |\n| KLARNA        |\n| MOLLIE        |\n| OPTILE        |\n| STRIPE        |\n| VWFS_SMARTPAY |\n| WORLDLINE     |\n| SBA           |\n| OTHER         |","type":"string"}},"required":["name","type"],"type":"object"},"PaymentTransactionBatchItemDto":{"description":"Result list.","properties":{"assignmentStatus":{"description":"The status describing whether a batch item is assigned to any document.\nMust not be null.\nMust be one of:\n|                     |\n| ------------------- |\n| UNASSIGNED          |\n| COMPLETELY_ASSIGNED |","type":"string"},"baseAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount of money paid with this batch item. Must match settlement item or transaction base currency, otherwise the settlement item wil be rejected","type":"object"},"creditDebitIndicator":{"description":"A description, whether this batch item is a DEBIT, removing money from the account or a CREDIT, adding money to the account.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| CREDIT |\n| DEBIT  |","example":"DEBIT","type":"string"},"ident":{"description":"Unique identifier of a batch item.\nMust not be blank.","minLength":1,"type":"string"},"originalAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount of money paid with this batch item. Represented in the original currency of a transaction. In case original currency is different than the base currency, an exchange rate must also be provided, otherwise the settlement item will be rejected. When original amount is not provided in a request, Batch item is created with original amount equal to the base amount.","nullable":true,"type":"object"},"properties":{"description":"Key-value-pairs of properties of a batch item - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"},"nullable":true,"type":"array"},"text":{"description":"Any additional information about a batch item like purpose, description, payment title, etc.\nMust not be null.","type":"string"}},"required":["assignmentStatus","baseAmount","creditDebitIndicator","ident","text"],"type":"object"},"PaymentTransactionBatchItemsRequestDto":{"properties":{"batchItems":{"description":"List of batch items that will be updated","items":{"$ref":"#/components/schemas/BatchItemRequestDto"},"nullable":true,"type":"array"}},"type":"object"},"PaymentTransactionCreatedDto":{"properties":{"assignableLeftoverAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"The part of a payment amount, that is actually not yet assigned to any document.","type":"object"},"assignmentStatus":{"description":"The status describing whether a payment is assigned to any document.\nMust not be null.\nMust be one of:\n|                     |\n| ------------------- |\n| UNASSIGNED          |\n| PARTIALLY_ASSIGNED  |\n| COMPLETELY_ASSIGNED |","type":"string"},"baseAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"The amount, that is actually transferred to this account in the accounts base currency. Represented in the same currency as an enclosing payment account.","type":"object"},"batchItems":{"description":"List of the batchItems linked to the transaction.\nMust not be null.","items":{"$ref":"#/components/schemas/PaymentTransactionBatchItemDto"},"type":"array"},"bookingDate":{"description":"The date of the account transaction. ISO 8601 date time format.\nMust not be null.","example":"2021-02-25T13:30:22+02:00","format":"date-time","type":"string"},"creationDate":{"description":"The date of a creation of a payment. ISO 8601 date time format. ","example":"2021-02-25T13:30:22+02:00","format":"date-time","nullable":true,"type":"string"},"creditDebitIndicator":{"description":"A description, whether this payment transaction is a DEBIT, removing money from the account or a CREDIT, adding money to the account.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| CREDIT |\n| DEBIT  |","example":"DEBIT","type":"string"},"customerSpecificIdent":{"description":"Is an optional customer specific ident, that can be used to identify this payment transaction.","example":"2593935f-cf9a-4a53-b754-ee92d91b82ef","nullable":true,"type":"string"},"exchangeRate":{"$ref":"#/components/schemas/ExchangeRateDto"},"externalIdent":{"description":"External reference that needs to be unique within a payment account. Generally it is provided by a Payment Service Provider or a bank.\nMust not be blank.","example":"2593935f-cf9a-4a53-b754-ee92d91b82ef","minLength":1,"type":"string"},"fees":{"description":"Any fees imposed on this payment.","items":{"$ref":"#/components/schemas/PaymentTransactionFeeDto"},"nullable":true,"type":"array"},"history":{"description":"History of this payment transaction.\nMust not be null.","items":{"$ref":"#/components/schemas/PaymentTransactionHistory"},"type":"array"},"ident":{"description":"An identifier of a payment transaction generated by Nitrobox.\nMust not be blank.","minLength":1,"type":"string"},"originalAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"The original amount, that was transferred to this account before converting it to the accounts base currency.Represented in the original currency of a transaction.","type":"object"},"paymentCategory":{"description":"Name of a payment category that this payment is classified to. Category selection have an influence on how the payment is processed further.","example":"BANK_FEE","nullable":true,"type":"string"},"properties":{"description":"Key-Value-Pairs of properties of a settlement - i.e. 'GVC':'166'.\nMust not be null.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"recipient":{"description":"The recipient of the payment transfer","nullable":true,"type":"string"},"sender":{"description":"The sender of the payment transfer.","nullable":true,"type":"string"},"status":{"description":"The status this payment transaction is in.\nMust not be null.\nMust be one of:\n|                |\n| -------------- |\n| RECEIVED       |\n| ERROR          |\n| REFUSED        |\n| AUTHORIZED     |\n| EXPIRED        |\n| CANCELLED      |\n| CAPTURED       |\n| CAPTURE_FAILED |\n| SETTLED        |\n| REFUNDED       |\n| CHARGEBACK     |","example":"CAPTURED","type":"string"},"text":{"description":"Any additional information about a payment like purpose, description, payment title, etc. This is often used for matching the payment to a document.","nullable":true,"type":"string"},"valueDate":{"description":"The date on which the account transaction takes effect. ISO 8601 date time format. ","example":"2021-02-25T13:30:22+02:00","format":"date-time","nullable":true,"type":"string"}},"required":["assignableLeftoverAmount","assignmentStatus","baseAmount","batchItems","bookingDate","creditDebitIndicator","externalIdent","fees","history","ident","originalAmount","paymentCategory","properties","recipient","sender","status","text","valueDate"],"type":"object"},"PaymentTransactionDto":{"description":"A payment transaction describes a financial transaction that happened on a payment account.","properties":{"assignableLeftoverAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"The part of a payment amount, that is actually not yet assigned to any document.","type":"object"},"assignmentStatus":{"description":"The status describing whether a payment is assigned to any document.\nMust be one of:\n|                     |\n| ------------------- |\n| UNASSIGNED          |\n| PARTIALLY_ASSIGNED  |\n| COMPLETELY_ASSIGNED |","nullable":true,"type":"string"},"baseAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"The amount, that is actually transferred to this account in the accounts base currency. Represented in the same currency as an enclosing payment account.","type":"object"},"batchItems":{"description":"Batch items of this transaction","items":{"$ref":"#/components/schemas/PaymentTransactionBatchItemDto"},"nullable":true,"type":"array"},"bookingDate":{"description":"The date of the account transaction. ISO 8601 date time format.\nMust not be null.","example":"2021-02-25T13:30:22+02:00","format":"date-time","type":"string"},"category":{"$ref":"#/components/schemas/PaymentCategoryDto"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"creationDate":{"description":"The date of a creation of a payment. ISO 8601 date time format. ","example":"2021-02-25T13:30:22+02:00","format":"date-time","nullable":true,"type":"string"},"creditDebitIndicator":{"description":"A description, whether this payment transaction is a DEBIT, removing money from the account or a CREDIT, adding money to the account.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| CREDIT |\n| DEBIT  |","example":"DEBIT","type":"string"},"customerSpecificIdent":{"description":"Is an optional customer specific ident, that can be used to identify this payment transaction.","example":"2593935f-cf9a-4a53-b754-ee92d91b82ef","nullable":true,"type":"string"},"data":{"deprecated":true,"description":"DEPRECATED.\nDeprecated. Legacy attribute.","nullable":true,"type":"string"},"exchangeRate":{"$ref":"#/components/schemas/ExchangeRateDto"},"externalIdent":{"description":"External reference that needs to be unique within a payment account. Generally it is provided by a Payment Service Provider or a bank.","example":"2593935f-cf9a-4a53-b754-ee92d91b82ef","nullable":true,"type":"string"},"fees":{"description":"Any fees imposed on this payment.","items":{"$ref":"#/components/schemas/PaymentTransactionFeeDto"},"nullable":true,"type":"array"},"history":{"description":"History of this payment transaction.\nMust not be null.","items":{"$ref":"#/components/schemas/PaymentTransactionHistory"},"type":"array"},"id":{"description":"Deprecated. Legacy attribute.","format":"int64","nullable":true,"type":"integer"},"ident":{"description":"An identifier of a payment transaction generated by Nitrobox.\nMust not be blank.","minLength":1,"type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"merchantPaymentAccount":{"$ref":"#/components/schemas/MerchantPaymentAccountInfo"},"originalAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"The original amount, that was transferred to this account before converting it to the accounts base currency.                    Represented in the original currency of a transaction.","nullable":true,"type":"object"},"paymentAccount":{"allOf":[{"$ref":"#/components/schemas/MerchantPaymentAccountInfo"}],"deprecated":true,"description":"A merchant payment account kept by a bank/PSP on behalf of its customer. Please use merchantPaymentAccount.","nullable":true,"type":"object"},"paymentDescription":{"description":"Any additional information about a payment like purpose, description, payment title, etc. This is often used for matching the payment to a document.","nullable":true,"type":"string"},"paymentIntentIdent":{"description":"Payment intent ident, if a Payment was created out of this payment intent otherwise empty.","nullable":true,"type":"string"},"paymentStatus":{"description":"The status this payment transaction is in.\nMust not be null.\nMust be one of:\n|                |\n| -------------- |\n| RECEIVED       |\n| ERROR          |\n| REFUSED        |\n| AUTHORIZED     |\n| EXPIRED        |\n| CANCELLED      |\n| CAPTURED       |\n| CAPTURE_FAILED |\n| SETTLED        |\n| REFUNDED       |\n| CHARGEBACK     |","example":"CAPTURED","type":"string"},"previousCategory":{"$ref":"#/components/schemas/PaymentCategoryDto"},"properties":{"description":"Key-Value-Pairs of properties of a settlement - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"},"nullable":true,"type":"array"},"recipient":{"description":"The recipient of the payment transfer","nullable":true,"type":"string"},"sender":{"description":"The sender of the payment transfer.","nullable":true,"type":"string"},"settlementCustomerSpecificIdent":{"description":"Is an optional customer specific ident, that can be used to identify the settlement connected to this payment transaction.","example":"2593935f-cf9a-4a53-b754-ee92d91b82ef","nullable":true,"type":"string"},"settlementIdent":{"description":"Unique identifier of a settlement, connected to this payment transaction, autogenerated by Nitrobox.","nullable":true,"type":"string"},"statementReference":{"deprecated":true,"description":"DEPRECATED.\nDeprecated. Legacy attribute.","nullable":true,"type":"string"},"tenantId":{"description":"Deprecated. Legacy attribute.","format":"int32","nullable":true,"type":"integer"},"valueDate":{"description":"The date on which the account transaction takes effect. ISO 8601 date time format.\nMust not be null.","example":"2021-02-25T13:30:22+02:00","format":"date-time","type":"string"}},"required":["assignableLeftoverAmount","baseAmount","bookingDate","createdAt","creditDebitIndicator","history","ident","lastModifiedAt","merchantPaymentAccount","paymentStatus","valueDate"],"type":"object"},"PaymentTransactionFeeDto":{"properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount of money paid for this fee","type":"object"},"description":{"description":"The description of the payment transaction fee","nullable":true,"type":"string"},"id":{"description":"The id of the payment transaction fee","format":"int64","nullable":true,"type":"integer"},"type":{"description":"Type of the payment transaction fee.\nMust not be null.\nMust be one of:\n|              |\n| ------------ |\n| COMMISSION   |\n| MARKUP       |\n| SCHEME_FEES  |\n| INTERCHANGE  |\n| STANDARD_FEE |","type":"string"}},"required":["amount","type"],"type":"object"},"PaymentTransactionHistory":{"description":"Entry in the history of a payment transaction","properties":{"changeDate":{"description":"Date of the change.\nMust not be null.","format":"date-time","type":"string"},"status":{"description":"The status this payment transaction was in.\nMust not be null.\nMust be one of:\n|                |\n| -------------- |\n| RECEIVED       |\n| ERROR          |\n| REFUSED        |\n| AUTHORIZED     |\n| EXPIRED        |\n| CANCELLED      |\n| CAPTURED       |\n| CAPTURE_FAILED |\n| SETTLED        |\n| REFUNDED       |\n| CHARGEBACK     |","example":"CAPTURED","type":"string"}},"required":["changeDate","status"],"type":"object"},"PropertyDto":{"description":"A property is a key-value pair that can be used to extend the entity with additional custom data as needed.","properties":{"propertyIdent":{"description":"Key of the property.\nMust not be blank.","minLength":1,"type":"string"},"propertyValue":{"description":"Value of the property.\nMust not be null.","type":"string"}},"required":["propertyIdent","propertyValue"],"type":"object"},"RestApiSettlementConfig":{"allOf":[{"$ref":"#/components/schemas/SettlementConfig"},{"properties":{"oauthClientId":{"type":"string"}},"type":"object"}],"description":"REST API settlement source that except standard properties contains also oauthClientId.","nullable":true,"required":["id","protocolType","settlementSourceId"],"type":"object"},"Settlement":{"description":"Settlement response body.","properties":{"baseAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount of money paid with this settlement.","type":"object"},"batchItems":{"description":"Batch items of this settlement.\nMust not be null.","items":{"$ref":"#/components/schemas/SettlementBatchItemResponseDto"},"type":"array"},"bookingDate":{"description":"The date of the account transaction, in UTC. ISO 8601 date time format. E.g. 2021-03-19T13:34:01Z.\nMust not be null.","format":"date-time","type":"string"},"creationDate":{"description":"The date of a creation of a settlement, in UTC. ISO 8601 date time format. E.g. 2021-03-19T13:34:01Z.","format":"date-time","nullable":true,"type":"string"},"creditDebitIndicator":{"description":"Indicates whether a settlement is a DEBIT or CREDIT.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| CREDIT |\n| DEBIT  |","type":"string"},"customerSpecificIdent":{"description":"An additional identifier, provided by Nitrobox according to tenant specific rules.","nullable":true,"type":"string"},"exchangeRate":{"description":"Exchange rate of an original currency to the base currency. The rate should fulfill following calculation: originalAmount / exchangeRate = baseAmount.","nullable":true,"type":"number"},"externalIdent":{"description":"A settlement identifier, unique within a payment account. May be provided by a PSP or autogenerated by Nitrobox.\nMust not be blank.","minLength":1,"type":"string"},"fees":{"description":"Any fees imposed on this settlement.\nMust not be null.","items":{"$ref":"#/components/schemas/Fee"},"type":"array"},"id":{"deprecated":true,"description":"DEPRECATED.\nDatabase identifier of a settlement, autogenerated by Nitrobox.","format":"int64","nullable":true,"type":"integer"},"ident":{"description":"Unique identifier of a settlement, autogenerated by Nitrobox.\nMust not be null.","type":"string"},"merchantPaymentAccountId":{"deprecated":true,"description":"DEPRECATED.\nDatabase identifier of a payment account that this settlement belongs to.","format":"int64","nullable":true,"type":"integer"},"merchantPaymentAccountIdent":{"description":"The ident of the merchant payment account.\nMust not be blank.","minLength":1,"type":"string"},"merchantPaymentAccountName":{"description":"The name of the merchant payment account.\nMust not be blank.","minLength":1,"type":"string"},"originalAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount of money paid with this settlement expressed in the original currency of a transaction.","type":"object"},"paymentCategory":{"deprecated":true,"description":"DEPRECATED.\nName of a payment category this settlement is classified to.","nullable":true,"type":"string"},"paymentTransactionIdent":{"description":"An identifier of a payment transaction which is settled with this settlement.","nullable":true,"type":"string"},"properties":{"description":"Key-Value-Pairs of properties of a settlement - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"},"nullable":true,"type":"array"},"recipient":{"description":"Information about the recipient of a settlement.","nullable":true,"type":"string"},"sender":{"description":"Information about the sender of a settlement.","nullable":true,"type":"string"},"settlementFileId":{"description":"Database identifier of a settlement report this settlement is a part of.","format":"int64","nullable":true,"type":"integer"},"settlementItemIdentifier":{"description":"In case the settlement report which is a source of this settlement, is of a more complex format (e.g. XML file),the settlement item identifier should allow to unambiguously specify a place of a settlement in this document.","nullable":true,"type":"string"},"settlementLineNumber":{"description":"In case the settlement report which is a source of this settlement, is a simple entry based document (e.g. CSV file), the settlement line number should specify a particular line where the settlement is placed in the file.","format":"int32","nullable":true,"type":"integer"},"settlementReportIdent":{"description":"An identifier of a settlement report this settlement is a part of.","nullable":true,"type":"string"},"statementCreationDate":{"description":"DEPRECATED! WILL BE REMOVED!","format":"date-time","nullable":true,"type":"string"},"statementReference":{"description":"DEPRECATED! WILL BE REMOVED!","nullable":true,"type":"string"},"statementReferenceType":{"description":"DEPRECATED! WILL BE REMOVED!.\nMust be one of:\n|                                |\n| ------------------------------ |\n| BATCH_NR                       |\n| BATCH_ID                       |\n| FILE_NAME                      |\n| SINGLE_SETTLEMENT_STATEMENT_ID |\n| STMT_ID                        |","nullable":true,"type":"string"},"text":{"description":"Any additional information about a settlement like purpose, description, payment title, etc.","nullable":true,"type":"string"},"valueDate":{"description":"The date on which the account transaction takes effect, in UTC. ISO 8601 date time format. E.g. 2021-03-19T13:34:01Z.","format":"date-time","nullable":true,"type":"string"}},"required":["baseAmount","batchItems","bookingDate","creditDebitIndicator","externalIdent","fees","ident","merchantPaymentAccountIdent","merchantPaymentAccountName","originalAmount"],"type":"object"},"SettlementBatchItemDto":{"description":"Sub items that are batched together in this settlement item. If specified, their sum must match the settlement item.","nullable":true,"properties":{"baseAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount of money paid with this batch item. Must match settlement item or transaction base currency, otherwise the settlement item wil be rejected","type":"object"},"creditDebitIndicator":{"description":"A description, whether this batch item is a DEBIT, removing money from the account or a CREDIT, adding money to the account.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| CREDIT |\n| DEBIT  |","example":"DEBIT","type":"string"},"externalIdent":{"description":"A settlement batch item identifier, unique within a payment account. May be provided by a PSP.","nullable":true,"type":"string"},"ident":{"description":"Unique identifier of a batch item. Will be set automatically if not provided","nullable":true,"type":"string"},"originalAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount of money paid with this batch item. Represented in the original currency of a transaction. In case original currency is different than the base currency, an exchange rate must also be provided, otherwise the settlement item will be rejected. When original amount is not provided in a request, Batch item is created with original amount equal to the base amount.","nullable":true,"type":"object"},"properties":{"description":"Key-value-pairs of properties of a batch item - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"},"nullable":true,"type":"array"},"recipient":{"description":"Information about the recipient of a batch item.","nullable":true,"type":"string"},"reportIdentifier":{"description":"In case the settlement report which is a source of this batch item, is of a more complex format (e.g. XML file),the report identifier should allow to unambiguously specify a place of a settlement in this document.","nullable":true,"type":"string"},"reportLineNumber":{"description":"In case the settlement report which is a source of this batch item, is a simple entry based document (e.g. CSV file), the report line number should specify a particular line where the batch item is placed in the file.","format":"int32","nullable":true,"type":"integer"},"sender":{"description":"Information about the sender of a batch item.","nullable":true,"type":"string"},"text":{"description":"Any additional information about a batch item like purpose, description, payment title, etc.","nullable":true,"type":"string"}},"required":["baseAmount","creditDebitIndicator"],"type":"object"},"SettlementBatchItemResponseDto":{"description":"Batch items of this settlement","properties":{"baseAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount of money paid with this batch item. Must match settlement item or transaction base currency, otherwise the settlement item wil be rejected","type":"object"},"creditDebitIndicator":{"description":"A description, whether this batch item is a DEBIT, removing money from the account or a CREDIT, adding money to the account.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| CREDIT |\n| DEBIT  |","example":"DEBIT","type":"string"},"externalIdent":{"description":"A settlement batch item identifier, unique within a payment account. May be provided by a PSP.","nullable":true,"type":"string"},"ident":{"description":"Unique identifier of a batch item.\nMust not be blank.","minLength":1,"type":"string"},"originalAmount":{"allOf":[{"$ref":"#/components/schemas/MoneyDto"}],"description":"An amount of money paid with this batch item. Represented in the original currency of a transaction. In case original currency is different than the base currency, an exchange rate must also be provided, otherwise the settlement item will be rejected. When original amount is not provided in a request, Batch item is created with original amount equal to the base amount.","nullable":true,"type":"object"},"properties":{"description":"Key-value-pairs of properties of a batch item - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"},"nullable":true,"type":"array"},"recipient":{"description":"Information about the recipient of a batch item.","nullable":true,"type":"string"},"reportIdentifier":{"description":"      In case the settlement report which is a source of this batch item, is of a more complex format (e.g. XML file),      the report identifier should allow to unambiguously specify a place of a settlement in this document.","nullable":true,"type":"string"},"reportLineNumber":{"description":"      In case the settlement report which is a source of this batch item, is a simple entry based document (e.g. CSV       file), the report line number should specify a particular line where the batch item is placed in the file.","format":"int32","nullable":true,"type":"integer"},"sender":{"description":"Information about the sender of a batch item.","nullable":true,"type":"string"},"text":{"description":"Any additional information about a batch item like purpose, description, payment title, etc.\nMust not be null.","type":"string"}},"required":["baseAmount","creditDebitIndicator","ident","text"],"type":"object"},"SettlementConfig":{"description":"A SettlementConfig is a configuration of an access to the source of settlements in payment provider. Usually containsinformation like username, password, ftp directory, etc.\nThe configuration may contain different properties for different protocols. The supported protocols are Sftp and Ebics.","discriminator":{"mapping":{"EBICS":"#/components/schemas/EbicsSettlementConfig","REST":"#/components/schemas/RestApiSettlementConfig","SFTP":"#/components/schemas/SftpSettlementConfig"},"propertyName":"protocolType"},"properties":{"id":{"description":"Unique id of the SettlementConfig.\nMust not be null.","format":"int64","type":"integer"},"protocolType":{"description":"Protocol type of this SettlementConfig.\nMust not be null.\nMust be one of:\n|       |\n| ----- |\n| EBICS |\n| SFTP  |\n| HTTP  |","type":"string"},"settlementSourceId":{"description":"The settlement source id.\nMust not be null.","format":"int64","type":"integer"}},"required":["id","protocolType","settlementSourceId"],"type":"object"},"SettlementIdentConfigurationDto":{"properties":{"counters":{"description":"The counters of the settlement ident configuration","items":{"$ref":"#/components/schemas/SettlementIdentCounterDto"},"nullable":true,"type":"array","uniqueItems":true},"generationMode":{"description":"The generation mode of the settlement ident configuration.\nMust not be null.\nMust be one of:\n|                     |\n| ------------------- |\n| COUNTER_BY_CURRENCY |\n| SIMPLE_COUNTER      |\n| NO_IDENT            |","type":"string"}},"required":["generationMode"],"type":"object"},"SettlementIdentCounterDto":{"properties":{"maxValue":{"description":"Maximum value that this counter may reach.\nMust not be null.","format":"int64","type":"integer"},"minValue":{"description":"Minimum value, will be used as a starting value for a counter.\nMust not be null.","format":"int64","type":"integer"},"name":{"description":"Unique counter name.\nMust not be blank.","minLength":1,"type":"string"},"nextValue":{"description":"Next value that will be returned from a counter.\nMust not be null.","format":"int64","type":"integer"},"settlementAttributeValue":{"description":"The settlement attribute value","nullable":true,"type":"string"}},"required":["maxValue","minValue","name","nextValue"],"type":"object"},"SettlementReport":{"description":"Settlement report response body.","properties":{"fileName":{"description":"Unique filename of the settlement statement provided by a Payment Service Provider or a bank.\nMust not be null.","type":"string"},"ident":{"description":"Unique settlement report identifier, generated by Nitrobox.\nMust not be null.","type":"string"},"processed":{"description":"Status if the settlement report content could be split into settlement items.","nullable":true,"type":"boolean"},"statementCreationDate":{"description":"A date when the settlement statement was created by a Payment Service Provider or a bank.","format":"date-time","nullable":true,"type":"string"},"statementReference":{"description":"Unique business pointer to the settlement statement provided by a Payment Service Provider or a bank. In case of some PSPs may be identical to the filename.","nullable":true,"type":"string"}},"required":["fileName","ident"],"type":"object"},"SettlementReportRestartedDto":{"properties":{"restartedSettlementReports":{"description":"List of settlement reports that where restarted.","items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"SettlementReportWithMerchantPaymentAccount":{"description":"Settlement report response body extended by the associated merchant payment account.","properties":{"fileName":{"description":"Unique filename of the settlement statement provided by a Payment Service Provider or a bank.\nMust not be null.","type":"string"},"ident":{"description":"Unique settlement report identifier, generated by Nitrobox.\nMust not be blank.","minLength":1,"type":"string"},"merchantPaymentAccount":{"$ref":"#/components/schemas/MerchantPaymentAccountInfo"},"processed":{"description":"Status if the settlement report content could be split into settlement items.","nullable":true,"type":"boolean"},"statementCreationDate":{"description":"A date when the settlement statement was created by a Payment Service Provider or a bank.","format":"date-time","nullable":true,"type":"string"},"statementReference":{"description":"Unique business pointer to the settlement statement provided by a Payment Service Provider or a bank. In case of some PSPs may be identical to the filename.","nullable":true,"type":"string"}},"required":["fileName","ident","merchantPaymentAccount"],"type":"object"},"SettlementSource":{"description":"A settlement source is a configuration of settlements provider, usually it is a server configuration like host, port etc.\nThe configuration may contain different properties for different protocols. The supported protocols are Sftp and Ebics.","discriminator":{"mapping":{"EBICS":"#/components/schemas/EbicsSettlementSource","SFTP":"#/components/schemas/SftpSettlementSource"},"propertyName":"protocolType"},"properties":{"fileType":{"description":"Extension of files that are fetched from the source.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| CSV    |\n| EPA    |\n| CAMT53 |\n| CAMT54 |\n| MT940  |","type":"string"},"host":{"description":"Host of the source server.\nMust not be blank.","minLength":1,"type":"string"},"id":{"description":"Id of the settlement source.\nMust not be null.","format":"int64","type":"integer"},"name":{"description":"Human readable name.\nMust not be null.","type":"string"},"port":{"description":"Port of the source server.\nMust not be blank.","format":"int32","type":"integer"},"protocolType":{"description":"Protocol type of this settlement source.\nMust not be null.\nMust be one of:\n|       |\n| ----- |\n| EBICS |\n| SFTP  |\n| HTTP  |","type":"string"}},"required":["fileType","host","id","name","port","protocolType"],"type":"object"},"SettlementsProcessingScheduleDto":{"description":"A schedule specifying the time when settlement statements from this account will be loaded from PSP and processed.","nullable":true,"properties":{"cronExpression":{"description":"The cron expression specifies when the settlements are loaded.\nMust not be blank.","minLength":1,"type":"string"}},"required":["cronExpression"],"type":"object"},"SftpSettlementConfig":{"allOf":[{"$ref":"#/components/schemas/SettlementConfig"},{"properties":{"credentials":{"$ref":"#/components/schemas/CredentialsDto"},"remoteDirectory":{"description":"Must not be empty.","minLength":1,"type":"string"}},"type":"object"}],"description":"Sftp settlement source that except standard properties contains also path to remote directory on the server.","nullable":true,"required":["id","protocolType","remoteDirectory","settlementSourceId"],"type":"object"},"SftpSettlementSource":{"allOf":[{"$ref":"#/components/schemas/SettlementSource"}],"description":"Sftp settlement source that except standard properties contains also path to remote directory on the server.","required":["fileType","host","id","name","port","protocolType"],"type":"object"},"ShedlockDto":{"properties":{"lockUntil":{"description":"Lock until.\nMust not be null.","format":"date-time","type":"string"},"lockedAt":{"description":"Lock at.\nMust not be null.","format":"date-time","type":"string"},"lockedBy":{"description":"Lock by.\nMust not be blank.","minLength":1,"type":"string"},"name":{"description":"Name of the lock.\nMust not be blank.","minLength":1,"type":"string"}},"required":["lockUntil","lockedAt","lockedBy","name"],"type":"object"},"StatisticsResponse":{"properties":{"groupedBy":{"description":"The group by value of the statistic","nullable":true,"type":"object"},"value":{"description":"The value of the statistic","nullable":true,"type":"object"}},"type":"object"},"StatusHistory":{"description":"Status history entry","properties":{"status":{"description":"The status.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"timestamp":{"description":"The timestamp when the status occurred.\nMust not be null.","format":"date-time","type":"string"}},"required":["status","timestamp"],"type":"object"},"SummarizedResultSummarizedSettlementReportByMerchantPaymentAccountDto":{"description":"Structure representing a summarized result containing values and totals","properties":{"creditTotalAmount":{"description":"The total credit amount over all items.\nMust not be null.","example":2000,"type":"number"},"currency":{"description":"The currency used for all amount field in the response.\nMust not be null.","example":"EUR","type":"string"},"debitTotalAmount":{"description":"The total debit amount over all items.\nMust not be null.","example":2000,"type":"number"},"values":{"description":"Lists all values that have been summarized.\nMust not be null.","example":200,"items":{"$ref":"#/components/schemas/SummarizedSettlementReportByMerchantPaymentAccountDto"},"type":"array"}},"required":["creditTotalAmount","currency","debitTotalAmount","values"],"type":"object"},"SummarizedSettlementReportByMerchantPaymentAccountDto":{"description":"Lists all values that have been summarized","example":200,"properties":{"creditTotalAmount":{"description":"The total credit amount over all items.\nMust not be null.","example":2000,"type":"number"},"currency":{"description":"The currency used for all amount field in the response.\nMust not be null.","example":"EUR","type":"string"},"debitTotalAmount":{"description":"The total debit amount over all items.\nMust not be null.","example":2000,"type":"number"},"merchantPaymentAccountIdent":{"description":"The ident of the merchant payment account.\nMust not be null.","type":"string"},"merchantPaymentAccountName":{"description":"The name of the merchant payment account.\nMust not be null.","type":"string"},"values":{"description":"Lists all values that have been summarized.\nMust not be null.","example":200,"items":{"$ref":"#/components/schemas/SummarizedSettlementReportDto"},"type":"array"}},"required":["creditTotalAmount","currency","debitTotalAmount","merchantPaymentAccountIdent","merchantPaymentAccountName","values"],"type":"object"},"SummarizedSettlementReportDto":{"description":"Lists all values that have been summarized","example":200,"properties":{"creditAmount":{"description":"credit total for item.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":2000,"type":"number"},"debitAmount":{"description":"debit total for item.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":2000,"type":"number"},"fileName":{"description":"Unique filename of the settlement statement provided by a Payment Service Provider or a bank.\nMust not be null.","type":"string"},"settlementReportIdent":{"description":"Ident of the settlement report.\nMust not be null.","type":"string"},"statementCreationDate":{"description":"A date when the settlement statement was created by a Payment Service Provider or a bank.\nMust not be null.","format":"date-time","type":"string"},"totalCount":{"description":"total count of item.\nMust not be null.","example":200,"format":"int64","type":"integer"}},"required":["creditAmount","debitAmount","fileName","settlementReportIdent","statementCreationDate","totalCount"],"type":"object"},"TenantId":{"properties":{"value":{"description":"The tenant id.\nMust not be null.","format":"int32","type":"integer"}},"required":["value"],"type":"object"},"TriggerInfo":{"description":"The job triggers","nullable":true,"properties":{"cronExpression":{"description":"Cron expression of the trigger","nullable":true,"type":"string"},"nextFireTime":{"description":"Time when the trigger will fire","format":"date-time","nullable":true,"type":"string"},"previousFireTime":{"description":"Time when the trigger previously fired","format":"date-time","nullable":true,"type":"string"}},"type":"object"},"UpdateMerchantPaymentAccountDto":{"description":"An UpdateMerchantPaymentAccountDto is used to modify the MerchantPaymentAccount.","properties":{"active":{"description":"Specifies if a MerchantPaymentAccount is active, that means if payments from this account are processed in system.\nMust not be null.","type":"boolean"},"additionallyAcceptedCurrencies":{"description":"List of currencies accepted by the MerchantPaymentAccount in addition to the base currency. The existing list will be replaced with this one.","items":{"enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"nullable":true,"type":"array","uniqueItems":true},"paymentCollectionConfig":{"$ref":"#/components/schemas/PaymentCollectionConfig"},"settlementsCreationDisabled":{"description":"Specifies if creation of settlements is disabled for a merchant payment account. When set to true, account statement filesof this account are loaded from PSP/bank but settlements are not created in NBX.\nMust not be null.","type":"boolean"},"settlementsProcessingSchedule":{"$ref":"#/components/schemas/CreateSettlementsProcessingScheduleDto"}},"required":["active","settlementsCreationDisabled"],"type":"object"},"UpdateMerchantPaymentGatewayRequest":{"description":"An UpdateMerchantPaymentGatewayRequest is used to modify an existing MerchantPaymentGateway.","properties":{"currencyToAccountMapping":{"additionalProperties":{"description":"List of Assignments consisting of a CurrencyCode and an ident of a MerchantPaymentAccount used for routing, e.g. \"PLN\": \"MerchantPaymentAccountIdent\".","nullable":true,"type":"string"},"description":"List of Assignments consisting of a CurrencyCode and an ident of a MerchantPaymentAccount used for routing, e.g. \"PLN\": \"MerchantPaymentAccountIdent\".","nullable":true,"type":"object"},"ident":{"description":"Unique external reference for the MerchantPaymentGateway.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"Name of the MerchantPaymentGateway.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["ident","name"],"type":"object"},"UpdatePaymentTransactionDto":{"properties":{"paymentCategoryName":{"description":"Name of a category that this payment should be updated to. Must be one of the categories configured and enabled for this tenant.\nMust not be blank.","minLength":1,"type":"string"}},"required":["paymentCategoryName"],"type":"object"},"UpdatePaymentTransactionStatusDto":{"properties":{"changeDate":{"description":"The date of the status change. ISO 8601 date time format. When no offset is provided (e.g. 2021-03-19T13:34:01), UTC is automatically used.\nMust not be null.","example":"2021-02-25T13:30:22+02:00","format":"date-time","type":"string"},"status":{"description":"The status that should be added to the payment transaction. If it is higher than the current status, the current status gets updated, otherwise it gets added to the history.\nMust not be null.\nMust be one of:\n|                |\n| -------------- |\n| RECEIVED       |\n| ERROR          |\n| REFUSED        |\n| AUTHORIZED     |\n| EXPIRED        |\n| CANCELLED      |\n| CAPTURED       |\n| CAPTURE_FAILED |\n| SETTLED        |\n| REFUNDED       |\n| CHARGEBACK     |","type":"string"}},"required":["changeDate","status"],"type":"object"},"UpdateTenantPaymentCategoryConfig":{"properties":{"assignable":{"description":"Specifies if this category is assignable.","nullable":true,"type":"boolean"},"enabled":{"description":"Specifies if this category is enabled to be used for the tenant's payments.\nMust not be null.","type":"boolean"}},"required":["enabled"],"type":"object"},"WidgetStatisticsQueryParameter":{"description":"Values used for the statistic query.","properties":{"aggregationType":{"description":"The given type of aggregation.\nMust not be null.","example":"SUM","type":"string"},"dateField":{"description":"The given date field.\nMust not be null.","example":"createdAt","type":"string"},"field":{"description":"The given field to query for.\nMust not be null.","example":"IDENT","type":"string"},"groupedBy":{"description":"The given field for grouping.\nMust not be null.","example":"NONE","type":"string"},"query":{"description":"Rsql query used to limit the result set.","example":"IDENT==client123","nullable":true,"type":"string"}},"required":["aggregationType","dateField","field","groupedBy"],"type":"object"},"WidgetStatisticsResponse":{"description":"Result of a statistic query.","properties":{"queryParameter":{"$ref":"#/components/schemas/WidgetStatisticsQueryParameter"},"results":{"description":"Must not be null.","items":{"$ref":"#/components/schemas/WidgetStatisticsResult"},"type":"array"}},"required":["queryParameter","results"],"type":"object"},"WidgetStatisticsResult":{"description":"Single result of a statistic query.","properties":{"groupedByContent":{"description":"If group by is used, this field contains the specific value of the grouping. Otherwise it is null.","example":"2025","nullable":true,"type":"string"},"value":{"description":"Sum or Counted value.\nMust not be null.","example":3.1235,"type":"number"}},"required":["value"],"type":"object"},"updatePaymentServiceProviderRequest":{"description":"Used to update a PaymentServiceProvider.","properties":{"paymentServiceProviderId":{"description":"Id of the payment service provider.\nMust not be null.\nMust be greater than 0.","format":"int64","type":"integer"}},"required":["paymentServiceProviderId"],"type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"accounts-receivable-management-read":"Scope accounts-receivable-management-read","accounts-receivable-management-write":"Scope accounts-receivable-management-write","internal":"Scope internal","tenant-management-read":"Scope tenant-management-read","tenant-management-write":"Scope tenant-management-write"},"tokenUrl":"https://api.isx-stage-westeurope.instellix.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"API Description for Payments","title":"Payment API","version":"v2-preview-1.102.1"},"openapi":"3.0.1","paths":{"/v2/customer-payment-accounts":{"get":{"description":"Get a list of all CustomerPaymentAccounts. To reduce the result set, please use the RSQL query.","operationId":"getAllCustomerPaymentAccounts","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'ident'.","in":"query","name":"sort","schema":{"default":["ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseCustomerPaymentAccountResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Query CustomerPaymentAccount","tags":["Customer Payment Accounts"]},"post":{"description":"Create a new CustomerPaymentAccount for a specific debtor","operationId":"createCustomerPaymentAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPaymentAccountCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPaymentAccountResponse"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Create a CustomerPaymentAccount","tags":["Customer Payment Accounts"]}},"/v2/customer-payment-accounts/{customerPaymentAccountIdent}":{"get":{"description":"Get a specific CustomerPaymentAccount by it's ident.","operationId":"getCustomerPaymentAccount","parameters":[{"description":"Ident of the customer payment account","in":"path","name":"customerPaymentAccountIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPaymentAccountResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Retrieve a CustomerPaymentAccount","tags":["Customer Payment Accounts"]},"put":{"description":"Update a CustomerPaymentAccount.","operationId":"updateCustomerPaymentAccount","parameters":[{"description":"Ident of the customer payment account","in":"path","name":"customerPaymentAccountIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPaymentAccountRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPaymentAccountResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Update a CustomerPaymentAccount","tags":["Customer Payment Accounts"]}},"/v2/customer-payment-accounts/{customerPaymentAccountIdent}/actions/change-health-status/{healthStatus}":{"post":{"description":"Change health status of a CustomerPaymentAccount.","operationId":"changeCustomerPaymentAccountHealthStatus","parameters":[{"description":"Ident of the customer payment account","in":"path","name":"customerPaymentAccountIdent","required":true,"schema":{"type":"string"}},{"description":"Health status of the customer payment account","in":"path","name":"healthStatus","required":true,"schema":{"enum":["GOOD","AVERAGE","POOR"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPaymentAccountResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Change health status","tags":["Customer Payment Accounts"]}},"/v2/merchant-payment-accounts":{"get":{"description":"Get a paged result of all merchant payment accounts. To reduce the result set, please use the RSQL query.","operationId":"queryMerchantPaymentAccount","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'id'.","in":"query","name":"sort","schema":{"default":["id"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseMerchantPaymentAccount"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-read"]}],"summary":"Query MerchantPaymentAccount","tags":["Merchant Payment Accounts"]},"post":{"description":"Create MerchantPaymentAccount kept by a bank/PSP on behalf of its customer.","operationId":"createMerchantPaymentAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMerchantPaymentAccount"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantPaymentAccount"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Create MerchantPaymentAccount","tags":["Merchant Payment Accounts"]}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}":{"delete":{"description":"Delete MerchantPaymentAccount by given merchantPaymentAccountIdent.","operationId":"deleteMerchantPaymentAccount","parameters":[{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Delete MerchantPaymentAccount","tags":["Merchant Payment Accounts"]},"get":{"description":"Retrieve MerchantPaymentAccount by given merchantPaymentAccountIdent.","operationId":"getMerchantPaymentAccount","parameters":[{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantPaymentAccount"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-read"]}],"summary":"Retrieve MerchantPaymentAccount","tags":["Merchant Payment Accounts"]},"put":{"description":"Update MerchantPaymentAccount for given merchantPaymentAccountIdent.","operationId":"updateMerchantPaymentAccount","parameters":[{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMerchantPaymentAccountDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantPaymentAccount"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Update MerchantPaymentAccount","tags":["Merchant Payment Accounts"]}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/payment-transaction-categorization-rules":{"post":{"description":"Create a new payment categorization rule for a specific merchant payment account","operationId":"createCategorizationRule","parameters":[{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizationRuleCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizationRuleResponse"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Create a payment categorization rule","tags":["Payment Categorization Rules"]}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/payment-transaction-categorization-rules/{categorizationRuleIdent}":{"delete":{"description":"Update a new payment categorization rule for a specific merchant payment account","operationId":"deleteCategorizationRule","parameters":[{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}},{"description":"Categorization rule ident.\nMust not be null.","in":"path","name":"categorizationRuleIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"delete a payment categorization rule","tags":["Payment Categorization Rules"]},"get":{"description":"Update a new payment categorization rule for a specific merchant payment account","operationId":"getCategorizationRule","parameters":[{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}},{"description":"Categorization rule ident.\nMust not be null.","in":"path","name":"categorizationRuleIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizationRuleResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-read"]}],"summary":"get a payment categorization rule","tags":["Payment Categorization Rules"]},"put":{"description":"Update a new payment categorization rule for a specific merchant payment account","operationId":"updateCategorizationRule","parameters":[{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}},{"description":"Categorization rule ident.\nMust not be null.","in":"path","name":"categorizationRuleIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizationRuleUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizationRuleResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Update a payment categorization rule","tags":["Payment Categorization Rules"]}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/payments":{"get":{"description":"Get a list of all payment transactions for the given merchant payment account ident. To reduce the result set, please use the RSQL query.","operationId":"searchOrGetAllPaymentTransactions","parameters":[{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'id'.","in":"query","name":"sort","schema":{"default":["id"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponsePaymentTransactionDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Query payment transactions for a merchant payment account","tags":["Payment Transactions"]},"post":{"description":"Create a new payment transaction on this merchant payment account.","operationId":"createPaymentTransaction","parameters":[{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentTransactionDto"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTransactionCreatedDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Create payment transaction","tags":["Payment Transactions"]}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/settlement-items":{"get":{"description":"Get a list of all settlement items for the given merchant payment account of this tenant. To reduce the result set, please use the RSQL query.","operationId":"querySettlementItems","parameters":[{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'ident'.","in":"query","name":"sort","schema":{"default":["ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseSettlement"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Query settlement items per merchant payment account","tags":["Settlements"]}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/settlement-reports":{"get":{"description":"Get all settlement reports by merchant payment account or search with optional RSQL search query. Results returned in a paginated response, by default sorted according to creation order. Sort order, page size and page number can be changed with optional parameters.","operationId":"querySettlementReports","parameters":[{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'id'.","in":"query","name":"sort","schema":{"default":["id"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseSettlementReport"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Query settlement reports by merchant payment account","tags":["Settlements"]},"post":{"description":"Create a new settlement report that is a Nitrobox model for various ways of providing the statement of payment settlements by Payment Service Providers or banks. In these different sources it may be called Settlement Report, Settlement Batch, Account Statement, etc.","operationId":"createSettlementReport","parameters":[{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSettlementReportDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReport"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Create settlement report","tags":["Settlements"]}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/settlement-reports/{settlementReportIdent}":{"get":{"description":"Retrieve settlement report by given Merchant payment account ident and settlement report ident.","operationId":"getSettlementReportByIdent","parameters":[{"description":"Settlement report ident.\nMust not be null.","in":"path","name":"settlementReportIdent","required":true,"schema":{"type":"string"}},{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReport"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Retrieve settlement report","tags":["Settlements"]}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/settlement-reports/{settlementReportIdent}/settlement-items":{"post":{"description":"Create a new settlement item. Every settlement item must be a part of a settlement report, created beforehand with 'Settlement Report' endpoint. New settlement item creation results in an automatic creation of a new Payment Transaction in a SETTLED status.","operationId":"createSettlementItem","parameters":[{"description":"Merchant payment account ident.\nMust not be null.","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}},{"description":"Settlement report ident.\nMust not be null.","in":"path","name":"settlementReportIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSettlementItem"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Settlement"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Create settlement item","tags":["Settlements"]}},"/v2/merchant-payment-gateways":{"get":{"description":"Get a paged result of all merchant payment gateways. To reduce the result set, please use the RSQL query.","operationId":"queryMerchantPaymentGateways","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'id'.","in":"query","name":"sort","schema":{"default":["id"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseMerchantPaymentGateway"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-read"]}],"summary":"Query MerchantPaymentGateway","tags":["Merchant Payment Gateways"]},"post":{"description":"Create MerchantPaymentGateway that is used to route payments to a MerchantPaymentAccount based on the currency.","operationId":"createMerchantPaymentGateway","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMerchantPaymentGateway"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantPaymentGateway"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Create MerchantPaymentGateway","tags":["Merchant Payment Gateways"]}},"/v2/merchant-payment-gateways/{merchantPaymentGatewayIdent}":{"put":{"description":"Update MerchantPaymentGateway for given merchantPaymentGatewayIdent.","operationId":"updateMerchantPaymentGateway","parameters":[{"description":"The id of the merchant payment gateway.\nMust not be null.","in":"path","name":"merchantPaymentGatewayIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMerchantPaymentGatewayRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantPaymentGateway"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Update MerchantPaymentGateway","tags":["Merchant Payment Gateways"]}},"/v2/payment-categories":{"get":{"description":"Get a paged result of all global payment categories","operationId":"getAllPaymentCategoryConfigurations","parameters":[{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'id'.","in":"query","name":"sort","schema":{"default":["id"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponsePaymentCategory"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-read"]}],"summary":"List payment categories","tags":["Payment Categories"]},"post":{"description":"Create payment category with assignment configuration. Category can be assignable or not.","operationId":"createPaymentCategoryConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTenantPaymentCategoryConfig"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCategory"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Create payment category","tags":["Payment Categories"]}},"/v2/payment-categories/{paymentCategoryName}":{"delete":{"description":"Delete payment category.","operationId":"deletePaymentCategoryConfiguration","parameters":[{"description":"Payment category name.\nMust not be null.","in":"path","name":"paymentCategoryName","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Delete payment category","tags":["Payment Categories"]},"get":{"description":"Retrieve payment category by name","operationId":"getPaymentCategoryConfiguration","parameters":[{"description":"Payment category name.\nMust not be null.","in":"path","name":"paymentCategoryName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCategory"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-read"]}],"summary":"Retrieve payment category","tags":["Payment Categories"]},"patch":{"operationId":"updatePaymentCategoryConfiguration","parameters":[{"description":"Payment category name.\nMust not be null.","in":"path","name":"paymentCategoryName","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTenantPaymentCategoryConfig"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCategory"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Enable or disable payment category","tags":["Payment Categories"]}},"/v2/payment-intent-tasks":{"get":{"description":"Get a paged result of all payment intent tasks. To reduce the result set, please use the RSQL query.","operationId":"searchPaymentIntentTasks","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'id'.","in":"query","name":"sort","schema":{"default":["id"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponsePaymentIntentTaskDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Query Payment Intent Task","tags":["Payment Intent Tasks"]}},"/v2/payment-intent-tasks/actions/enable-processing/{enable}":{"post":{"description":"A paymentIntentTask is the preliminary stage for a paymentIntent and is created, for example, for payment collections that are to be collected in the future.\nPaymentIntentTasks are based on the respective open item status (OPOS case) of the document and are continuously updated when changes are made.\nAs soon as a PaymentIntentTask is due, a paymentIntent is triggered with the status of the paymentIntentTask.\n\nThis endpoint is used to activate/deactivate the automatic creation and updating of paymentIntentTasks.\n\nNote: If this option is activated for existing open items, not all retroactive PaymentIntentTasks are automatically created.\nIn this case, PaymentIntentTasks are only created automatically when changes are made to the open items, which results in a change of the OPOS case.\nAll other old PaymentIntents must be checked and created manually if required.\n","operationId":"enablePaymentIntentTask","parameters":[{"description":"Indicates if the payment intent task is enabled.\nMust not be null.","in":"path","name":"enable","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentScheduleConfigDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Enable payment intent tasks","tags":["Payment Intent Tasks"]}},"/v2/payment-intent-tasks/{paymentIntentTaskIdent}":{"get":{"description":"Get a PaymentIntentTask by its ident.","operationId":"getPaymentIntentTaskByIdent","parameters":[{"description":"Ident of the payment intent task.\nMust not be null.","in":"path","name":"paymentIntentTaskIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentTaskDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Retrieve Payment Intent Task","tags":["Payment Intent Tasks"]},"patch":{"description":"Update a PaymentIntentTask.","operationId":"updatePaymentIntentTask","parameters":[{"description":"Ident of the payment intent task.\nMust not be null.","in":"path","name":"paymentIntentTaskIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentTaskUpdateDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentTaskDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Update Payment Intent Task","tags":["Payment Intent Tasks"]}},"/v2/payment-intent-tasks/{paymentIntentTaskIdent}/actions/cancel":{"post":{"description":"Cancel PaymentIntentTask, only possible when the PaymentIntent is in Status WAITING_FOR_DUE.","operationId":"cancelPaymentIntentTask","parameters":[{"description":"Ident of the payment intent task.\nMust not be null.","in":"path","name":"paymentIntentTaskIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentTaskDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Cancel PaymentIntentTask","tags":["Payment Intent Tasks"]}},"/v2/payment-intents":{"get":{"description":"Get a paged result of all payment intents. To reduce the result set, please use the RSQL query.","operationId":"searchPaymentIntents","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'id'.","in":"query","name":"sort","schema":{"default":["id"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponsePaymentIntentDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Query payment intent","tags":["Payment Intents"]},"post":{"description":"Create a new PaymentIntent.","operationId":"createPaymentIntent","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentDetailsDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Create PaymentIntent","tags":["Payment Intents"]}},"/v2/payment-intents/actions/enable-processing/{enable}":{"post":{"description":"The internal processing of PaymentIntents is controlled via this endpoint.\nAlthough PaymentIntents can be created independently of this (e.g. manually or via API),\nthey are not processed further depending on the setting in the Nitrobox (enable = false).\n\nThis is therefore the top level for activating and deactivating PaymentIntent processing.\nThe setting should only be set to \"false\" if no active payment management (e.g. collection/refund) by the Nitrobox is desired.\n\nIf the option is activated, all existing and future PaymentIntents in the system will be processed immediately.\n","operationId":"enablePaymentIntent","parameters":[{"description":"Indicates if the payment intent processing is enabled.\nMust not be null.","in":"path","name":"enable","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentScheduleConfigDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Enable payment intent","tags":["Payment Intents"]}},"/v2/payment-intents/payment-intent-schedule-config":{"get":{"description":"Retrieves the payment intent processing enabled status for the specified tenant.","operationId":"getPaymentIntentScheduleConfig","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentScheduleConfigDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Get processing enabled status.","tags":["Payment Intents"]}},"/v2/payment-intents/{paymentIntentIdent}":{"get":{"description":"Get a PaymentIntent by its ident.","operationId":"getPaymentIntentDetailsByIdent","parameters":[{"description":"Ident of the payment intent.\nMust not be null.","in":"path","name":"paymentIntentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentDetailsDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Retrieve PaymentIntent","tags":["Payment Intents"]}},"/v2/payment-intents/{paymentIntentIdent}/actions/cancel":{"post":{"description":"Cancel PaymentIntent, only possible when the PaymentIntent is in Status FAILED.","operationId":"cancelPaymentIntent","parameters":[{"description":"Ident of the payment intent.\nMust not be null.","in":"path","name":"paymentIntentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Cancel PaymentIntent","tags":["Payment Intents"]}},"/v2/payment-intents/{paymentIntentIdent}/actions/retry":{"post":{"description":"Retry PaymentIntent, only possible when the PaymentIntent is in Status FAILED.","operationId":"retryPaymentIntent","parameters":[{"description":"Ident of the payment intent.\nMust not be null.","in":"path","name":"paymentIntentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Retry PaymentIntent","tags":["Payment Intents"]}},"/v2/payment-providers":{"get":{"description":"List allpayment providers configured in the system.","operationId":"getAllPaymentServiceProviders","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PaymentServiceProviderDto"},"type":"array"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-read"]}],"summary":"List payment providers","tags":["Payment Providers"]},"post":{"description":"Create payment provider of given type: CONTOWORKS, OPTILE, KLARNA, MHP_SBA, COMMERZBANK, OTHER.","operationId":"createPaymentServiceProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentProviderDto"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentServiceProviderDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Create payment provider","tags":["Payment Providers"]}},"/v2/payment-providers/{paymentProviderId}":{"delete":{"description":"Delete payment provider by given id.","operationId":"deletePaymentServiceProvider","parameters":[{"description":"Payment provider id.\nMust not be null.","in":"path","name":"paymentProviderId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Delete payment provider","tags":["Payment Providers"]},"get":{"description":"Retrieve payment provider by given payment provider id.","operationId":"getPaymentServiceProvider","parameters":[{"description":"Payment provider id.\nMust not be null.","in":"path","name":"paymentProviderId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentServiceProviderDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-read"]}],"summary":"Retrieve payment provider","tags":["Payment Providers"]}},"/v2/payment-providers/{paymentProviderId}/settlement-sources":{"post":{"description":"Create settlement source for given, existing payment provider.","operationId":"createSettlementSource","parameters":[{"description":"Payment provider id.","in":"path","name":"paymentProviderId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateEbicsSettlementSource"},{"$ref":"#/components/schemas/CreateRestApiSettlementSource"},{"$ref":"#/components/schemas/CreateSftpSettlementSource"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SettlementSource"},{"$ref":"#/components/schemas/EbicsSettlementSource"},{"$ref":"#/components/schemas/SftpSettlementSource"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Create settlement source","tags":["Payment Providers"]}},"/v2/payment-providers/{paymentProviderId}/settlement-sources/{settlementSourceId}":{"delete":{"description":"Delete settlement source by given payment provider id and settlemet source id.","operationId":"deleteSettlementSource","parameters":[{"description":"Payment provider id.","in":"path","name":"paymentProviderId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Settlement source id.","in":"path","name":"settlementSourceId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Delete settlement source","tags":["Payment Providers"]},"get":{"description":"Retrieve settlement source for given payment provider id and settlement source id.","operationId":"getSettlementSource","parameters":[{"description":"Payment provider id.","in":"path","name":"paymentProviderId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Settlement source id.","in":"path","name":"settlementSourceId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SettlementSource"},{"$ref":"#/components/schemas/EbicsSettlementSource"},{"$ref":"#/components/schemas/SftpSettlementSource"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-read"]}],"summary":"Retrieve settlement source","tags":["Payment Providers"]},"put":{"description":"Update settlement source for given, existing payment provider and settlemet source id.","operationId":"updateSettlementSource","parameters":[{"description":"Payment provider id.","in":"path","name":"paymentProviderId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Settlement source id.","in":"path","name":"settlementSourceId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateEbicsSettlementSource"},{"$ref":"#/components/schemas/CreateRestApiSettlementSource"},{"$ref":"#/components/schemas/CreateSftpSettlementSource"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SettlementSource"},{"$ref":"#/components/schemas/EbicsSettlementSource"},{"$ref":"#/components/schemas/SftpSettlementSource"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Update settlement source","tags":["Payment Providers"]}},"/v2/payment-transaction-categorization-rules":{"get":{"description":"Get a list of all payment categorization rules. To reduce the result set, please use the RSQL query.","operationId":"getAllCategorizationRules","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'id'.","in":"query","name":"sort","schema":{"default":["id"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseCategorizationRuleResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["tenant-management-read"]}],"summary":"Query payment categorization rules","tags":["Payment Categorization Rules"]}},"/v2/payments/{ident}":{"get":{"description":"Retrieve payment transaction by given ident","operationId":"getPaymentTransactionByIdent","parameters":[{"description":"Payment transaction ident.\nMust not be null.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTransactionDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Retrieve payment transaction","tags":["Payment Transactions"]},"patch":{"description":"Update payment transaction category name by given payment transaction ident.","operationId":"updatePaymentTransaction","parameters":[{"description":"Payment transaction ident.\nMust not be null.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePaymentTransactionDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTransactionDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Update payment transaction","tags":["Payment Transactions"]}},"/v2/payments/{ident}/actions/update-status":{"post":{"description":"If it is higher than the current status, the current status gets updated, otherwise it gets added to the history. If the history already contains this status, nothing is changed.","operationId":"updatePaymentTransactionStatus","parameters":[{"description":"Payment transaction ident.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePaymentTransactionStatusDto"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTransactionDto"}}},"description":"The request has been accepted for processing, but the processing has not been completed."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Update status of the payment transaction","tags":["Payment Transactions"]}},"/v2/payments/{paymentTransactionIdent}/batch-items":{"put":{"description":"The batch items of the given payment transaction ident will be updated. please note that the request will be replaced and not added to the existing batch items.","operationId":"updatePaymentTransactionBatchItems","parameters":[{"description":"Payment transaction ident.\nMust not be null.","in":"path","name":"paymentTransactionIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTransactionBatchItemsRequestDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponsePaymentTransactionBatchItemDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Update batch items of payment transactions.","tags":["Payment Transactions"]}},"/v2/settlement-reports":{"get":{"description":"Get all settlement reports or search with optional RSQL search query. Results returned in a paginated response, by default sorted according to creation order. Sort order, page size and page number can be changed with optional parameters.","operationId":"querySettlementReportsWithMerchantPaymentAccount","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'ident'.","in":"query","name":"sort","schema":{"default":["ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseSettlementReportWithMerchantPaymentAccount"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Query settlement reports","tags":["Settlements"]}},"/v2/settlements":{"get":{"description":"Get a list of all settlement items of this tenant. To reduce the result set, please use the RSQL query.","operationId":"querySettlements","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'ident'.","in":"query","name":"sort","schema":{"default":["ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseSettlement"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Query settlement items","tags":["Settlements"]}},"/v2/settlements/{settlementIdent}":{"get":{"description":"Retrieve settlement item by given ident or id. Using the id is not recommended and only for backward compatibility.","operationId":"getSettlement","parameters":[{"description":"Settlement ident.\nMust not be null.","in":"path","name":"settlementIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Settlement"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Retrieve settlement item","tags":["Settlements"]}}},"security":[{"oauth2":[]}],"servers":[{"description":"Instellix Stage","url":"https://api.isx-stage-westeurope.instellix.io"}],"tags":[{"description":"endpoints for Customer Payment Accounts","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Customer Payment Accounts"},{"description":"endpoints for Merchant Payment Accounts","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Merchant Payment Accounts"},{"description":"endpoints for Merchant Payment Gateways","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Merchant Payment Gateways"},{"description":"endpoints for Payment Providers","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Payment Providers"},{"description":"endpoints for Payment Categories","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Payment Categories"},{"description":"endpoints for Payment Transactions","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Payment Transactions"},{"description":"endpoints for Payment Categorization Rules","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Payment Categorization Rules"},{"description":"endpoints for Payment Intents","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Payment Intents"},{"description":"endpoints for Payment Intent Tasks","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Payment Intent Tasks"},{"description":"endpoints for Settlements","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Settlements"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}