{"openapi":"3.0.3","info":{"title":"Payment API","description":"API Description for Payments","version":"v2-1.31.2"},"servers":[{"url":"https://api.nitrobox.io","description":"NBX Live"}],"paths":{"/v2/customer-payment-accounts":{"get":{"tags":["Payment"],"summary":"Query CustomerPaymentAccount","description":"Get a list of all CustomerPaymentAccounts. To reduce the result set, please use the RSQL query.","operationId":"getAllChargingAccounts","parameters":[{"name":"search","in":"query","description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\nExample: ident==20000\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned. Max page size is 100.","schema":{"type":"integer","default":10}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string","default":"id,asc"}}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseCustomerPaymentAccountResponse"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"post":{"tags":["Payment"],"summary":"Create a CustomerPaymentAccount","description":"Create a new CustomerPaymentAccount for a specific debtor","operationId":"createCustomerPaymentAccountForDebtor","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPaymentAccountCreationRequest"}}},"required":true},"responses":{"201":{"description":"The request has been fulfilled, resulting in the creation of a new resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPaymentAccountResponse"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/customer-payment-accounts/{customerPaymentAccountIdent}":{"get":{"tags":["Payment"],"summary":"Retrieve a CustomerPaymentAccount","description":"Get a specific CustomerPaymentAccount by it's ident.","operationId":"getChargingAccount","parameters":[{"name":"customerPaymentAccountIdent","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPaymentAccountResponse"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"put":{"tags":["Payment"],"summary":"Update a CustomerPaymentAccount","description":"Update a CustomerPaymentAccount.","operationId":"updateCustomerPaymentAccountForDebtor","parameters":[{"name":"customerPaymentAccountIdent","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPaymentAccountRequest"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPaymentAccountResponse"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/customer-payment-accounts/{customerPaymentAccountIdent}/actions/change-health-status/{healthStatus}":{"post":{"tags":["Payment"],"summary":"Change health status","description":"Change health status of a CustomerPaymentAccount.","operationId":"changeCustomerPaymentAccountHealthStatus","parameters":[{"name":"customerPaymentAccountIdent","in":"path","required":true,"schema":{"type":"string"}},{"name":"healthStatus","in":"path","required":true,"schema":{"type":"string","enum":["GOOD","AVERAGE","POOR"]}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPaymentAccountResponse"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/merchant-payment-gateways":{"get":{"tags":["Merchant Payment Gateways"],"summary":"Query MerchantPaymentGateway","description":"Get a paged result of all merchant payment gateways. To reduce the result set, please use the RSQL query.","operationId":"search","parameters":[{"name":"search","in":"query","description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\nExample: ident==20000\n","required":true,"schema":{"type":"string"}},{"name":"pageable","in":"query","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned. Max page size is 100.","schema":{"type":"integer","default":10}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string","default":"id,asc"}}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseMerchantPaymentGateway"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"post":{"tags":["Merchant Payment Gateways"],"summary":"Create MerchantPaymentGateway","description":"Create MerchantPaymentGateway that is used to route payments to a MerchantPaymentAccount based on the currency.","operationId":"create_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMerchantPaymentGateway"}}},"required":true},"responses":{"201":{"description":"The request has been fulfilled, resulting in the creation of a new resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantPaymentGateway"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/merchant-payment-gateways/{merchantPaymentGatewayIdent}":{"put":{"tags":["Merchant Payment Gateways"],"summary":"Update MerchantPaymentGateway","description":"Update MerchantPaymentGateway for given merchantPaymentGatewayIdent.","operationId":"update","parameters":[{"name":"merchantPaymentGatewayIdent","in":"path","description":"Must not be null.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMerchantPaymentGatewayRequest"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantPaymentGateway"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/merchant-payment-accounts":{"get":{"tags":["Merchant Payment Accounts"],"summary":"Query MerchantPaymentAccount","description":"Get a paged result of all merchant payment accounts. To reduce the result set, please use the RSQL query.","operationId":"searchPaymentAccounts","parameters":[{"name":"search","in":"query","description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\nExample: ident==20000\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned. Max page size is 100.","schema":{"type":"integer","default":10}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string","default":"id,asc"}}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseMerchantPaymentAccount"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"post":{"tags":["Merchant Payment Accounts"],"summary":"Create MerchantPaymentAccount","description":"Create MerchantPaymentAccount kept by a bank/PSP on behalf of its customer.","operationId":"create_2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMerchantPaymentAccount"}}},"required":true},"responses":{"201":{"description":"The request has been fulfilled, resulting in the creation of a new resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantPaymentAccount"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}":{"get":{"tags":["Merchant Payment Accounts"],"summary":"Retrieve MerchantPaymentAccount","description":"Retrieve MerchantPaymentAccount by given merchantPaymentAccountIdent.","operationId":"get_4","parameters":[{"name":"merchantPaymentAccountIdent","in":"path","description":"ident to be retreived.\nMust not be null.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantPaymentAccount"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"put":{"tags":["Merchant Payment Accounts"],"summary":"Update MerchantPaymentAccount","description":"Update MerchantPaymentAccount for given merchantPaymentAccountIdent.","operationId":"update_2","parameters":[{"name":"merchantPaymentAccountIdent","in":"path","description":"ident to be updated.\nMust not be null.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMerchantPaymentAccountDto"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantPaymentAccount"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"delete":{"tags":["Merchant Payment Accounts"],"summary":"Delete MerchantPaymentAccount","description":"Delete MerchantPaymentAccount by given merchantPaymentAccountIdent.","operationId":"delete_2","parameters":[{"name":"merchantPaymentAccountIdent","in":"path","description":"ident to be deleted.\nMust not be null.","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"}}}},"/v2/payment-providers":{"get":{"tags":["Payment Provider"],"summary":"List payment providers","description":"List allpayment providers configured in the system.","operationId":"getAll_1","responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PaymentServiceProviderDto"}}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"post":{"tags":["Payment Provider"],"summary":"Create payment provider","description":"Create payment provider of given type: CONTOWORKS, OPTILE, KLARNA, MHP_SBA, COMMERZBANK, OTHER.","operationId":"create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentProviderDto"}}},"required":true},"responses":{"201":{"description":"The request has been fulfilled, resulting in the creation of a new resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentServiceProviderDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/payment-providers/{paymentProviderId}":{"get":{"tags":["Payment Provider"],"summary":"Retrieve payment provider","description":"Retrieve payment provider by given payment provider id.","operationId":"get_1","parameters":[{"name":"paymentProviderId","in":"path","description":"Payment provider id.\nMust not be null.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentServiceProviderDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"delete":{"tags":["Payment Provider"],"summary":"Delete payment provider","description":"Delete payment provider by given id.","operationId":"delete","parameters":[{"name":"paymentProviderId","in":"path","description":"Payment provider id.\nMust not be null.","required":true,"schema":{"type":"integer","format":"int64"}}],"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"}}}},"/v2/payment-providers/{paymentProviderId}/settlement-sources":{"post":{"tags":["Payment Provider"],"summary":"Create settlement source","description":"Create settlement source for given, existing payment provider.","operationId":"createSettlementSource","parameters":[{"name":"paymentProviderId","in":"path","description":"Payment provider id.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Create settlement source request.","oneOf":[{"$ref":"#/components/schemas/CreateSettlementSource"},{"$ref":"#/components/schemas/CreateEbicsSettlementSource"},{"$ref":"#/components/schemas/CreateRestApiSettlementSource"},{"$ref":"#/components/schemas/CreateSftpSettlementSource"}]}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SettlementSource"},{"$ref":"#/components/schemas/EbicsSettlementSource"},{"$ref":"#/components/schemas/SftpSettlementSource"}]}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/payment-providers/{paymentProviderId}/settlement-sources/{settlementSourceId}":{"get":{"tags":["Payment Provider"],"summary":"Retrieve settlement source","description":"Retrieve settlement source for given payment provider id and settlemet source id.","operationId":"getSettlementSource","parameters":[{"name":"paymentProviderId","in":"path","description":"Payment provider id.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"settlementSourceId","in":"path","description":"Settlement source id.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SettlementSource"},{"$ref":"#/components/schemas/EbicsSettlementSource"},{"$ref":"#/components/schemas/SftpSettlementSource"}]}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"put":{"tags":["Payment Provider"],"summary":"Update settlement source","description":"Update settlement source for given, existing payment provider and settlemet source id.","operationId":"updateSettlementSource","parameters":[{"name":"paymentProviderId","in":"path","description":"Payment provider id.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"settlementSourceId","in":"path","description":"Settlement source id.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateSettlementSource"},{"$ref":"#/components/schemas/CreateEbicsSettlementSource"},{"$ref":"#/components/schemas/CreateRestApiSettlementSource"},{"$ref":"#/components/schemas/CreateSftpSettlementSource"}]}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SettlementSource"},{"$ref":"#/components/schemas/EbicsSettlementSource"},{"$ref":"#/components/schemas/SftpSettlementSource"}]}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"delete":{"tags":["Payment Provider"],"summary":"Delete settlement source","description":"Delete settlement source by given payment provider id and settlemet source id.","operationId":"deleteSettlementSource","parameters":[{"name":"paymentProviderId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"settlementSourceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"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"}}}},"/v2/global-payment-categories":{"get":{"tags":["Payment Categories"],"summary":"Query payment categories","description":"Get a paged result of all payment categories.","operationId":"getAll_5","parameters":[{"name":"size","in":"query","description":"The size of the page to be returned. Max page size is 100.","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"schema":{"type":"array","items":{"type":"string","default":"id,asc"}}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultsList."}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"post":{"tags":["Payment Categories"],"summary":"Create payment category","description":"Create payment category with assignment configuration. Category could be assignable or not.","operationId":"create_5","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentCategory"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCategory"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/global-payment-categories/{categoryName}":{"get":{"tags":["Payment Categories"],"summary":"Retrieve payment category","description":"Retrieve payment category by category name.","operationId":"get_5","parameters":[{"name":"categoryName","in":"path","description":"Category name.\nMust not be null.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCategory"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"patch":{"tags":["Payment Categories"],"summary":"Update attributes of payment category","description":"Update assignable property of payment category given by category name.","operationId":"update_5","parameters":[{"name":"categoryName","in":"path","description":"Category name.\nMust not be null.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePaymentCategory"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCategory"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/payment-categories":{"get":{"tags":["Payment Categories"],"summary":"List payment categories","description":"Get a paged result of all global payment categories configuration","operationId":"getAll_2","parameters":[{"name":"size","in":"query","description":"The size of the page to be returned. Max page size is 100.","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"schema":{"type":"array","items":{"type":"string","default":"id,asc"}}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultsList."}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/payment-categories/{paymentCategoryName}":{"get":{"tags":["Payment Categories"],"summary":"Retrieve global payment category configuration","description":"Retrieve global payment category configuration by name","operationId":"get_2","parameters":[{"name":"paymentCategoryName","in":"path","description":"Unique category name.\nMust not be null.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCategory"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"patch":{"tags":["Payment Categories"],"summary":"Enable or disable payment category","operationId":"update_4","parameters":[{"name":"paymentCategoryName","in":"path","description":"Unique category name.\nMust not be null.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTenantPaymentCategoryConfig"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCategory"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/merchant-payment-accounts/{merchantPaymentAccountId}/payment-categorization-configs":{"get":{"tags":["Payment Categorization Configuration"],"summary":"Retrieve categorization configuration","description":"Retrieve all categorization configurations.","operationId":"getAll_3","parameters":[{"name":"merchantPaymentAccountId","in":"path","description":"Merchant payment account id.\nMust not be null.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PaymentCategorizationConfigDto"}}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"deprecated":true},"post":{"tags":["Payment Categorization Configuration"],"summary":"Create categorization configuration","description":"Create categorization configuration for given merchant payment account id.","operationId":"create_3","parameters":[{"name":"merchantPaymentAccountId","in":"path","description":"Merchant payment account id.\nMust not be null.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentCategorizationConfigDto"}}},"required":true},"responses":{"201":{"description":"The request has been fulfilled, resulting in the creation of a new resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCategorizationConfigDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"deprecated":true}},"/v2/merchant-payment-accounts/{merchantPaymentAccountId}/payment-categorization-configs/{paymentCategorizationConfigId}":{"get":{"tags":["Payment Categorization Configuration"],"summary":"Retrieve categorization configuration","description":"Retrieve categorization configuration for given Merchant payment account id and categorization configuration id.","operationId":"get_3","parameters":[{"name":"paymentCategorizationConfigId","in":"path","description":"Categorization configuration id.\nMust not be null.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"merchantPaymentAccountId","in":"path","description":"Merchant payment account id.\nMust not be null.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCategorizationConfigDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"deprecated":true},"put":{"tags":["Payment Categorization Configuration"],"summary":"Update categorization configuration","description":"Update, i.e. enable or disable, payment categorization configuration.","operationId":"update_1","parameters":[{"name":"paymentCategorizationConfigId","in":"path","description":"Categorization configuration id.\nMust not be null.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"merchantPaymentAccountId","in":"path","description":"Merchant payment account id.\nMust not be null.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePaymentCategorizationConfigDto"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCategorizationConfigDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"deprecated":true},"delete":{"tags":["Payment Categorization Configuration"],"summary":"Delete categorization configuration.","operationId":"delete_1","parameters":[{"name":"paymentCategorizationConfigId","in":"path","description":"Categorization configuration id.\nMust not be null.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"merchantPaymentAccountId","in":"path","description":"Merchant payment account id.\nMust not be null.","required":true,"schema":{"type":"integer","format":"int64"}}],"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"}},"deprecated":true}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/payments":{"get":{"tags":["Payment Transactions"],"summary":"Query payment transactions for a merchant payment account","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":[{"name":"merchantPaymentAccountIdent","in":"path","description":"The unique identifier of a merchant payment account, given by the Tenant.\nMust not be null.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\nExample: ident==20000\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned. Max page size is 100.","schema":{"type":"integer","default":10}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string","default":"id,asc"}}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponsePaymentTransactionDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"post":{"tags":["Payment Transactions"],"summary":"Create payment transaction","description":"Create a new payment transaction on this merchant payment account.","operationId":"createPaymentTransaction","parameters":[{"name":"merchantPaymentAccountIdent","in":"path","description":"Merchant payment account ident.\nMust not be null.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentTransactionDto"}}},"required":true},"responses":{"201":{"description":"The request has been fulfilled, resulting in the creation of a new resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTransactionCreatedDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/payments/{ident}":{"get":{"tags":["Payment Transactions"],"summary":"Retrieve payment transaction","description":"Retrieve payment transaction by given ident","operationId":"getByIdent","parameters":[{"name":"ident","in":"path","description":"Payment transaction ident.\nMust not be null.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTransactionDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"patch":{"tags":["Payment Transactions"],"summary":"Update payment transaction","description":"Update payment transaction category name by given payment transaction ident.","operationId":"update_3","parameters":[{"name":"ident","in":"path","description":"Payment transaction ident.\nMust not be null.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePaymentTransactionDto"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTransactionDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/payments/{ident}/actions/update-status":{"post":{"tags":["Payment Transactions"],"summary":"Update status of the payment transaction","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":"updateStatus","parameters":[{"name":"ident","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePaymentTransactionStatusDto"}}},"required":true},"responses":{"202":{"description":"The request has been accepted for processing, but the processing has not been completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTransactionDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/payment-transaction-categorization-rules":{"post":{"tags":["Payment Categorization Rules"],"summary":"Create a payment categorization rule","description":"Create a new payment categorization rule for a specific merchant payment account","operationId":"createCategorizationRule","parameters":[{"name":"merchantPaymentAccountIdent","in":"path","description":"Merchant payment account ident.\nMust not be null.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizationRuleCreationRequest"}}},"required":true},"responses":{"201":{"description":"The request has been fulfilled, resulting in the creation of a new resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizationRuleResponse"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/payment-transaction-categorization-rules/{categorizationRuleIdent}":{"get":{"tags":["Payment Categorization Rules"],"summary":"get a payment categorization rule","description":"Update a new payment categorization rule for a specific merchant payment account","operationId":"getCategorizationRule","parameters":[{"name":"merchantPaymentAccountIdent","in":"path","description":"Merchant payment account ident.\nMust not be null.","required":true,"schema":{"type":"string"}},{"name":"categorizationRuleIdent","in":"path","description":"Categorization rule ident.\nMust not be null.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizationRuleResponse"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"put":{"tags":["Payment Categorization Rules"],"summary":"Update a payment categorization rule","description":"Update a new payment categorization rule for a specific merchant payment account","operationId":"updateCategorizationRule","parameters":[{"name":"merchantPaymentAccountIdent","in":"path","description":"Merchant payment account ident.\nMust not be null.","required":true,"schema":{"type":"string"}},{"name":"categorizationRuleIdent","in":"path","description":"Categorization rule ident.\nMust not be null.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizationRuleUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizationRuleResponse"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"delete":{"tags":["Payment Categorization Rules"],"summary":"delete a payment categorization rule","description":"Update a new payment categorization rule for a specific merchant payment account","operationId":"deleteCategorizationRule","parameters":[{"name":"merchantPaymentAccountIdent","in":"path","description":"Merchant payment account ident.\nMust not be null.","required":true,"schema":{"type":"string"}},{"name":"categorizationRuleIdent","in":"path","description":"Categorization rule ident.\nMust not be null.","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"}}}},"/v2/payment-transaction-categorization-rules":{"get":{"tags":["Payment Categorization Rules"],"summary":"Query payment categorization rules","description":"Get a list of all payment categorization rules. To reduce the result set, please use the RSQL query.","operationId":"getAllCategorizationRules","parameters":[{"name":"search","in":"query","description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\nExample: ident==20000\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned. Max page size is 100.","schema":{"type":"integer","default":10}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string","default":"id,asc"}}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseCategorizationRuleResponse"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/payment-intents":{"get":{"tags":["Payment Intent"],"summary":"Query payment intent","description":"Get a paged result of all payment intents. To reduce the result set, please use the RSQL query.","operationId":"searchPaymentIntents","parameters":[{"name":"search","in":"query","description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\nExample: ident==20000\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned. Max page size is 100.","schema":{"type":"integer","default":10}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string","default":"id,asc"}}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponsePaymentIntentDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"post":{"tags":["Payment Intent"],"summary":"Create PaymentIntent","description":"Create a new PaymentIntent.","operationId":"createPaymentIntent","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentCreationRequest"}}},"required":true},"responses":{"201":{"description":"The request has been fulfilled, resulting in the creation of a new resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentDetailsDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/payment-intents/{paymentIntentIdent}":{"get":{"tags":["Payment Intent"],"summary":"Retrieve PaymentIntent","description":"Get a PaymentIntent by its ident.","operationId":"getPaymentIntentDetailsByIdent","parameters":[{"name":"paymentIntentIdent","in":"path","description":"Must not be null.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentDetailsDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/payment-intents/{paymentIntentIdent}/actions/cancel":{"post":{"tags":["Payment Intent"],"summary":"Cancel PaymentIntent","description":"Cancel PaymentIntent, only possible when the PaymentIntent is in Status FAILED.","operationId":"cancelPaymentIntent","parameters":[{"name":"paymentIntentIdent","in":"path","description":"Must not be null.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/payment-intents/{paymentIntentIdent}/actions/retry":{"post":{"tags":["Payment Intent"],"summary":"Retry PaymentIntent","description":"Retry PaymentIntent, only possible when the PaymentIntent is in Status FAILED.","operationId":"retryPaymentIntent","parameters":[{"name":"paymentIntentIdent","in":"path","description":"Must not be null.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/payment-intent-tasks":{"get":{"tags":["Payment Intent Task"],"summary":"Query Payment Intent Task","description":"Get a paged result of all payment intent tasks. To reduce the result set, please use the RSQL query.","operationId":"searchPaymentIntents_1","parameters":[{"name":"search","in":"query","description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\nExample: ident==20000\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned. Max page size is 100.","schema":{"type":"integer","default":10}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string","default":"id,asc"}}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponsePaymentIntentTaskDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/payment-intent-tasks/{paymentIntentTaskIdent}":{"get":{"tags":["Payment Intent Task"],"summary":"Retrieve Payment Intent Task","description":"Get a PaymentIntentTask by its ident.","operationId":"getPaymentIntentDetailsByIdent_1","parameters":[{"name":"paymentIntentTaskIdent","in":"path","description":"Must not be null.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentIntentTaskDto"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/settlement-items":{"get":{"tags":["Settlements"],"summary":"Query settlement items per merchant payment account","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":"getAll_4","parameters":[{"name":"merchantPaymentAccountIdent","in":"path","description":"Merchant payment account ident.\nMust not be null.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\nExample: ident==abcdef\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseSettlement"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/settlement-reports":{"get":{"tags":["Settlements"],"summary":"Query settlement reports by merchant payment account","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":"getAllSettlementReports_1","parameters":[{"name":"merchantPaymentAccountIdent","in":"path","description":"Merchant payment account ident.\nMust not be null.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Use RSQL query language.\n\n Exa.mple: ident==20000.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N).","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned. Max page size is 100.","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"schema":{"type":"array","items":{"type":"string","default":"id,asc"}}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseSettlementReport"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}},"post":{"tags":["Settlements"],"summary":"Create settlement report","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":"create_4","parameters":[{"name":"merchantPaymentAccountIdent","in":"path","description":"Merchant payment account ident.\nMust not be null.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSettlementReportDto"}}},"required":true},"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReport"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/settlement-reports/{settlementReportIdent}":{"get":{"tags":["Settlements"],"summary":"Retrieve settlement report","description":"Retrieve settlement report by given Merchant payment account ident and settlement report ident.","operationId":"getByIdent_1","parameters":[{"name":"settlementReportIdent","in":"path","description":"Settlement report ident.\nMust not be null.","required":true,"schema":{"type":"string"}},{"name":"merchantPaymentAccountIdent","in":"path","description":"Merchant payment account ident.\nMust not be null.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReport"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/settlement-reports/{settlementReportIdent}/settlement-items":{"post":{"tags":["Settlements"],"summary":"Create settlement item","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":[{"name":"merchantPaymentAccountIdent","in":"path","description":"Merchant payment account ident.\nMust not be null.","required":true,"schema":{"type":"string"}},{"name":"settlementReportIdent","in":"path","description":"Settlement report ident.\nMust not be null.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSettlementItem"}}},"required":true},"responses":{"201":{"description":"The request has been fulfilled, resulting in the creation of a new resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Settlement"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/merchant-payment-accounts/{merchantPaymentAccountId}/settlement-files":{"post":{"tags":["Settlements"],"summary":"Upload settlement report","description":"Upload settlement report file for given merchant payment account id.","operationId":"fileUpload","parameters":[{"name":"merchantPaymentAccountId","in":"path","description":"Merchant payment account id.\nMust not be null.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Settlement report file.","format":"binary"}}}}}},"responses":{"202":{"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"}}}},"/v2/settlement-reports":{"get":{"tags":["Settlements"],"summary":"Query settlement reports","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":"getAllSettlementReports","parameters":[{"name":"search","in":"query","description":"Use RSQL query language.\n\n Example: ident==20000.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned. Max page size is 100.","schema":{"type":"integer","default":10}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string","default":"ident,desc"}}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseSettlementReportWithMerchantPaymentAccount"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/settlements":{"get":{"tags":["Settlements"],"summary":"Query settlement items","description":"Get a list of all settlement items of this tenant. To reduce the result set, please use the RSQL query.","operationId":"getAll","parameters":[{"name":"search","in":"query","description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\nExample: ident==20000\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"The size of the page to be returned","schema":{"type":"integer","default":20}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseSettlement"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}},"/v2/settlements/{settlementIdent}":{"get":{"tags":["Settlements"],"summary":"Retrieve settlement item","description":"Retrieve settlement item by given ident or id. Using the id is not recommended and only for backward compatibility.","operationId":"get","parameters":[{"name":"settlementIdent","in":"path","description":"Settlement ident.\nMust not be null.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Standard response for successful HTTP requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Settlement"}}}},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}}}}},"components":{"schemas":{"BatchItem":{"required":["baseAmount","ident"],"type":"object","properties":{"ident":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string","description":"Unique identifier of a batch item.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'."},"externalIdent":{"type":"string","description":"A settlement batch item identifier, unique within a payment account. May be provided by a PSP."},"reportLineNumber":{"type":"integer","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"},"reportIdentifier":{"type":"string","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."},"recipient":{"type":"string","description":"Information about the recipient of a batch item."},"sender":{"type":"string","description":"Information about the sender of a batch item."},"text":{"type":"string","description":"Any additional information about a batch item like purpose, description, payment title, etc."},"baseAmount":{"$ref":"#/components/schemas/MoneyDto"},"originalAmount":{"$ref":"#/components/schemas/MoneyDto"},"paymentCategory":{"type":"string","description":"Name of a payment category that the payment settled with this batch item is classified to. Must be one of the categories defined in Nitrobox, otherwise the settlement item will be rejected."},"properties":{"type":"array","description":"Key-value-pairs of properties of a batch item - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"}}},"description":"Batch items of this transaction"},"CategorizationRuleCreationRequest":{"required":["ident","jsonataExpression","priority","resultingPaymentCategoryName"],"type":"object","properties":{"ident":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string","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}'."},"description":{"type":"string","description":"Description of the rule."},"jsonataExpression":{"type":"string","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."},"priority":{"type":"integer","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"},"resultingPaymentCategoryName":{"type":"string","description":"Name of an existing payment category. See payment categories endpoint.\nMust not be blank."}},"description":"Please see CategorizationRuleCreationRequest Model below for more information regarding required values and input type."},"CategorizationRuleResponse":{"required":["ident","jsonataExpression","merchantPaymentAccountIdent","priority","resultingPaymentCategoryName"],"type":"object","properties":{"ident":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string","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}'."},"merchantPaymentAccountIdent":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string","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}'."},"description":{"type":"string","description":"Description of the rule."},"jsonataExpression":{"type":"string","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."},"priority":{"type":"integer","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"},"resultingPaymentCategoryName":{"type":"string","description":"Name of an existing payment category. See payment categories endpoint.\nMust not be blank."}},"description":"JSONata rules to map a Settlement to the correct transaction category used for automatic assignment."},"CategorizationRuleUpdateRequest":{"required":["jsonataExpression","priority","resultingPaymentCategoryName"],"type":"object","properties":{"description":{"type":"string","description":"Description of the rule."},"jsonataExpression":{"type":"string","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."},"priority":{"type":"integer","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"},"resultingPaymentCategoryName":{"type":"string","description":"Name of an existing payment category. See payment categories endpoint.\nMust not be blank."}},"description":"Please see CategorizationRuleUpdateRequest Model below for more information regarding required values and input type."},"CreateCredentialsDto":{"required":["password","username"],"type":"object","properties":{"username":{"maxLength":255,"minLength":0,"type":"string","description":"Must not be empty.\nSize must be between 0 and 255."},"password":{"maxLength":255,"minLength":0,"type":"string","description":"Must not be empty.\nSize must be between 0 and 255."}},"description":"Must not be null."},"CreateCustomerSpecificSettlementIdentConfigurationDto":{"required":["generationMode"],"type":"object","properties":{"generationMode":{"type":"string","description":"Mode of generating customer specific settlement ident.\nMust not be null.","enum":["COUNTER_BY_PAYMENT_CATEGORY","COUNTER_BY_CURRENCY","SIMPLE_COUNTER","NO_IDENT"]},"counters":{"uniqueItems":true,"type":"array","description":"Set of counters used to generate customer specific settlement idents, based on settlement criteria specified by generation mode.","items":{"$ref":"#/components/schemas/CreateSettlementIdentCounterDto"}}}},"CreateEbicsSettlementConfig":{"required":["ebicsKeys","partnerId","passphrase","protocolType","settlementSourceId","userId"],"type":"object","description":"Configuration of payment account that is required to fetch settlements via Ebics protocol.","allOf":[{"$ref":"#/components/schemas/CreateSettlementConfig"},{"type":"object","properties":{"partnerId":{"maxLength":255,"minLength":0,"type":"string","description":"Must not be null.\nSize must be between 0 and 255."},"userId":{"maxLength":255,"minLength":0,"type":"string","description":"Must not be null.\nSize must be between 0 and 255."},"ebicsKeys":{"maxLength":16384,"minLength":0,"type":"string","description":"Must not be null.\nSize must be between 0 and 16384."},"passphrase":{"maxLength":255,"minLength":0,"type":"string","description":"Must not be null.\nSize must be between 0 and 255."},"iban":{"maxLength":255,"minLength":0,"type":"string","description":"Size must be between 0 and 255."}}}]},"CreateEbicsSettlementSource":{"required":["fileType","host","hostId","name","protocolType"],"type":"object","description":"Ebics settlement source that except standard properties contains also host id of the bank.","allOf":[{"$ref":"#/components/schemas/CreateSettlementSource"},{"type":"object","properties":{"hostId":{"maxLength":255,"minLength":0,"type":"string","description":"The host id of the bank.\nMust not be null.\nSize must be between 0 and 255."}}}]},"CreateFee":{"required":["amount","type"],"type":"object","properties":{"type":{"type":"string","description":"Type of a fee. Must by one of the possible fee types specified in Nitrobox.\nMust not be null.","enum":["COMMISSION","MARKUP","SCHEME_FEES","INTERCHANGE","STANDARD_FEE"]},"amount":{"$ref":"#/components/schemas/MoneyDto"}},"description":"Create Fee request body."},"CreateMerchantPaymentAccount":{"required":["active","country","currency","ident","name","paymentServiceProviderId"],"type":"object","properties":{"name":{"maxLength":255,"minLength":0,"type":"string","description":"Must not be blank.\nSize must be between 0 and 255."},"ident":{"maxLength":255,"minLength":0,"type":"string","description":"Unique external reference for the MerchantPaymentAccount.\nMust not be blank.\nSize must be between 0 and 255."},"currency":{"type":"string","description":"The currency used for this MerchantPaymentAccount. Must be one of:.\nMust not be null.","example":"EUR","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"]},"additionallyAcceptedCurrencies":{"uniqueItems":true,"type":"array","description":"List of currencies accepted by the MerchantPaymentAccount in addition to the base currency.","items":{"type":"string","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"]}},"country":{"type":"string","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","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"settlementConfig":{"oneOf":[{"$ref":"#/components/schemas/CreateEbicsSettlementConfig"},{"$ref":"#/components/schemas/CreateRestApiSettlementConfig"},{"$ref":"#/components/schemas/CreateSftpSettlementConfig"}]},"active":{"type":"boolean","description":"Specifies if a MerchantPaymentAccount is active, that means if payments from this account are processed in system.\nMust not be null."},"paymentServiceProviderId":{"type":"integer","description":"Must not be null.","format":"int64"},"settlementsCreationDisabled":{"type":"boolean","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."},"settlementsProcessingSchedule":{"$ref":"#/components/schemas/CreateSettlementsProcessingScheduleDto"},"paymentCollectionConfig":{"$ref":"#/components/schemas/PaymentCollectionConfig"}},"description":"MerchantPaymentAccount request."},"CreateMerchantPaymentGateway":{"required":["ident","name","paymentServiceProviderId"],"type":"object","properties":{"ident":{"maxLength":255,"minLength":0,"type":"string","description":"Unique external reference for the MerchantPaymentGateway.\nMust not be blank.\nSize must be between 0 and 255."},"name":{"maxLength":255,"minLength":0,"type":"string","description":"Must not be blank.\nSize must be between 0 and 255."},"currencyToAccountMapping":{"type":"object","additionalProperties":{"type":"string","description":"List of Assignments consisting of a CurrencyCode and an ident of a MerchantPaymentAccount used for routing, e.g. \"PLN\": \"MerchantPaymentAccountIdent\"."},"description":"List of Assignments consisting of a CurrencyCode and an ident of a MerchantPaymentAccount used for routing, e.g. \"PLN\": \"MerchantPaymentAccountIdent\"."},"paymentServiceProviderId":{"type":"integer","description":"Must not be null.","format":"int64"}},"description":"A CreateMerchantPaymentGateway is used to create a MerchantPaymentGateway that is used to route payments to a MerchantPaymentAccount based on the currency."},"CreatePaymentCategorizationConfigDto":{"required":["categoryId","strategy","strategyProperties"],"type":"object","properties":{"categoryId":{"type":"integer","description":"Must not be null.","format":"int64"},"strategy":{"type":"string","description":"Must not be null.","enum":["CAMT_GVC_CODE_STRATEGY","CAMT_DEBTOR_GVC_CODE_STRATEGY","CAMT_DESCRIPTION_GVC_CODE_STRATEGY"]},"strategyProperties":{"type":"object","additionalProperties":{"type":"string","description":"Required properties for strategies are:
\nCAMT_GVC_CODE_STRATEGY: gvcCode
\nCAMT_DEBTOR_GVC_CODE_STRATEGY: gvcCode, debtorName
","example":"{\"gvcCode\":\"808\",\"debtorName\":\"ADYEN NV\"}"},"description":"Required properties for strategies are:
\nCAMT_GVC_CODE_STRATEGY: gvcCode
\nCAMT_DEBTOR_GVC_CODE_STRATEGY: gvcCode, debtorName
.\nMust not be null.","example":{"gvcCode":"808","debtorName":"ADYEN NV"}}}},"CreatePaymentCategory":{"required":["assignable","name"],"type":"object","properties":{"name":{"maxLength":255,"minLength":0,"type":"string","description":"Unique payment category name.\nMust not be empty.\nSize must be between 0 and 255."},"assignable":{"type":"boolean","description":"Specifies if a payment of this category can be assigned to an invoice or a creditmemo.\nMust not be null."}},"description":"Payment assignment category configuration."},"CreatePaymentProviderDto":{"required":["name","type"],"type":"object","properties":{"name":{"maxLength":255,"minLength":0,"type":"string","description":"Must not be blank.\nSize must be between 0 and 255."},"type":{"type":"string","description":"Must not be null.","enum":["ADYEN","CONTOWORKS","COMMERZBANK","GOCARDLESS","KLARNA","MOLLIE","OPTILE","STRIPE","VWFS_SMARTPAY","WORLDLINE","OTHER"]},"settlementSources":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/CreateSettlementSource"},{"$ref":"#/components/schemas/CreateEbicsSettlementSource"},{"$ref":"#/components/schemas/CreateRestApiSettlementSource"},{"$ref":"#/components/schemas/CreateSftpSettlementSource"}]}}},"description":"Create payment provider request."},"CreatePaymentTransactionDto":{"required":["baseAmount","bookingDate","creditDebitIndicator","externalIdent","paymentCategory","status","valueDate"],"type":"object","properties":{"ident":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string","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}'."},"externalIdent":{"maxLength":255,"minLength":0,"type":"string","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"},"customerSpecificIdent":{"maxLength":255,"minLength":0,"type":"string","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"},"status":{"type":"string","description":"The status this payment transaction is in.\nMust not be null.","example":"CAPTURED","enum":["RECEIVED","ERROR","REFUSED","AUTHORIZED","EXPIRED","CANCELLED","CAPTURED","CAPTURE_FAILED","SETTLED","REFUNDED","CHARGEBACK"]},"creditDebitIndicator":{"type":"string","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.","example":"DEBIT","enum":["CREDIT","DEBIT"]},"baseAmount":{"$ref":"#/components/schemas/MoneyDto"},"originalAmount":{"$ref":"#/components/schemas/MoneyDto"},"exchangeRate":{"minimum":0,"exclusiveMinimum":true,"type":"number","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."},"bookingDate":{"type":"string","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.","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"valueDate":{"type":"string","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.","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"creationDate":{"type":"string","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.","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"recipient":{"maxLength":255,"minLength":0,"type":"string","description":"The recipient of the payment transfer.\nSize must be between 0 and 255."},"sender":{"maxLength":255,"minLength":0,"type":"string","description":"The sender of the payment transfer.\nSize must be between 0 and 255."},"text":{"maxLength":255,"minLength":0,"type":"string","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 255."},"fees":{"type":"array","description":"Any fees imposed on this payment.","items":{"$ref":"#/components/schemas/CreateFee"}},"paymentCategory":{"maxLength":255,"minLength":0,"type":"string","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"},"properties":{"type":"array","description":"Key-Value-Pairs of properties of a settlement - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"}}},"description":"Create payment transaction request."},"CreateRestApiSettlementConfig":{"required":["protocolType","settlementSourceId"],"type":"object","description":"Payment account configuration specific for fetching settlements by means of a REST API with OAuth authorization.","allOf":[{"$ref":"#/components/schemas/CreateSettlementConfig"},{"type":"object","properties":{"oAuthClientId":{"type":"string","writeOnly":true},"oAuthClientSecret":{"type":"string","writeOnly":true},"oauthClientSecret":{"type":"string"},"oauthClientId":{"type":"string"}}}]},"CreateRestApiSettlementSource":{"required":["fileType","host","name","protocolType","tokenUrl"],"type":"object","description":"REST API settlement source that except standard properties contains also an URL to obtain an oAuth token.","allOf":[{"$ref":"#/components/schemas/CreateSettlementSource"},{"type":"object","properties":{"tokenUrl":{"type":"string","description":"The token url to authenticate.\nMust not be null."},"connectTimeoutInMillis":{"type":"integer","format":"int32"},"readTimeoutInMillis":{"type":"integer","format":"int32"},"retryFirstBackoffInMillis":{"type":"integer","format":"int32"},"retryMaxAttempts":{"type":"integer","format":"int32"},"retryMaxBackoffInMillis":{"type":"integer","format":"int32"}}}]},"CreateSettlementConfig":{"required":["protocolType","settlementSourceId"],"type":"object","properties":{"settlementSourceId":{"type":"integer","description":"Reference to settlements source.\nMust not be null.","format":"int64"},"protocolType":{"type":"string","description":"Protocol type of this settlement config. Should be the same as protocol of source.\nMust not be null.","enum":["EBICS","SFTP","HTTP"]}},"description":"Abstract payment account configuration type that is used to connect to settlement server via some specified protocol. The supported protocols are: SFTP, EBICS and HTTP.","discriminator":{"propertyName":"protocolType","mapping":{"SFTP":"#/components/schemas/CreateSftpSettlementConfig","EBICS":"#/components/schemas/CreateEbicsSettlementConfig","HTTP":"#/components/schemas/CreateRestApiSettlementConfig"}}},"CreateSettlementIdentCounterDto":{"required":["maxValue","minValue","name"],"type":"object","properties":{"name":{"type":"string","description":"Unique counter name.\nMust not be blank."},"minValue":{"type":"integer","description":"Minimum value, will be used as a starting value for a counter.\nMust not be null.","format":"int64"},"maxValue":{"type":"integer","description":"Maximum value that this counter may reach.\nMust not be null.","format":"int64"},"settlementAttributeValues":{"uniqueItems":true,"type":"array","description":"Set of settlement attribute values, used by ident generation mode.","items":{"type":"string","description":"Set of settlement attribute values, used by ident generation mode."}}},"description":"Set of counters used to generate customer specific settlement idents, based on settlement criteria specified by generation mode."},"CreateSettlementItem":{"required":["baseAmount","bookingDate","creditDebitIndicator","externalIdent"],"type":"object","properties":{"ident":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string","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}'."},"paymentTransactionIdent":{"maxLength":255,"minLength":0,"type":"string","description":"An identifier of a payment transaction which is settled with this settlement item.\nSize must be between 0 and 255."},"creditDebitIndicator":{"type":"string","description":"Indicates whether a settlement item is a DEBIT or CREDIT.\nMust not be null.","enum":["CREDIT","DEBIT"]},"creationDate":{"type":"string","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"},"bookingDate":{"type":"string","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"},"valueDate":{"type":"string","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"},"externalIdent":{"maxLength":255,"minLength":0,"type":"string","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."},"settlementLineNumber":{"type":"integer","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"},"settlementItemIdentifier":{"maxLength":255,"minLength":0,"type":"string","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."},"recipient":{"maxLength":255,"minLength":0,"type":"string","description":"Information about the recipient of a settled payment.\nSize must be between 0 and 255."},"sender":{"maxLength":255,"minLength":0,"type":"string","description":"Information about the sender of a settled payment.\nSize must be between 0 and 255."},"text":{"maxLength":1400,"minLength":0,"type":"string","description":"Any additional information about a settlement item like purpose, description, payment title, etc.\nSize must be between 0 and 1400."},"baseAmount":{"$ref":"#/components/schemas/MoneyDto"},"originalAmount":{"$ref":"#/components/schemas/MoneyDto"},"exchangeRate":{"minimum":0,"exclusiveMinimum":true,"type":"number","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."},"fees":{"type":"array","description":"Any fees imposed on this settlement item.","items":{"$ref":"#/components/schemas/CreateFee"}},"paymentCategory":{"maxLength":255,"minLength":0,"type":"string","description":"Name of a payment category that the payment settled with this settlement item is classified to. Must be one of the categories defined in Nitrobox, otherwise the settlement item will be rejected.\nSize must be between 0 and 255.","default":"UNCATEGORISED"},"properties":{"type":"array","description":"Key-value-pairs of properties of a settlement - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"}},"batchItems":{"type":"array","description":"Sub items that are batched together in this settlement item. If specified, their sum must match the settlement item.","items":{"$ref":"#/components/schemas/BatchItem"}}},"description":"Create settlement item request."},"CreateSettlementReportDto":{"required":["fileName","ident","statementCreationDate","statementReference"],"type":"object","properties":{"ident":{"maxLength":255,"minLength":0,"type":"string","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."},"statementReference":{"maxLength":255,"minLength":0,"type":"string","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."},"statementCreationDate":{"type":"string","description":"A date when the settlement statement was created by a Payment Service Provider or a bank.\nMust not be null.","format":"date-time"},"fileName":{"maxLength":255,"minLength":0,"type":"string","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."}},"description":"Settlement report for given account ident."},"CreateSettlementSource":{"required":["fileType","host","name","protocolType"],"type":"object","properties":{"name":{"maxLength":255,"minLength":0,"type":"string","description":"Human readable name.\nMust not be null.\nSize must be between 0 and 255."},"protocolType":{"type":"string","description":"Protocol type of this settlement source.\nMust not be null.","enum":["EBICS","SFTP","HTTP"]},"fileType":{"type":"string","description":"Format of files that are fetched from the source.\nMust not be null.","enum":["CSV","EPA","CAMT53","CAMT54","MT940"]},"host":{"maxLength":255,"minLength":0,"type":"string","description":"Host of the source server.\nMust not be null.\nSize must be between 0 and 255."},"port":{"type":"integer","description":"Port of the source server.","format":"int32"}},"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":{"propertyName":"protocolType","mapping":{"SFTP":"#/components/schemas/CreateSftpSettlementSource","EBICS":"#/components/schemas/CreateEbicsSettlementSource","HTTP":"#/components/schemas/CreateRestApiSettlementSource"}}},"CreateSettlementsProcessingScheduleDto":{"required":["cronExpression"],"type":"object","properties":{"cronExpression":{"maxLength":255,"minLength":0,"type":"string","description":"Must not be null.\nSize must be between 0 and 255."}},"description":"A schedule specifying the time when settlement statements from this account will be loaded from PSP and processed."},"CreateSftpSettlementConfig":{"required":["credentials","protocolType","remoteDirectory","settlementSourceId"],"type":"object","description":"Payment account configuration specific for fetching settlements from sftp server.","allOf":[{"$ref":"#/components/schemas/CreateSettlementConfig"},{"type":"object","properties":{"remoteDirectory":{"maxLength":255,"minLength":0,"type":"string","description":"Must not be null.\nSize must be between 0 and 255."},"credentials":{"$ref":"#/components/schemas/CreateCredentialsDto"}}}]},"CreateSftpSettlementSource":{"required":["fileType","host","name","protocolType"],"type":"object","description":"Sftp settlement source that except standard properties contains also path to remote directory on the server.","allOf":[{"$ref":"#/components/schemas/CreateSettlementSource"}]},"CredentialsDto":{"type":"object","properties":{"username":{"type":"string"}}},"CustomerPaymentAccountCreationRequest":{"required":["debtorIdent","merchantPaymentGatewayIdent","paymentMethod","paymentProviderReference"],"type":"object","properties":{"debtorIdent":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string","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"},"displayName":{"maxLength":255,"minLength":0,"type":"string","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."},"paymentMethod":{"type":"string","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 not be null.","example":"DIRECT_DEBIT","enum":["DIRECT_DEBIT","CREDIT_CARD","PAY_PAL"]},"paymentMethodReference":{"maxLength":255,"minLength":0,"type":"string","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"},"paymentProviderReference":{"maxLength":255,"minLength":0,"type":"string","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"},"accountHolderName":{"maxLength":255,"minLength":0,"type":"string","description":"Account holder name used for the charging.\nSize must be between 0 and 255.","example":"John Doe"},"accountCreationDate":{"type":"string","description":"Date when the payment account was created at the payment provider. Required e.g. for some external mandate managements in the SEPA environment.","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"ident":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string","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}'."},"merchantPaymentGatewayIdent":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string","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"},"name":{"maxLength":255,"minLength":0,"type":"string","description":"DEPRECATED.\nSize must be between 0 and 255.","deprecated":true}},"description":"Please see CustomerPaymentAccountRequestDto Model below for more information regarding required values and input type."},"CustomerPaymentAccountRequest":{"required":["merchantPaymentGatewayIdent","paymentMethod","paymentProviderReference"],"type":"object","properties":{"displayName":{"maxLength":255,"minLength":0,"type":"string","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."},"paymentMethod":{"type":"string","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 not be null.","example":"DIRECT_DEBIT","enum":["DIRECT_DEBIT","CREDIT_CARD","PAY_PAL"]},"paymentMethodReference":{"maxLength":255,"minLength":0,"type":"string","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"},"paymentProviderReference":{"maxLength":255,"minLength":0,"type":"string","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"},"accountHolderName":{"maxLength":255,"minLength":0,"type":"string","description":"Account holder name used for the charging.\nSize must be between 0 and 255.","example":"John Doe"},"accountCreationDate":{"type":"string","description":"Date when the payment account was created at the payment provider. Required e.g. for some external mandate managements in the SEPA environment.","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"merchantPaymentGatewayIdent":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string","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"},"name":{"maxLength":255,"minLength":0,"type":"string","description":"DEPRECATED.\nSize must be between 0 and 255.","deprecated":true}},"description":"Please see CustomerPaymentAccountRequestDto Model below for more information regarding required values and input type."},"CustomerPaymentAccountResponse":{"required":["debtorIdent","ident","merchantPaymentGatewayIdent","paymentMethod","paymentProviderReference"],"type":"object","properties":{"tenantId":{"type":"integer","description":"Unique internal reference to identify the Tenant.","format":"int64","example":1},"ident":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string","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"},"debtorIdent":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string","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"},"displayName":{"maxLength":255,"minLength":0,"type":"string","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."},"paymentMethod":{"type":"string","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 not be null.","example":"DIRECT_DEBIT","enum":["DIRECT_DEBIT","CREDIT_CARD","PAY_PAL"]},"paymentMethodReference":{"maxLength":255,"minLength":0,"type":"string","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"},"paymentProviderReference":{"maxLength":255,"minLength":0,"type":"string","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"},"accountHolderName":{"maxLength":255,"minLength":0,"type":"string","description":"Account holder name used for the charging.\nSize must be between 0 and 255.","example":"John Doe"},"accountCreationDate":{"type":"string","description":"Date when the payment account was created at the payment provider. Required e.g. for some external mandate managements in the SEPA environment.","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"healthStatus":{"type":"string","description":"Health status of this customer payment account.","example":"GOOD","enum":["GOOD","AVERAGE","POOR"]},"merchantPaymentGatewayIdent":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string","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"}},"description":"A CustomerPaymentAccount with payment details that is assigned to a specific debtorIdent. "},"EbicsSettlementConfig":{"required":["id","protocolType","settlementSourceId"],"type":"object","description":"Ebics settlement source that except standard properties contains also host id of the bank.","allOf":[{"$ref":"#/components/schemas/SettlementConfig"}]},"EbicsSettlementSource":{"required":["fileType","hostId","id","name","protocolType"],"type":"object","description":"Ebics settlement source that except standard properties contains also host id of the bank.","allOf":[{"$ref":"#/components/schemas/SettlementSource"},{"type":"object","properties":{"hostId":{"type":"string","description":"The host id of the bank.\nMust not be null."}}}]},"ExchangeRate":{"type":"object","properties":{"originalCurrency":{"type":"string","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"]},"targetCurrency":{"type":"string","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"]},"value":{"type":"number"}},"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. "},"Fee":{"type":"object","properties":{"type":{"type":"string","description":"Type of a fee.","enum":["COMMISSION","MARKUP","SCHEME_FEES","INTERCHANGE","STANDARD_FEE"]},"amount":{"$ref":"#/components/schemas/MoneyDto"},"id":{"type":"integer","description":"DEPRECATED.\nAlways null","format":"int32","deprecated":true}},"description":"Fee response body."},"GlobalErrorResponse":{"type":"object","properties":{"status":{"type":"string","description":"textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400"},"message":{"type":"string","description":"message describing the error"},"timestamp":{"type":"string","description":"timestamp in UTC when the error occurred","format":"date-time"},"path":{"type":"string","description":"URL path where the error occurred"},"uuid":{"type":"string","description":"UUID generated by the server to identify the error occurred, should be stated in case of any inquiries","format":"uuid"},"errors":{"type":"array","description":"optional list of multiple errors occurred","items":{"type":"object"}}},"description":"error response providing details about the error occurred"},"JobInfoObject":{"type":"object","properties":{"jobKey":{"type":"string"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/TriggerInfo"}}}},"MerchantPaymentAccount":{"required":["active","country","currency","name","paymentServiceProviderId"],"type":"object","properties":{"id":{"type":"integer","description":"Unique id of the MerchantPaymentAccount","format":"int64"},"ident":{"type":"string","description":"Unique external reference for the MerchantPaymentAccount"},"name":{"type":"string","description":"Must not be blank."},"currency":{"type":"string","description":"The currency used for this MerchantPaymentAccount. Must be one of:.\nMust not be null.","example":"EUR","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"]},"additionallyAcceptedCurrencies":{"uniqueItems":true,"type":"array","description":"List of currencies accepted by the MerchantPaymentAccount in addition to the base currency.","items":{"type":"string","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"]}},"country":{"type":"string","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","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"paymentServiceProviderId":{"type":"integer","description":"Must not be null.","format":"int64"},"settlementConfig":{"oneOf":[{"$ref":"#/components/schemas/SettlementConfig"},{"$ref":"#/components/schemas/EbicsSettlementConfig"},{"$ref":"#/components/schemas/SftpSettlementConfig"}]},"settlementSourceId":{"type":"integer","format":"int64"},"active":{"type":"boolean","description":"Specifies if a MerchantPaymentAccount is active, that means if payments from this account are processed in system.\nMust not be null."},"settlementsCreationDisabled":{"type":"boolean","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."},"settlementsProcessingSchedule":{"$ref":"#/components/schemas/SettlementsProcessingScheduleDto"},"paymentCollectionConfig":{"$ref":"#/components/schemas/PaymentCollectionConfig"}},"description":"A MerchantPaymentAccount representing an Account kept by a bank/PSP on behalf of its customer."},"MerchantPaymentAccountInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Deprecated. Legacy attribute.","format":"int64"},"ident":{"type":"string","description":"Unique payment account identifier."},"name":{"type":"string","description":"Merchant payment account name."},"currency":{"type":"string","description":"Base currency of a Payment Account. Three letters ISO-4217 format.","example":"EUR","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"]},"acceptedCurrencies":{"uniqueItems":true,"type":"array","description":"The currency used for this MerchantPaymentAccount. Must be one of:","example":"EUR","items":{"type":"string","description":"The currency used for this MerchantPaymentAccount. Must be one of:","example":"EUR","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"]}},"country":{"type":"string","description":"Country of a Payment Account. Two letters ISO 3166-1 alpha-2 format","example":"DE","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"paymentProvider":{"type":"string","description":"One of Payment Provider types supported in Nitrobox.","enum":["ADYEN","CONTOWORKS","COMMERZBANK","GOCARDLESS","KLARNA","MOLLIE","OPTILE","STRIPE","VWFS_SMARTPAY","WORLDLINE","OTHER"]},"paymentProviderName":{"type":"string","description":"The name of the Payment Provider that the account belongs to."}},"description":"A merchant payment account kept by a bank/PSP on behalf of its customer."},"MerchantPaymentGateway":{"required":["ident","name","paymentServiceProviderId"],"type":"object","properties":{"ident":{"maxLength":255,"minLength":0,"type":"string","description":"Unique external reference for the MerchantPaymentGateway.\nMust not be blank.\nSize must be between 0 and 255."},"name":{"maxLength":255,"minLength":0,"type":"string","description":"Must not be blank.\nSize must be between 0 and 255."},"currencyToAccountMapping":{"type":"object","additionalProperties":{"type":"string","description":"List of Assignments consisting of a CurrencyCode and an ident of a MerchantPaymentAccount used for routing, e.g. \"PLN\": \"MerchantPaymentAccountIdent\"."},"description":"List of Assignments consisting of a CurrencyCode and an ident of a MerchantPaymentAccount used for routing, e.g. \"PLN\": \"MerchantPaymentAccountIdent\"."},"paymentServiceProviderId":{"type":"integer","description":"Must not be null.","format":"int64"},"paymentProvider":{"$ref":"#/components/schemas/PaymentServiceProviderDto"}},"description":"A MerchantPaymentGateway is used to route PaymentIntents to a MerchantPaymentAccount based on the currency."},"MoneyDto":{"required":["amount","currency"],"type":"object","properties":{"amount":{"type":"number","description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56},"currency":{"type":"string","description":"Currency code. Three letters ISO-4217 format.\nMust not be null.","example":"EUR","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"]}},"description":"A monetary amount with an amount and a currency."},"PageInfo":{"type":"object","properties":{"size":{"type":"integer","description":"Size of the page as specified by the query.","format":"int32"},"number":{"type":"integer","description":"Page number of total pages available.","format":"int32"},"totalElements":{"type":"integer","description":"Total count of all elements available for the query.","format":"int64"},"totalPages":{"type":"integer","description":"Total count of all pages available for the query.","format":"int32"}}},"Pageable":{"type":"object","properties":{"page":{"minimum":0,"type":"integer","description":"Must be greater than or equal to 0.","format":"int32"},"size":{"minimum":1,"type":"integer","description":"Must be greater than or equal to 1.","format":"int32"},"sort":{"type":"array","items":{"type":"string"}}}},"PagedResponseCategorizationRuleResponse":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageInfo"},"_embedded":{"type":"array","description":"Result list.","items":{"$ref":"#/components/schemas/CategorizationRuleResponse"}}},"description":"List of result elements with paging metadata."},"PagedResponseCustomerPaymentAccountResponse":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageInfo"},"_embedded":{"type":"array","description":"Result list.","items":{"$ref":"#/components/schemas/CustomerPaymentAccountResponse"}}},"description":"List of result elements with paging metadata."},"PagedResponseMerchantPaymentAccount":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageInfo"},"_embedded":{"type":"array","description":"Result list.","items":{"$ref":"#/components/schemas/MerchantPaymentAccount"}}},"description":"List of result elements with paging metadata."},"PagedResponseMerchantPaymentGateway":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageInfo"},"_embedded":{"type":"array","description":"Result list.","items":{"$ref":"#/components/schemas/MerchantPaymentGateway"}}},"description":"List of result elements with paging metadata."},"PagedResponsePaymentIntentDto":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageInfo"},"_embedded":{"type":"array","description":"Result list.","items":{"$ref":"#/components/schemas/PaymentIntentDto"}}},"description":"List of result elements with paging metadata."},"PagedResponsePaymentIntentTaskDto":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageInfo"},"_embedded":{"type":"array","description":"Result list.","items":{"$ref":"#/components/schemas/PaymentIntentTaskDto"}}},"description":"List of result elements with paging metadata."},"PagedResponsePaymentTransactionDto":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageInfo"},"_embedded":{"type":"array","description":"Result list.","items":{"$ref":"#/components/schemas/PaymentTransactionDto"}}},"description":"List of result elements with paging metadata."},"PagedResponseSettlement":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageInfo"},"_embedded":{"type":"array","description":"Result list.","items":{"$ref":"#/components/schemas/Settlement"}}},"description":"List of result elements with paging metadata."},"PagedResponseSettlementReport":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageInfo"},"_embedded":{"type":"array","description":"Result list.","items":{"$ref":"#/components/schemas/SettlementReport"}}},"description":"List of result elements with paging metadata."},"PagedResponseSettlementReportWithMerchantPaymentAccount":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageInfo"},"_embedded":{"type":"array","description":"Result list.","items":{"$ref":"#/components/schemas/SettlementReportWithMerchantPaymentAccount"}}},"description":"List of result elements with paging metadata."},"PagedResultsList.":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageInfo"},"_embedded":{"type":"array","description":"Results list","items":{"$ref":"#/components/schemas/PaymentCategory"}}},"description":"List of result elements and a paging metadata."},"PaymentCategorizationConfigDto":{"required":["enabled","id","paymentCategory","strategy","strategyProperties"],"type":"object","properties":{"id":{"type":"integer","description":"Must not be null.","format":"int64"},"strategy":{"type":"string","description":"Must not be null.","enum":["CAMT_GVC_CODE_STRATEGY","CAMT_DEBTOR_GVC_CODE_STRATEGY","CAMT_DESCRIPTION_GVC_CODE_STRATEGY"]},"strategyProperties":{"type":"object","additionalProperties":{"type":"string"},"description":"Must not be null."},"enabled":{"type":"boolean","description":"Must not be null."},"paymentCategory":{"$ref":"#/components/schemas/PaymentCategory"}}},"PaymentCategory":{"required":["assignable","id","name"],"type":"object","properties":{"id":{"type":"integer","description":"Must not be null.","format":"int64"},"name":{"type":"string","description":"Unique category name.\nMust not be null."},"assignable":{"type":"boolean","description":"Specifies if a payment of this category can be assigned to an invoice or a creditmemo.\nMust not be null."}},"description":"Category which a payment can be classified into."},"PaymentCollectionConfig":{"required":["charging","payout","refund"],"type":"object","properties":{"charging":{"type":"string","description":"Defines when charging shall be triggered.\nMust not be null.\nMust be one of:\n
IMMEDIATELY |
ON_DOCUMENT_DUE_DATE |
","example":"IMMEDIATELY"},"refund":{"type":"string","description":"Defines when refund shall be triggered.\nMust not be null.\nMust be one of:\nIMMEDIATELY |
ON_DOCUMENT_DUE_DATE |
","example":"IMMEDIATELY"},"payout":{"type":"string","description":"Defines when a payout shall be triggered.\nMust not be null.\nMust be one of:\nIMMEDIATELY |
ON_DOCUMENT_DUE_DATE |
","example":"IMMEDIATELY"}},"description":"A PaymentCollectionConfig is used to define the date of the payment collection."},"PaymentIntentCreationRequest":{"required":["amount","billingGroupIdent","customerPaymentAccountIdent","ident","type"],"type":"object","properties":{"ident":{"type":"string","description":"An unique identifier of PaymentIntent.\nMust not be null."},"amount":{"$ref":"#/components/schemas/MoneyDto"},"referenceKey":{"type":"string","description":"DEPRECATED.\nType of the referenced entity. Please use referenceType","example":"DOCUMENT","deprecated":true},"referenceType":{"type":"string","description":"Type of the referenced entity.","example":"DOCUMENT"},"referenceIdent":{"type":"string","description":"An identifier of the referenced entity."},"statementDescriptor":{"type":"string","description":"The descriptor of resulting Statement."},"type":{"type":"string","description":"The type of PaymentIntent.\nMust not be null.","enum":["CHARGING","REFUND","PAYOUT"]},"customerPaymentAccountIdent":{"type":"string","description":"An unique identifier of CustomerPaymentAccount.\nMust not be null."},"billingGroupIdent":{"type":"string","description":"An identifier of business segment.\nMust not be null."},"businessSegmentIdent":{"type":"string","description":"An identifier of business segment. DEPRECATED: use billingGroupIdent","deprecated":true}}},"PaymentIntentDetailsDto":{"type":"object","properties":{"ident":{"type":"string","description":"An identifier of this PaymentIntent."},"amount":{"$ref":"#/components/schemas/MoneyDto"},"referenceKey":{"type":"string","description":"DEPRECATED.\nType of the referenced entity. Please use referenceType","example":"DOCUMENT","deprecated":true},"referenceType":{"type":"string","description":"Type of the referenced entity.","example":"DOCUMENT"},"referenceIdent":{"type":"string","description":"An identifier of the referenced entity."},"statementDescriptor":{"type":"string","description":"The descriptor to be used for the PaymentIntent."},"type":{"type":"string","description":"The type of PaymentIntent.","enum":["CHARGING","REFUND","PAYOUT"]},"paymentTransaction":{"$ref":"#/components/schemas/PaymentTransactionDto"},"dateCreated":{"type":"string","description":"The creation date of PaymentIntent.","format":"date-time"},"dateModified":{"type":"string","description":"The creation date of PaymentIntent.","format":"date-time"},"status":{"type":"string","description":"Current PaymentIntentStatus.","enum":["CREATED","IN_PROGRESS","RETRY","FAILED","SUBMITTED","CANCELLED","PROCESSED"]},"billingGroupIdent":{"type":"string","description":"An identifier of a billing group."},"customerPaymentAccountDto":{"$ref":"#/components/schemas/CustomerPaymentAccountResponse"},"paymentIntentResponse":{"type":"array","items":{"$ref":"#/components/schemas/PaymentIntentResponseDto"}},"businessSegmentIdent":{"type":"string","description":"An identifier of business segment. DEPRECATED: use billingGroupIdent","deprecated":true}},"description":"A PaymentIntent is an intent to move an amount from one account to another within a PSP. The PaymentIntentDetail contains additional CustomerPaymentAccount data."},"PaymentIntentDto":{"type":"object","properties":{"ident":{"type":"string","description":"An identifier of this PaymentIntent."},"amount":{"$ref":"#/components/schemas/MoneyDto"},"referenceKey":{"type":"string","description":"DEPRECATED.\nType of the referenced entity. Please use referenceType","example":"DOCUMENT","deprecated":true},"referenceType":{"type":"string","description":"Type of the referenced entity.","example":"DOCUMENT"},"referenceIdent":{"type":"string","description":"An identifier of the referenced entity."},"statementDescriptor":{"type":"string","description":"The descriptor to be used for the PaymentIntent."},"type":{"type":"string","description":"The type of PaymentIntent.","enum":["CHARGING","REFUND","PAYOUT"]},"paymentTransaction":{"$ref":"#/components/schemas/PaymentTransactionDto"},"merchantPaymentAccountIdent":{"type":"string","description":"An unique identifier of the merchants PaymentAccount."},"dateCreated":{"type":"string","description":"The creation date of PaymentIntent.","format":"date-time"},"dateModified":{"type":"string","description":"The creation date of PaymentIntent.","format":"date-time"},"status":{"type":"string","description":"Current PaymentIntentStatus.","enum":["CREATED","IN_PROGRESS","RETRY","FAILED","SUBMITTED","CANCELLED","PROCESSED"]},"customerPaymentAccountIdent":{"type":"string","description":"An identifier of customer PaymentChargingAccount."},"billingGroupIdent":{"type":"string","description":"An identifier of a billing group."},"paymentIntentResponse":{"type":"array","items":{"$ref":"#/components/schemas/PaymentIntentResponseDto"}},"businessSegmentIdent":{"type":"string","description":"An identifier of business segment. DEPRECATED: use billingGroupIdent","deprecated":true}},"description":"A PaymentIntent is an intent to move an amount from one account to another within a PSP."},"PaymentIntentResponseDto":{"required":["bookingDate","valueDate"],"type":"object","properties":{"ident":{"type":"string","description":"Unique identifier of the payment intent response."},"paymentIntentIdent":{"type":"string","description":"Identifier of the corresponding payment intent."},"externalIdent":{"type":"string","description":"External reference that needs to be unique within a payment account. Generally it is provided by a Payment Service Provider or a bank."},"customerSpecificIdent":{"type":"string","description":"Is an optional customer specific ident, that can be used to identify this payment transaction."},"status":{"type":"string","description":"Outcome of the processing at the PSP.","enum":["SUCCEEDED","FAILED","INFO"]},"statusMessage":{"type":"string","description":"Optional message about the outcome of the processing at the PSP."},"bookingDate":{"type":"string","description":"The date of the account transaction. ISO 8601 date time format. ","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"valueDate":{"type":"string","description":"The date on which the account transaction takes effect. ISO 8601 date time format. ","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"creationDate":{"type":"string","description":"The date of a creation of a payment. ISO 8601 date time format. ","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"baseAmount":{"$ref":"#/components/schemas/MoneyDto"},"originalAmount":{"$ref":"#/components/schemas/MoneyDto"},"exchangeRate":{"type":"number","description":"Exchange rate used to calculate original and base amounts."},"categoryName":{"type":"string","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"},"sender":{"type":"string","description":"The sender of the payment transfer."},"recipient":{"type":"string","description":"The recipient of the payment transfer"}},"description":"A PaymentIntentResponse is the relayed answer from the PSP to this specific PaymentIntent."},"PaymentIntentTaskDto":{"required":["amount","billingGroupIdent","creditDebitIndicator","currency","customerPaymentAccountIdent","dueDate","ident","oposCaseIdent","oposCaseVersion","paymentIntentType","referenceIdent","referenceType","status","version"],"type":"object","properties":{"ident":{"type":"string","description":"An identifier of this PaymentIntentTask."},"version":{"type":"integer","description":"Current version of this PaymentIntentTask.","format":"int64"},"status":{"type":"string","description":"Current status of this PaymentIntentTask.","enum":["WAITING_FOR_DUE_DATE","PROCESSED","CANCELLED","FAILED"]},"dueDate":{"type":"string","description":"Due date of this PaymentIntentTask. The Date on which en Payment Intent will be created if the status is still fine.","format":"date"},"amount":{"type":"number","description":"Current amount of this PaymentIntentTask. Can change until the due date, depending on other events, e.g., partial creditmemos."},"creditDebitIndicator":{"type":"string","description":"CreditDebitIndicator of this PaymentIntentTask.\nMust be one of:\n"},"currency":{"type":"string","description":"Currency of this PaymentIntentTask.\nMust be one of:\nUNDEFINED |
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 |
"},"customerPaymentAccountIdent":{"type":"string","description":"CustomerPaymentAccountIdent which will be used for the resulting PaymentIntent."},"referenceIdent":{"type":"string","description":"Current referenced ident of this PaymentIntentTask."},"referenceType":{"type":"string","description":"Current referenced type of this PaymentIntentTask.\nMust be one of:\n"},"oposCaseIdent":{"type":"string","description":"OposCase Ident related to this PaymentIntentTask."},"oposCaseVersion":{"type":"integer","description":"latest known Version of the OposCase related to this PaymentIntentTask.","format":"int64"},"billingGroupIdent":{"type":"string","description":"BillingGroupIdent related to this PaymentIntentTask."},"paymentIntentType":{"type":"string","description":"Resulting PaymentIntentType.\nMust be one of:\n"},"paymentIntentIdent":{"type":"string","description":"Ident of the PaymentInten, if a paymentIntent was created on due date."}},"description":"A PaymentIntentTask can create a payment intent, depending of its status at the due date."},"PaymentServiceProviderDto":{"required":["name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","description":"Must not be blank."},"type":{"type":"string","enum":["ADYEN","CONTOWORKS","COMMERZBANK","GOCARDLESS","KLARNA","MOLLIE","OPTILE","STRIPE","VWFS_SMARTPAY","WORLDLINE","OTHER"]},"settlementSources":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/SettlementSource"},{"$ref":"#/components/schemas/EbicsSettlementSource"},{"$ref":"#/components/schemas/SftpSettlementSource"}]}}}},"PaymentTransactionCreatedDto":{"required":["baseAmount","bookingDate","creditDebitIndicator","history","status","valueDate"],"type":"object","properties":{"ident":{"type":"string","description":"An identifier of a payment transaction generated by Nitrobox."},"externalIdent":{"type":"string","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"},"customerSpecificIdent":{"type":"string","description":"Is an optional customer specific ident, that can be used to identify this payment transaction.","example":"2593935f-cf9a-4a53-b754-ee92d91b82ef"},"status":{"type":"string","description":"The status this payment transaction is in.","example":"CAPTURED","enum":["RECEIVED","ERROR","REFUSED","AUTHORIZED","EXPIRED","CANCELLED","CAPTURED","CAPTURE_FAILED","SETTLED","REFUNDED","CHARGEBACK"]},"creditDebitIndicator":{"type":"string","description":"A description, whether this payment transaction is a DEBIT, removing money from the account or a CREDIT, adding money to the account.","example":"DEBIT","enum":["CREDIT","DEBIT"]},"baseAmount":{"$ref":"#/components/schemas/MoneyDto"},"originalAmount":{"$ref":"#/components/schemas/MoneyDto"},"exchangeRate":{"$ref":"#/components/schemas/ExchangeRate"},"bookingDate":{"type":"string","description":"The date of the account transaction. ISO 8601 date time format. ","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"valueDate":{"type":"string","description":"The date on which the account transaction takes effect. ISO 8601 date time format. ","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"creationDate":{"type":"string","description":"The date of a creation of a payment. ISO 8601 date time format. ","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"recipient":{"type":"string","description":"The recipient of the payment transfer"},"sender":{"type":"string","description":"The sender of the payment transfer."},"text":{"type":"string","description":"Any additional information about a payment like purpose, description, payment title, etc. This is often used for matching the payment to a document."},"fees":{"type":"array","description":"Any fees imposed on this payment.","items":{"$ref":"#/components/schemas/PaymentTransactionFeeDto"}},"paymentCategory":{"type":"string","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"},"assignmentStatus":{"type":"string","description":"The status describing whether a payment is assigned to any document.","enum":["UNASSIGNED","PARTIALLY_ASSIGNED","COMPLETELY_ASSIGNED"]},"assignableLeftoverAmount":{"$ref":"#/components/schemas/MoneyDto"},"history":{"type":"array","description":"History of this payment transaction","items":{"$ref":"#/components/schemas/PaymentTransactionHistory"}},"properties":{"type":"array","description":"Key-Value-Pairs of properties of a settlement - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"}}}},"PaymentTransactionDto":{"required":["baseAmount","bookingDate","creditDebitIndicator","history","paymentStatus","valueDate"],"type":"object","properties":{"id":{"type":"integer","description":"Deprecated. Legacy attribute.","format":"int64"},"ident":{"type":"string","description":"An identifier of a payment transaction generated by Nitrobox."},"externalIdent":{"type":"string","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"},"customerSpecificIdent":{"type":"string","description":"Is an optional customer specific ident, that can be used to identify this payment transaction.","example":"2593935f-cf9a-4a53-b754-ee92d91b82ef"},"creditDebitIndicator":{"type":"string","description":"A description, whether this payment transaction is a DEBIT, removing money from the account or a CREDIT, adding money to the account.","example":"DEBIT","enum":["CREDIT","DEBIT"]},"tenantId":{"type":"integer","description":"Deprecated. Legacy attribute.","format":"int32"},"paymentDescription":{"type":"string","description":"Any additional information about a payment like purpose, description, payment title, etc. This is often used for matching the payment to a document."},"paymentStatus":{"type":"string","description":"The status this payment transaction is in.","example":"CAPTURED","enum":["RECEIVED","ERROR","REFUSED","AUTHORIZED","EXPIRED","CANCELLED","CAPTURED","CAPTURE_FAILED","SETTLED","REFUNDED","CHARGEBACK"]},"baseAmount":{"$ref":"#/components/schemas/MoneyDto"},"originalAmount":{"$ref":"#/components/schemas/MoneyDto"},"exchangeRate":{"$ref":"#/components/schemas/ExchangeRate"},"paymentAccount":{"$ref":"#/components/schemas/MerchantPaymentAccountInfo"},"merchantPaymentAccount":{"$ref":"#/components/schemas/MerchantPaymentAccountInfo"},"settlementIdent":{"type":"string","description":"Unique identifier of a settlement, connected to this payment transaction, autogenerated by Nitrobox."},"settlementCustomerSpecificIdent":{"type":"string","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"},"data":{"type":"string","description":"Deprecated. Legacy attribute."},"bookingDate":{"type":"string","description":"The date of the account transaction. ISO 8601 date time format. ","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"valueDate":{"type":"string","description":"The date on which the account transaction takes effect. ISO 8601 date time format. ","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"creationDate":{"type":"string","description":"The date of a creation of a payment. ISO 8601 date time format. ","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"recipient":{"type":"string","description":"The recipient of the payment transfer"},"sender":{"type":"string","description":"The sender of the payment transfer."},"category":{"$ref":"#/components/schemas/PaymentCategory"},"previousCategory":{"$ref":"#/components/schemas/PaymentCategory"},"fees":{"type":"array","description":"Any fees imposed on this payment.","items":{"$ref":"#/components/schemas/PaymentTransactionFeeDto"}},"statementReference":{"type":"string","description":"Deprecated. Legacy attribute."},"assignmentStatus":{"type":"string","description":"The status describing whether a payment is assigned to any document.","enum":["UNASSIGNED","PARTIALLY_ASSIGNED","COMPLETELY_ASSIGNED"]},"assignableLeftoverAmount":{"$ref":"#/components/schemas/MoneyDto"},"history":{"type":"array","description":"History of this payment transaction","items":{"$ref":"#/components/schemas/PaymentTransactionHistory"}},"paymentIntentIdent":{"type":"string","description":"Payment intent ident, if a Payment was created out of this payment intent otherwise empty."},"properties":{"type":"array","description":"Key-Value-Pairs of properties of a settlement - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"}},"batchItems":{"type":"array","description":"Batch items of this transaction","items":{"$ref":"#/components/schemas/BatchItem"}}},"description":"A payment transaction describes a financial transaction that happened on a payment account."},"PaymentTransactionFeeDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["COMMISSION","MARKUP","SCHEME_FEES","INTERCHANGE","STANDARD_FEE"]},"amount":{"$ref":"#/components/schemas/MoneyDto"},"description":{"type":"string"}},"description":"Any fees imposed on this payment."},"PaymentTransactionHistory":{"required":["changeDate","status"],"type":"object","properties":{"changeDate":{"type":"string","description":"Date of the change","format":"date-time"},"status":{"type":"string","description":"The status this payment transaction was in.","example":"CAPTURED","enum":["RECEIVED","ERROR","REFUSED","AUTHORIZED","EXPIRED","CANCELLED","CAPTURED","CAPTURE_FAILED","SETTLED","REFUNDED","CHARGEBACK"]}},"description":"Entry in the history of a payment transaction"},"PropertyDto":{"required":["propertyIdent","propertyValue"],"type":"object","properties":{"propertyIdent":{"type":"string","description":"Key of the property.\nMust not be blank."},"propertyValue":{"type":"string","description":"Value of the property.\nMust not be null."}},"description":"A property is a key-value pair that can be used to extend the entity with additional custom data as needed."},"Settlement":{"type":"object","properties":{"id":{"type":"integer","description":"DEPRECATED.\nDatabase identifier of a settlement, autogenerated by Nitrobox.","format":"int64","deprecated":true},"ident":{"type":"string","description":"Unique identifier of a settlement, autogenerated by Nitrobox."},"paymentTransactionIdent":{"type":"string","description":"An identifier of a payment transaction which is settled with this settlement."},"creditDebitIndicator":{"type":"string","description":"Indicates whether a settlement is a DEBIT or CREDIT.","enum":["CREDIT","DEBIT"]},"creationDate":{"type":"string","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"},"bookingDate":{"type":"string","description":"The date of the account transaction, in UTC. ISO 8601 date time format. E.g. 2021-03-19T13:34:01Z.","format":"date-time"},"valueDate":{"type":"string","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"},"externalIdent":{"type":"string","description":"A settlement identifier, unique within a payment account. May be provided by a PSP or autogenerated by Nitrobox."},"customerSpecificIdent":{"type":"string","description":"An additional identifier, provided by Nitrobox according to tenant specific rules."},"settlementReportIdent":{"type":"string","description":"An identifier of a settlement report this settlement is a part of."},"settlementLineNumber":{"type":"integer","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"},"settlementIdentifier":{"type":"string","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 identifier should allow to unambiguously specify a place of a settlement in this document."},"recipient":{"type":"string","description":"Information about the recipient of a settlement."},"sender":{"type":"string","description":"Information about the sender of a settlement."},"text":{"type":"string","description":"Any additional information about a settlement like purpose, description, payment title, etc."},"baseAmount":{"$ref":"#/components/schemas/MoneyDto"},"originalAmount":{"$ref":"#/components/schemas/MoneyDto"},"exchangeRate":{"type":"number","description":"Exchange rate of an original currency to the base currency. The rate should fulfill following calculation: originalAmount / exchangeRate = baseAmount."},"merchantPaymentAccountId":{"type":"integer","description":"DEPRECATED.\nDatabase identifier of a payment account that this settlement belongs to.","format":"int64","deprecated":true},"merchantPaymentAccountIdent":{"type":"string"},"merchantPaymentAccountName":{"type":"string"},"fees":{"type":"array","description":"Any fees imposed on this settlement.","items":{"$ref":"#/components/schemas/Fee"}},"paymentCategory":{"type":"string","description":"Name of a payment category this settlement is classified to."},"settlementFileId":{"type":"integer","description":"Database identifier of a settlement report this settlement is a part of.","format":"int64"},"properties":{"type":"array","description":"Key-Value-Pairs of properties of a settlement - i.e. 'GVC':'166'","items":{"$ref":"#/components/schemas/PropertyDto"}},"batchItems":{"type":"array","description":"Batch items of this settlement","items":{"$ref":"#/components/schemas/BatchItem"}},"statementReferenceType":{"type":"string","description":"DEPRECATED! WILL BE REMOVED!","enum":["BATCH_NR","BATCH_ID","FILE_NAME","SINGLE_SETTLEMENT_STATEMENT_ID","STMT_ID"]},"statementReference":{"type":"string","description":"DEPRECATED! WILL BE REMOVED!"},"statementCreationDate":{"type":"string","description":"DEPRECATED! WILL BE REMOVED!","format":"date-time"}},"description":"Settlement response body."},"SettlementConfig":{"required":["id","protocolType","settlementSourceId"],"type":"object","properties":{"id":{"type":"integer","description":"Unique id of the SettlementConfig.\nMust not be null.","format":"int64"},"settlementSourceId":{"type":"integer","description":"Must not be null.","format":"int64"},"protocolType":{"type":"string","description":"Protocol type of this SettlementConfig.\nMust not be null.","enum":["EBICS","SFTP","HTTP"]}},"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":{"propertyName":"protocolType","mapping":{"SFTP":"#/components/schemas/SftpSettlementConfig","EBICS":"#/components/schemas/EbicsSettlementConfig"}}},"SettlementIdentConfigurationDto":{"type":"object","properties":{"generationMode":{"type":"string","enum":["COUNTER_BY_PAYMENT_CATEGORY","COUNTER_BY_CURRENCY","SIMPLE_COUNTER","NO_IDENT"]},"counters":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/SettlementIdentCounterDto"}}}},"SettlementIdentCounterDto":{"type":"object","properties":{"name":{"type":"string","description":"Unique counter name"},"settlementAttributeValue":{"type":"string"},"minValue":{"type":"integer","description":"Minimum value, will be used as a starting value for a counter.","format":"int64"},"nextValue":{"type":"integer","description":"Next value that will be returned from a counter.","format":"int64"},"maxValue":{"type":"integer","description":"Maximum value that this counter may reach.","format":"int64"}}},"SettlementReport":{"type":"object","properties":{"ident":{"type":"string","description":"Unique settlement report identifier, generated by Nitrobox."},"statementReference":{"type":"string","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."},"statementCreationDate":{"type":"string","description":"A date when the settlement statement was created by a Payment Service Provider or a bank.","format":"date-time"},"fileName":{"type":"string","description":"Unique filename of the settlement statement provided by a Payment Service Provider or a bank."},"processed":{"type":"boolean","description":"Status if the settlement report content could be split into settlement items."}},"description":"Settlement report response body."},"SettlementReportWithMerchantPaymentAccount":{"type":"object","properties":{"ident":{"type":"string","description":"Unique settlement report identifier, generated by Nitrobox."},"statementReference":{"type":"string","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."},"statementCreationDate":{"type":"string","description":"A date when the settlement statement was created by a Payment Service Provider or a bank.","format":"date-time"},"fileName":{"type":"string","description":"Unique filename of the settlement statement provided by a Payment Service Provider or a bank."},"merchantPaymentAccount":{"$ref":"#/components/schemas/MerchantPaymentAccountInfo"},"processed":{"type":"boolean","description":"Status if the settlement report content could be split into settlement items."}},"description":"Settlement report response body extended by the associated merchant payment account."},"SettlementSource":{"required":["fileType","id","name","protocolType"],"type":"object","properties":{"id":{"type":"integer","description":"Must not be null.","format":"int64"},"name":{"type":"string","description":"Human readable name.\nMust not be null."},"protocolType":{"type":"string","description":"Protocol type of this settlement source.\nMust not be null.","enum":["EBICS","SFTP","HTTP"]},"fileType":{"type":"string","description":"Extension of files that are fetched from the source.\nMust not be null.","enum":["CSV","EPA","CAMT53","CAMT54","MT940"]},"host":{"type":"string","description":"Host of the source server."},"port":{"type":"integer","description":"Port of the source server.","format":"int32"}},"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":{"propertyName":"protocolType","mapping":{"SFTP":"#/components/schemas/SftpSettlementSource","EBICS":"#/components/schemas/EbicsSettlementSource"}}},"SettlementsProcessingScheduleDto":{"required":["cronExpression"],"type":"object","properties":{"cronExpression":{"type":"string","description":"Must not be blank."}},"description":"A schedule specifying the time when settlement statements from this account will be loaded from PSP and processed."},"SftpSettlementConfig":{"required":["id","protocolType","remoteDirectory","settlementSourceId"],"type":"object","description":"Sftp settlement source that except standard properties contains also path to remote directory on the server.","allOf":[{"$ref":"#/components/schemas/SettlementConfig"},{"type":"object","properties":{"remoteDirectory":{"type":"string","description":"Must not be empty."},"credentials":{"$ref":"#/components/schemas/CredentialsDto"}}}]},"SftpSettlementSource":{"required":["fileType","id","name","protocolType"],"type":"object","description":"Sftp settlement source that except standard properties contains also path to remote directory on the server.","allOf":[{"$ref":"#/components/schemas/SettlementSource"}]},"TriggerInfo":{"type":"object","properties":{"previousFireTime":{"type":"string","format":"date-time"},"nextFireTime":{"type":"string","format":"date-time"},"cronExpression":{"type":"string"}}},"UpdateMerchantPaymentAccountDto":{"required":["active","settlementsCreationDisabled"],"type":"object","properties":{"active":{"type":"boolean","description":"Specifies if a MerchantPaymentAccount is active, that means if payments from this account are processed in system.\nMust not be null."},"settlementsCreationDisabled":{"type":"boolean","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."},"settlementsProcessingSchedule":{"$ref":"#/components/schemas/CreateSettlementsProcessingScheduleDto"},"additionallyAcceptedCurrencies":{"uniqueItems":true,"type":"array","description":"List of currencies accepted by the MerchantPaymentAccount in addition to the base currency. The existing list will be replaced with this one.","items":{"type":"string","description":"List of currencies accepted by the MerchantPaymentAccount in addition to the base currency. The existing list will be replaced with this one.","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"]}},"paymentCollectionConfig":{"$ref":"#/components/schemas/PaymentCollectionConfig"}},"description":"MerchantPaymentAccount request."},"UpdateMerchantPaymentGatewayRequest":{"required":["ident","name"],"type":"object","properties":{"ident":{"maxLength":255,"minLength":0,"type":"string","description":"Unique external reference for the MerchantPaymentGateway.\nMust not be blank.\nSize must be between 0 and 255."},"name":{"maxLength":255,"minLength":0,"type":"string","description":"Must not be blank.\nSize must be between 0 and 255."},"currencyToAccountMapping":{"type":"object","additionalProperties":{"type":"string","description":"List of Assignments consisting of a CurrencyCode and an ident of a MerchantPaymentAccount used for routing, e.g. \"PLN\": \"MerchantPaymentAccountIdent\"."},"description":"List of Assignments consisting of a CurrencyCode and an ident of a MerchantPaymentAccount used for routing, e.g. \"PLN\": \"MerchantPaymentAccountIdent\"."}},"description":"An UpdateMerchantPaymentGatewayRequest is used to modify an existing MerchantPaymentGateway."},"UpdatePaymentCategorizationConfigDto":{"required":["enabled","strategy","strategyProperties"],"type":"object","properties":{"strategy":{"type":"string","description":"Must not be null.","enum":["CAMT_GVC_CODE_STRATEGY","CAMT_DEBTOR_GVC_CODE_STRATEGY","CAMT_DESCRIPTION_GVC_CODE_STRATEGY"]},"enabled":{"type":"boolean","description":"Must not be null."},"strategyProperties":{"type":"object","additionalProperties":{"type":"string"},"description":"Must not be null."}},"description":"Update categorization configuration request."},"UpdatePaymentCategory":{"type":"object","properties":{"assignable":{"type":"boolean","description":"Specifies if a payment of this category can be assigned to an invoice or a creditmemo."}},"description":"Payment category update request."},"UpdatePaymentTransactionDto":{"required":["paymentCategoryName"],"type":"object","properties":{"paymentCategoryName":{"type":"string","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."}},"description":"Payment transaction category update request"},"UpdatePaymentTransactionStatusDto":{"required":["changeDate","status"],"type":"object","properties":{"changeDate":{"type":"string","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.","format":"date-time","example":"2021-02-25T13:30:22+02:00"},"status":{"type":"string","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.","enum":["RECEIVED","ERROR","REFUSED","AUTHORIZED","EXPIRED","CANCELLED","CAPTURED","CAPTURE_FAILED","SETTLED","REFUNDED","CHARGEBACK"]}}},"UpdateTenantPaymentCategoryConfig":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if this category is enabled to be used for the tenant's payments.\nMust not be null."}}}},"responses":{"4XX_Client_Error_Response":{"description":"error response for all http error codes in range 4XX","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorResponse"}}}},"5XX_Server_Error_Response":{"description":"error response for all http error codes in range 5XX","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorResponse"}}}}}},"x-readme":{"explorer-enabled":false,"proxy-enabled":true,"samples-enabled":true}}