{"swagger":"2.0","info":{"version":"1.0.0","title":"Web Service API"},"host":"paymentshub.weareplanet.com:443","basePath":"/api","paths":{"/account/read":{"get":{"tags":["AccountService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"AccountService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the account which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Account"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#account-service--read"}}},"/account/count":{"post":{"tags":["AccountService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"AccountService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#account-service--count"}}},"/account/update":{"post":{"tags":["AccountService"],"summary":"Update","description":"This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.","operationId":"AccountService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"entity","description":"The account object with all the properties which should be updated. The id and the version are required properties.","required":true,"schema":{"$ref":"#/definitions/Account.Update"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Account"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#account-service--update"}}},"/account/create":{"post":{"tags":["AccountService"],"summary":"Create","description":"Creates the entity with the given properties.","operationId":"AccountService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"entity","description":"The account object with the properties which should be created.","required":true,"schema":{"$ref":"#/definitions/Account.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Account"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#account-service--create"}}},"/account/search":{"post":{"tags":["AccountService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"AccountService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"query","description":"The query restricts the accounts which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/Account"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#account-service--search"}}},"/account/delete":{"post":{"tags":["AccountService"],"summary":"Delete","description":"Deletes the entity with the given id.","operationId":"AccountService_Delete","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"id","description":"","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#account-service--delete"}}},"/application-user/update":{"post":{"tags":["ApplicationUserService"],"summary":"Update","description":"This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.","operationId":"ApplicationUserService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"entity","description":"The application user entity with all the properties which should be updated. The id and the version are required properties.","required":true,"schema":{"$ref":"#/definitions/ApplicationUser.Update"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/ApplicationUser"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#application-user-service--update"}}},"/application-user/create":{"post":{"tags":["ApplicationUserService"],"summary":"Create","description":"Creates the application user with the given properties.","operationId":"ApplicationUserService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"entity","description":"The user object with the properties which should be created.","required":true,"schema":{"$ref":"#/definitions/ApplicationUser.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/ApplicationUser.CreateWithMacKey"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#application-user-service--create"}}},"/application-user/count":{"post":{"tags":["ApplicationUserService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"ApplicationUserService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#application-user-service--count"}}},"/application-user/read":{"get":{"tags":["ApplicationUserService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"ApplicationUserService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the application user which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/ApplicationUser"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#application-user-service--read"}}},"/application-user/search":{"post":{"tags":["ApplicationUserService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"ApplicationUserService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"query","description":"The query restricts the application users which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/ApplicationUser"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#application-user-service--search"}}},"/application-user/delete":{"post":{"tags":["ApplicationUserService"],"summary":"Delete","description":"Deletes the entity with the given id.","operationId":"ApplicationUserService_Delete","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"id","description":"","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#application-user-service--delete"}}},"/card-processing/process":{"post":{"tags":["CardProcessingService"],"summary":"Process","description":"The process method will process the transaction with the given card details without using 3-D secure.","operationId":"CardProcessingService_Process","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"transactionId","in":"query","description":"The ID of the transaction which should be processed.","required":true,"type":"integer","format":"int64"},{"name":"paymentMethodConfigurationId","in":"query","description":"The payment method configuration ID which is applied to the transaction.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"cardData","description":"The card details as JSON in plain which should be used to authorize the payment.","required":true,"schema":{"$ref":"#/definitions/AuthenticatedCardData.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Transaction"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#card-processing-service--process"}}},"/card-processing/processWith3DSecure":{"post":{"tags":["CardProcessingService"],"summary":"Process With 3-D Secure","description":"The process method will process the transaction with the given card details by eventually using 3-D secure. The buyer has to be redirect to the URL returned by this method.","operationId":"CardProcessingService_ProcessWith3DSecure","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"transactionId","in":"query","description":"The ID of the transaction which should be processed.","required":true,"type":"integer","format":"int64"},{"name":"paymentMethodConfigurationId","in":"query","description":"The payment method configuration ID which is applied to the transaction.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"cardData","description":"The card details as JSON in plain which should be used to authorize the payment.","required":true,"schema":{"$ref":"#/definitions/TokenizedCardData.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"string"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#card-processing-service--process-with3-d-secure"}}},"/charge-attempt/read":{"get":{"tags":["ChargeAttemptService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"ChargeAttemptService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the charge attempt which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/ChargeAttempt"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-attempt-service--read"}}},"/charge-attempt/search":{"post":{"tags":["ChargeAttemptService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"ChargeAttemptService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the charge attempts which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/ChargeAttempt"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-attempt-service--search"}}},"/charge-attempt/count":{"post":{"tags":["ChargeAttemptService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"ChargeAttemptService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-attempt-service--count"}}},"/charge-flow-level-payment-link/count":{"post":{"tags":["ChargeFlowLevelPaymentLinkService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"ChargeFlowLevelPaymentLinkService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-level-payment-link-service--count"}}},"/charge-flow-level-payment-link/search":{"post":{"tags":["ChargeFlowLevelPaymentLinkService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"ChargeFlowLevelPaymentLinkService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the charge flow level payment links which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/ChargeFlowLevelPaymentLink"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-level-payment-link-service--search"}}},"/charge-flow-level-payment-link/read":{"get":{"tags":["ChargeFlowLevelPaymentLinkService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"ChargeFlowLevelPaymentLinkService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The ID of the charge flow level payment link which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/ChargeFlowLevelPaymentLink"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-level-payment-link-service--read"}}},"/charge-flow-level/read":{"get":{"tags":["ChargeFlowLevelService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"ChargeFlowLevelService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the payment flow level which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/ChargeFlowLevel"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-level-service--read"}}},"/charge-flow-level/search":{"post":{"tags":["ChargeFlowLevelService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"ChargeFlowLevelService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the payment flow levels which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/ChargeFlowLevel"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-level-service--search"}}},"/charge-flow-level/sendMessage":{"post":{"tags":["ChargeFlowLevelService"],"summary":"Send Payment Link","description":"Sends the payment link of the charge flow level with the given 'id'.","operationId":"ChargeFlowLevelService_SendMessage","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the charge flow level whose payment link should be sent.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/ChargeFlowLevel"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-level-service--send-message"}}},"/charge-flow-level/count":{"post":{"tags":["ChargeFlowLevelService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"ChargeFlowLevelService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-level-service--count"}}},"/charge-flow/cancel-charge-flow":{"post":{"tags":["ChargeFlowService"],"summary":"Cancel Charge Flow","description":"This operation cancels the charge flow that is linked with the transaction indicated by the given ID.","operationId":"ChargeFlowService_CancelChargeFlow","schemes":["https"],"consumes":[],"produces":["application/json"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The ID of the transaction for which the charge flow should be canceled.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Transaction"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-service--cancel-charge-flow"}}},"/charge-flow/read":{"get":{"tags":["ChargeFlowService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"ChargeFlowService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the charge flow which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/ChargeFlow"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-service--read"}}},"/charge-flow/updateRecipient":{"post":{"tags":["ChargeFlowService"],"summary":"updateRecipient","description":"","operationId":"ChargeFlowService_UpdateRecipient","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"transactionId","in":"query","description":"The transaction id of the transaction whose recipient should be updated.","required":true,"type":"integer","format":"int64"},{"name":"type","in":"query","description":"The id of the charge flow configuration type to recipient should be updated for.","required":true,"type":"integer","format":"int64"},{"name":"recipient","in":"query","description":"The recipient address that should be used to send the payment URL.","required":true,"type":"string"}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-service--update-recipient"}}},"/charge-flow/search":{"post":{"tags":["ChargeFlowService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"ChargeFlowService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the charge flows which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/ChargeFlow"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-service--search"}}},"/charge-flow/count":{"post":{"tags":["ChargeFlowService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"ChargeFlowService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-service--count"}}},"/charge-flow/applyFlow":{"post":{"tags":["ChargeFlowService"],"summary":"applyFlow","description":"","operationId":"ChargeFlowService_ApplyFlow","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The transaction id of the transaction which should be process asynchronously.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Transaction"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-service--apply-flow"}}},"/charge-flow/fetch-charge-flow-payment-page-url":{"get":{"tags":["ChargeFlowService"],"summary":"Fetch Charge Flow Payment Page URL","description":"This operation allows to fetch the payment page URL that is been applied on the charge flow linked with the provided transaction. The operation might return an empty result when no payment page is needed or can be invoked.","operationId":"ChargeFlowService_FetchChargeFlowPaymentPageUrl","schemes":["https"],"consumes":[],"produces":["text/plain;charset=utf-8","application/json"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The transaction id of the transaction for which the URL of the charge flow should be fetched.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"string"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#charge-flow-service--fetch-charge-flow-payment-page-url"}}},"/condition-type/read":{"get":{"tags":["ConditionTypeService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"ConditionTypeService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the condition type which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/ConditionType"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#condition-type-service--read"}}},"/condition-type/all":{"get":{"tags":["ConditionTypeService"],"summary":"All","description":"This operation returns all entities which are available.","operationId":"ConditionTypeService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/ConditionType"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#condition-type-service--all"}}},"/country/all":{"get":{"tags":["CountryService"],"summary":"All","description":"This operation returns all countries.","operationId":"CountryService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/RestCountry"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#country-service--all"}}},"/country-state/country":{"get":{"tags":["CountryStateService"],"summary":"Find by Country","description":"This operation returns all states for a given country.","operationId":"CountryStateService_Country","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"code","in":"query","description":"The country code in ISO code two letter format for which all states should be returned.","required":true,"type":"string"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/RestCountryState"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#country-state-service--country"}}},"/country-state/all":{"get":{"tags":["CountryStateService"],"summary":"All","description":"This operation returns all states of all countries.","operationId":"CountryStateService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/RestCountryState"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#country-state-service--all"}}},"/currency/all":{"get":{"tags":["CurrencyService"],"summary":"All","description":"This operation returns all currencies.","operationId":"CurrencyService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/RestCurrency"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#currency-service--all"}}},"/customer-address/select-default-address":{"get":{"tags":["CustomerAddressService"],"summary":"selectDefaultAddress","description":"","operationId":"CustomerAddressService_SelectDefaultAddress","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the customer address to set as default.","required":true,"type":"integer","format":"int64"}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-address-service--select-default-address"}}},"/customer-address/count":{"post":{"tags":["CustomerAddressService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"CustomerAddressService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-address-service--count"}}},"/customer-address/read":{"get":{"tags":["CustomerAddressService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"CustomerAddressService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the customer which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/CustomerAddress"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-address-service--read"}}},"/customer-address/search":{"post":{"tags":["CustomerAddressService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"CustomerAddressService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the customers which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/CustomerAddress"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-address-service--search"}}},"/customer-address/delete":{"post":{"tags":["CustomerAddressService"],"summary":"Delete","description":"Deletes the entity with the given id.","operationId":"CustomerAddressService_Delete","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"id","description":"","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-address-service--delete"}}},"/customer-address/update":{"post":{"tags":["CustomerAddressService"],"summary":"Update","description":"This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.","operationId":"CustomerAddressService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The customer object with the properties which should be updated.","required":true,"schema":{"$ref":"#/definitions/CustomerAddress.Active"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/CustomerAddress"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-address-service--update"}}},"/customer-address/create":{"post":{"tags":["CustomerAddressService"],"summary":"Create","description":"Creates the entity with the given properties.","operationId":"CustomerAddressService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The customer object which should be created.","required":true,"schema":{"$ref":"#/definitions/CustomerAddress.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/CustomerAddress"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-address-service--create"}}},"/customer-comment/pin-comment":{"get":{"tags":["CustomerCommentService"],"summary":"pinComment","description":"","operationId":"CustomerCommentService_PinComment","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the customer comment to pin to the top.","required":true,"type":"integer","format":"int64"}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-comment-service--pin-comment"}}},"/customer-comment/count":{"post":{"tags":["CustomerCommentService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"CustomerCommentService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-comment-service--count"}}},"/customer-comment/delete":{"post":{"tags":["CustomerCommentService"],"summary":"Delete","description":"Deletes the entity with the given id.","operationId":"CustomerCommentService_Delete","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"id","description":"","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-comment-service--delete"}}},"/customer-comment/update":{"post":{"tags":["CustomerCommentService"],"summary":"Update","description":"This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.","operationId":"CustomerCommentService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The customer object with the properties which should be updated.","required":true,"schema":{"$ref":"#/definitions/CustomerComment.Active"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/CustomerComment"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-comment-service--update"}}},"/customer-comment/create":{"post":{"tags":["CustomerCommentService"],"summary":"Create","description":"Creates the entity with the given properties.","operationId":"CustomerCommentService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The customer object which should be created.","required":true,"schema":{"$ref":"#/definitions/CustomerComment.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/CustomerComment"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-comment-service--create"}}},"/customer-comment/search":{"post":{"tags":["CustomerCommentService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"CustomerCommentService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the customers which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/CustomerComment"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-comment-service--search"}}},"/customer-comment/read":{"get":{"tags":["CustomerCommentService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"CustomerCommentService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the customer which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/CustomerComment"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-comment-service--read"}}},"/customer-comment/unpin-comment":{"get":{"tags":["CustomerCommentService"],"summary":"unpinComment","description":"","operationId":"CustomerCommentService_UnpinComment","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the customer comment to unpin.","required":true,"type":"integer","format":"int64"}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-comment-service--unpin-comment"}}},"/customer/count":{"post":{"tags":["CustomerService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"CustomerService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-service--count"}}},"/customer/search":{"post":{"tags":["CustomerService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"CustomerService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the customers which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/Customer"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-service--search"}}},"/customer/delete":{"post":{"tags":["CustomerService"],"summary":"Delete","description":"Deletes the entity with the given id.","operationId":"CustomerService_Delete","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"id","description":"","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-service--delete"}}},"/customer/update":{"post":{"tags":["CustomerService"],"summary":"Update","description":"This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.","operationId":"CustomerService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The customer object with the properties which should be updated.","required":true,"schema":{"$ref":"#/definitions/Customer.Active"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Customer"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-service--update"}}},"/customer/create":{"post":{"tags":["CustomerService"],"summary":"Create","description":"Creates the entity with the given properties.","operationId":"CustomerService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The customer object which should be created.","required":true,"schema":{"$ref":"#/definitions/Customer.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Customer"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-service--create"}}},"/customer/read":{"get":{"tags":["CustomerService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"CustomerService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the customer which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Customer"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#customer-service--read"}}},"/delivery-indication/read":{"get":{"tags":["DeliveryIndicationService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"DeliveryIndicationService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the delivery indication which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/DeliveryIndication"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#delivery-indication-service--read"}}},"/delivery-indication/markAsNotSuitable":{"post":{"tags":["DeliveryIndicationService"],"summary":"markAsNotSuitable","description":"This operation marks the delivery indication as not suitable.","operationId":"DeliveryIndicationService_MarkAsNotSuitable","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"deliveryIndicationId","description":"The delivery indication id which should be marked as not suitable.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/DeliveryIndication"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#delivery-indication-service--mark-as-not-suitable"}}},"/delivery-indication/search":{"post":{"tags":["DeliveryIndicationService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"DeliveryIndicationService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the delivery indications which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/DeliveryIndication"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#delivery-indication-service--search"}}},"/delivery-indication/markAsSuitable":{"post":{"tags":["DeliveryIndicationService"],"summary":"markAsSuitable","description":"This operation marks the delivery indication as suitable.","operationId":"DeliveryIndicationService_MarkAsSuitable","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"deliveryIndicationId","description":"The delivery indication id which should be marked as suitable.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/DeliveryIndication"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#delivery-indication-service--mark-as-suitable"}}},"/delivery-indication/count":{"post":{"tags":["DeliveryIndicationService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"DeliveryIndicationService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#delivery-indication-service--count"}}},"/document-template/count":{"post":{"tags":["DocumentTemplateService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"DocumentTemplateService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#document-template-service--count"}}},"/document-template/read":{"get":{"tags":["DocumentTemplateService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"DocumentTemplateService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the document template which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/DocumentTemplate"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#document-template-service--read"}}},"/document-template/search":{"post":{"tags":["DocumentTemplateService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"DocumentTemplateService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the document templates which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/DocumentTemplate"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#document-template-service--search"}}},"/document-template-type/all":{"get":{"tags":["DocumentTemplateTypeService"],"summary":"All","description":"This operation returns all entities which are available.","operationId":"DocumentTemplateTypeService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/DocumentTemplateType"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#document-template-type-service--all"}}},"/document-template-type/read":{"get":{"tags":["DocumentTemplateTypeService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"DocumentTemplateTypeService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the document template type which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/DocumentTemplateType"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#document-template-type-service--read"}}},"/human-user/export":{"post":{"tags":["HumanUserService"],"summary":"Export","description":"Exports the human users into a CSV file. The file will contain the properties defined in the request.","operationId":"HumanUserService_Export","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["text/csv","application/json;charset=utf-8"],"parameters":[{"in":"body","name":"request","description":"The request controls the entries which are exported.","required":true,"schema":{"$ref":"#/definitions/EntityExportRequest"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"string","format":"binary"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#human-user-service--export"}}},"/human-user/search":{"post":{"tags":["HumanUserService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"HumanUserService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"query","description":"The query restricts the human users which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/HumanUser"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#human-user-service--search"}}},"/human-user/delete":{"post":{"tags":["HumanUserService"],"summary":"Delete","description":"Deletes the entity with the given id.","operationId":"HumanUserService_Delete","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"id","description":"","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#human-user-service--delete"}}},"/human-user/count":{"post":{"tags":["HumanUserService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"HumanUserService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#human-user-service--count"}}},"/human-user/update":{"post":{"tags":["HumanUserService"],"summary":"Update","description":"This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.","operationId":"HumanUserService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"entity","description":"The object with all the properties which should be updated. The id and the version are required properties.","required":true,"schema":{"$ref":"#/definitions/HumanUser.Update"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/HumanUser"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#human-user-service--update"}}},"/human-user/create":{"post":{"tags":["HumanUserService"],"summary":"Create","description":"Creates the entity with the given properties.","operationId":"HumanUserService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"entity","description":"The human user object with the properties which should be created.","required":true,"schema":{"$ref":"#/definitions/HumanUser.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/HumanUser"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#human-user-service--create"}}},"/human-user/read":{"get":{"tags":["HumanUserService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"HumanUserService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the human user which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/HumanUser"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#human-user-service--read"}}},"/label-description-group-service/read":{"get":{"tags":["LabelDescriptionGroupService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"LabelDescriptionGroupService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the label descriptor group which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/LabelDescriptorGroup"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#label-description-group-service--read"}}},"/label-description-group-service/all":{"get":{"tags":["LabelDescriptionGroupService"],"summary":"All","description":"This operation returns all entities which are available.","operationId":"LabelDescriptionGroupService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/LabelDescriptorGroup"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#label-description-group-service--all"}}},"/label-description-service/read":{"get":{"tags":["LabelDescriptionService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"LabelDescriptionService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the label descriptor which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/LabelDescriptor"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#label-description-service--read"}}},"/label-description-service/all":{"get":{"tags":["LabelDescriptionService"],"summary":"All","description":"This operation returns all entities which are available.","operationId":"LabelDescriptionService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/LabelDescriptor"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#label-description-service--all"}}},"/language/all":{"get":{"tags":["LanguageService"],"summary":"All","description":"This operation returns all languages.","operationId":"LanguageService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/RestLanguage"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#language-service--all"}}},"/legal-organization-form/country":{"get":{"tags":["LegalOrganizationFormService"],"summary":"Find by Country","description":"This operation returns all legal organization forms for a given country.","operationId":"LegalOrganizationFormService_Country","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"code","in":"query","description":"The country in ISO 3166-1 alpha-2 format, for which all legal organization forms should be returned.","required":true,"type":"string"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/LegalOrganizationForm"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#legal-organization-form-service--country"}}},"/legal-organization-form/all":{"get":{"tags":["LegalOrganizationFormService"],"summary":"All","description":"This operation returns all entities which are available.","operationId":"LegalOrganizationFormService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/LegalOrganizationForm"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#legal-organization-form-service--all"}}},"/legal-organization-form/read":{"get":{"tags":["LegalOrganizationFormService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"LegalOrganizationFormService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the legal organization form which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/LegalOrganizationForm"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#legal-organization-form-service--read"}}},"/manual-task/search":{"post":{"tags":["ManualTaskService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"ManualTaskService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the manual tasks which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/ManualTask"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#manual-task-service--search"}}},"/manual-task/read":{"get":{"tags":["ManualTaskService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"ManualTaskService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the manual task which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/ManualTask"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#manual-task-service--read"}}},"/manual-task/count":{"post":{"tags":["ManualTaskService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"ManualTaskService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#manual-task-service--count"}}},"/payment-web-app/update-refund":{"post":{"tags":["PaymentWebAppService"],"summary":"Update Refund","description":"This operation updates the state of the refund. This method can be invoked for transactions originally created with a processor associated with the web app that invokes this operation. The returned refund corresponds to the refund indicated in the request.","operationId":"PaymentWebAppService_UpdateRefund","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"This is the ID of the space in which the refund is located in.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"The refund update request allows to update the state of a refund.","required":true,"schema":{"$ref":"#/definitions/PaymentAppRefundUpdateRequest"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Refund"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-web-app-service--update-refund"}}},"/payment-web-app/update-void":{"post":{"tags":["PaymentWebAppService"],"summary":"Update Void","description":"This operation updates the state of the transaction void. This method can be invoked for transactions originally created with a processor associated with the web app that invokes this operation. The returned void corresponds to the void indicated in the request.","operationId":"PaymentWebAppService_UpdateVoid","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"This is the ID of the space in which the void is located in.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"The void update request allows to update the state of a void.","required":true,"schema":{"$ref":"#/definitions/PaymentAppVoidUpdateRequest"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionVoid"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-web-app-service--update-void"}}},"/payment-web-app/delete-connector":{"post":{"tags":["PaymentWebAppService"],"summary":"Delete Connector","description":"This operation removes the web app payment connector from the given space.","operationId":"PaymentWebAppService_DeleteConnector","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"The space ID identifies the space in which the connector is installed in.","required":true,"type":"integer","format":"int64"},{"name":"externalId","in":"query","description":"The external ID identifies the connector. The external ID corresponds to the ID provided during inserting of the connector.","required":true,"type":"string"}],"responses":{"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-web-app-service--delete-connector"}}},"/payment-web-app/delete-processor":{"post":{"tags":["PaymentWebAppService"],"summary":"Delete Processor","description":"This operation removes the web app payment processor and its connectors from the given space.","operationId":"PaymentWebAppService_DeleteProcessor","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"The space ID identifies the space in which the processor is installed in.","required":true,"type":"integer","format":"int64"},{"name":"externalId","in":"query","description":"The external ID identifies the processor. The external ID corresponds to the ID provided during inserting of the processor.","required":true,"type":"string"}],"responses":{"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-web-app-service--delete-processor"}}},"/payment-web-app/insert-or-update-connector":{"post":{"tags":["PaymentWebAppService"],"summary":"Insert or Update Connector","description":"This operation inserts or updates a web app payment connector.","operationId":"PaymentWebAppService_InsertOrUpdateConnector","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"The space ID identifies the space into which the connector should be inserted into.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"The connector object contains all the details required to create or update a web app connector.","required":true,"schema":{"$ref":"#/definitions/PaymentAppConnectorCreationRequest"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/PaymentAppConnector"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-web-app-service--insert-or-update-connector"}}},"/payment-web-app/insert-or-update-processor":{"post":{"tags":["PaymentWebAppService"],"summary":"Insert or Update Processor","description":"This operation inserts or updates a web app payment processor.","operationId":"PaymentWebAppService_InsertOrUpdateProcessor","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"The space ID identifies the space into which the processor should be inserted into.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"The processor object contains all the details required to create or update a web app processor.","required":true,"schema":{"$ref":"#/definitions/PaymentAppProcessorCreationRequest"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/PaymentAppProcessor"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-web-app-service--insert-or-update-processor"}}},"/payment-web-app/update-completion":{"post":{"tags":["PaymentWebAppService"],"summary":"Update Completion","description":"This operation updates the state of the transaction completion. This method can be invoked for transactions originally created with a processor associated with the web app that invokes this operation. The returned completion corresponds to the completion indicated in the request.","operationId":"PaymentWebAppService_UpdateCompletion","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"This is the ID of the space in which the completion is located in.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"The completion update request allows to update the state of a completion.","required":true,"schema":{"$ref":"#/definitions/PaymentAppCompletionUpdateRequest"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionCompletion"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-web-app-service--update-completion"}}},"/payment-web-app/update-charge-attempt":{"post":{"tags":["PaymentWebAppService"],"summary":"Update Charge Attempt","description":"This operation updates the state of the charge attempt. This method can be invoked for transactions originally created with a processor associated with the web app that invokes this operation. The returned charge attempt corresponds to the charge attempt indicated in the request.","operationId":"PaymentWebAppService_UpdateChargeAttempt","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"This is the ID of the space in which the charge attempt is located in.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"The charge attempt update request allows to update the state of a charge attempt.","required":true,"schema":{"$ref":"#/definitions/PaymentAppChargeAttemptUpdateRequest"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/ChargeAttempt"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-web-app-service--update-charge-attempt"}}},"/payment-web-app/activate-processor-for-production":{"post":{"tags":["PaymentWebAppService"],"summary":"Activate Processor for Production","description":"This operation marks the processor to be usable within the production environment.","operationId":"PaymentWebAppService_ActivateProcessorForProduction","schemes":["https"],"consumes":["*/*"],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"The space ID identifies the space in which the processor is installed in.","required":true,"type":"integer","format":"int64"},{"name":"externalId","in":"query","description":"The external ID identifies the processor. The external ID corresponds to the ID provided during inserting of the processor.","required":true,"type":"string"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/PaymentAppProcessor"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-web-app-service--activate-processor-for-production"}}},"/payment-connector-configuration/read":{"get":{"tags":["PaymentConnectorConfigurationService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"PaymentConnectorConfigurationService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the payment connector configuration which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/PaymentConnectorConfiguration"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-connector-configuration-service--read"}}},"/payment-connector-configuration/count":{"post":{"tags":["PaymentConnectorConfigurationService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"PaymentConnectorConfigurationService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-connector-configuration-service--count"}}},"/payment-connector-configuration/search":{"post":{"tags":["PaymentConnectorConfigurationService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"PaymentConnectorConfigurationService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the payment connector configuration which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentConnectorConfiguration"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-connector-configuration-service--search"}}},"/payment-connector/all":{"get":{"tags":["PaymentConnectorService"],"summary":"All","description":"This operation returns all entities which are available.","operationId":"PaymentConnectorService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentConnector"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-connector-service--all"}}},"/payment-connector/read":{"get":{"tags":["PaymentConnectorService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"PaymentConnectorService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the connector which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/PaymentConnector"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-connector-service--read"}}},"/payment-method-brand/all":{"get":{"tags":["PaymentMethodBrandService"],"summary":"All","description":"This operation returns all entities which are available.","operationId":"PaymentMethodBrandService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentMethodBrand"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-method-brand-service--all"}}},"/payment-method-brand/read":{"get":{"tags":["PaymentMethodBrandService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"PaymentMethodBrandService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the payment method brand which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/PaymentMethodBrand"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-method-brand-service--read"}}},"/payment-method-configuration/search":{"post":{"tags":["PaymentMethodConfigurationService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"PaymentMethodConfigurationService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the payment method configuration which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentMethodConfiguration"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-method-configuration-service--search"}}},"/payment-method-configuration/count":{"post":{"tags":["PaymentMethodConfigurationService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"PaymentMethodConfigurationService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-method-configuration-service--count"}}},"/payment-method-configuration/read":{"get":{"tags":["PaymentMethodConfigurationService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"PaymentMethodConfigurationService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the payment method configuration which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/PaymentMethodConfiguration"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-method-configuration-service--read"}}},"/payment-method/all":{"get":{"tags":["PaymentMethodService"],"summary":"All","description":"This operation returns all entities which are available.","operationId":"PaymentMethodService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentMethod"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-method-service--all"}}},"/payment-method/read":{"get":{"tags":["PaymentMethodService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"PaymentMethodService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the payment method which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/PaymentMethod"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-method-service--read"}}},"/payment-processor-configuration/read":{"get":{"tags":["PaymentProcessorConfigurationService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"PaymentProcessorConfigurationService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the payment processor configuration which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/PaymentProcessorConfiguration"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-processor-configuration-service--read"}}},"/payment-processor-configuration/count":{"post":{"tags":["PaymentProcessorConfigurationService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"PaymentProcessorConfigurationService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-processor-configuration-service--count"}}},"/payment-processor-configuration/search":{"post":{"tags":["PaymentProcessorConfigurationService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"PaymentProcessorConfigurationService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the payment processor configuration which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentProcessorConfiguration"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-processor-configuration-service--search"}}},"/payment-processor/read":{"get":{"tags":["PaymentProcessorService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"PaymentProcessorService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the processor which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/PaymentProcessor"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-processor-service--read"}}},"/payment-processor/all":{"get":{"tags":["PaymentProcessorService"],"summary":"All","description":"This operation returns all entities which are available.","operationId":"PaymentProcessorService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentProcessor"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#payment-processor-service--all"}}},"/permission/read":{"get":{"tags":["PermissionService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"PermissionService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the permission which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Permission"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#permission-service--read"}}},"/permission/all":{"get":{"tags":["PermissionService"],"summary":"All","description":"This operation returns all entities which are available.","operationId":"PermissionService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/Permission"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#permission-service--all"}}},"/refund-comment/all":{"post":{"tags":["RefundCommentService"],"summary":"Find by refund","description":"Returns all comments of the given refund.","operationId":"RefundCommentService_All","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"refundId","in":"query","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/RefundComment"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-comment-service--all"}}},"/refund-comment/update":{"post":{"tags":["RefundCommentService"],"summary":"Update","description":"This updates the comment with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the comment.","operationId":"RefundCommentService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The comment object with the properties which should be updated.","required":true,"schema":{"$ref":"#/definitions/RefundComment.Active"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/RefundComment"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-comment-service--update"}}},"/refund-comment/unpin":{"get":{"tags":["RefundCommentService"],"summary":"Unpin","description":"Unpins the comment from the top.","operationId":"RefundCommentService_Unpin","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the comment to unpin.","required":true,"type":"integer","format":"int64"}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-comment-service--unpin"}}},"/refund-comment/delete":{"post":{"tags":["RefundCommentService"],"summary":"Delete","description":"Deletes the comment with the given id.","operationId":"RefundCommentService_Delete","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"id","description":"","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-comment-service--delete"}}},"/refund-comment/create":{"post":{"tags":["RefundCommentService"],"summary":"Create","description":"Creates the comment with the given properties.","operationId":"RefundCommentService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The comment object which should be created.","required":true,"schema":{"$ref":"#/definitions/RefundComment.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/RefundComment"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-comment-service--create"}}},"/refund-comment/pin":{"get":{"tags":["RefundCommentService"],"summary":"Pin","description":"Pins the comment to the top.","operationId":"RefundCommentService_Pin","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the comment to pin to the top.","required":true,"type":"integer","format":"int64"}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-comment-service--pin"}}},"/refund-comment/read":{"get":{"tags":["RefundCommentService"],"summary":"Read","description":"Reads the comment with the given 'id' and returns it.","operationId":"RefundCommentService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the comment which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/RefundComment"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-comment-service--read"}}},"/refund/count":{"post":{"tags":["RefundService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"RefundService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-service--count"}}},"/refund/refund":{"post":{"tags":["RefundService"],"summary":"create","description":"This operation creates and executes a refund of a particular transaction.","operationId":"RefundService_Refund","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"refund","description":"The refund object which should be created.","required":true,"schema":{"$ref":"#/definitions/Refund.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Refund"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-service--refund"}}},"/refund/read":{"get":{"tags":["RefundService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"RefundService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the refund which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Refund"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-service--read"}}},"/refund/getRefundDocument":{"get":{"tags":["RefundService"],"summary":"getRefundDocument","description":"Returns the PDF document for the refund with given id.","operationId":"RefundService_GetRefundDocument","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the refund to get the document for.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/RenderedDocument"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-service--get-refund-document"}}},"/refund/getRefundDocumentWithTargetMediaType":{"get":{"tags":["RefundService"],"summary":"getRefundDocumentWithTargetMediaType","description":"Returns the PDF document for the refund with given id and the given target media type.","operationId":"RefundService_GetRefundDocumentWithTargetMediaType","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the refund to get the document for.","required":true,"type":"integer","format":"int64"},{"name":"targetMediaTypeId","in":"query","description":"The id of the target media type for which the refund should be generated for.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/RenderedDocument"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-service--get-refund-document-with-target-media-type"}}},"/refund/fail":{"post":{"tags":["RefundService"],"summary":"fail","description":"This operation allows to mark a refund as failed which is in state MANUAL_CHECK.","operationId":"RefundService_Fail","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"refundId","in":"query","description":"The id of the refund which should be marked as failed.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Refund"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-service--fail"}}},"/refund/succeed":{"post":{"tags":["RefundService"],"summary":"succeed","description":"This operation allows to mark a refund as successful which is in state MANUAL_CHECK.","operationId":"RefundService_Succeed","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"refundId","in":"query","description":"The id of the refund which should be marked as successful.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Refund"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-service--succeed"}}},"/refund/search":{"post":{"tags":["RefundService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"RefundService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the refunds which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/Refund"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#refund-service--search"}}},"/space/read":{"get":{"tags":["SpaceService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"SpaceService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the space which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Space"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#space-service--read"}}},"/space/search":{"post":{"tags":["SpaceService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"SpaceService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"query","description":"The query restricts the spaces which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/Space"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#space-service--search"}}},"/space/delete":{"post":{"tags":["SpaceService"],"summary":"Delete","description":"Deletes the entity with the given id.","operationId":"SpaceService_Delete","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"id","description":"","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#space-service--delete"}}},"/space/count":{"post":{"tags":["SpaceService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"SpaceService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#space-service--count"}}},"/space/update":{"post":{"tags":["SpaceService"],"summary":"Update","description":"This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.","operationId":"SpaceService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"entity","description":"The space object with all the properties which should be updated. The id and the version are required properties.","required":true,"schema":{"$ref":"#/definitions/Space.Update"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Space"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#space-service--update"}}},"/space/create":{"post":{"tags":["SpaceService"],"summary":"Create","description":"Creates the entity with the given properties.","operationId":"SpaceService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"entity","description":"The space object with the properties which should be created.","required":true,"schema":{"$ref":"#/definitions/Space.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Space"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#space-service--create"}}},"/static-value-service/all":{"get":{"tags":["StaticValueService"],"summary":"All","description":"This operation returns all entities which are available.","operationId":"StaticValueService_All","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/StaticValue"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#static-value-service--all"}}},"/static-value-service/read":{"get":{"tags":["StaticValueService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"StaticValueService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of the static value which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/StaticValue"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#static-value-service--read"}}},"/token/create":{"post":{"tags":["TokenService"],"summary":"Create","description":"Creates the entity with the given properties.","operationId":"TokenService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The token object with the properties which should be created.","required":true,"schema":{"$ref":"#/definitions/Token.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Token"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-service--create"}}},"/token/create-token":{"post":{"tags":["TokenService"],"summary":"Create Token","description":"This operation creates a token for the given transaction. The transaction payment information will be populated asynchronously as soon as all data becomes available.","operationId":"TokenService_CreateToken","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"transactionId","in":"query","description":"The id of the transaction for which we want to create the token.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Token"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-service--create-token"}}},"/token/createTransactionForTokenUpdate":{"post":{"tags":["TokenService"],"summary":"Create Transaction for Token Update","description":"This operation creates a transaction which allows the updating of the provided token.","operationId":"TokenService_CreateTransactionForTokenUpdate","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"tokenId","in":"query","description":"The id of the token which should be updated.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Transaction"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-service--create-transaction-for-token-update"}}},"/token/process-transaction":{"post":{"tags":["TokenService"],"summary":"Process Transaction","description":"This operation processes the given transaction by using the token associated with the transaction.","operationId":"TokenService_ProcessTransaction","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"transactionId","in":"query","description":"The id of the transaction for which we want to check if the token can be created or not.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Charge"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-service--process-transaction"}}},"/token/create-token-based-on-transaction":{"post":{"tags":["TokenService"],"summary":"Create Token Based On Transaction And Fill It With Stored Payment Information","description":"This operation creates a token for the given transaction and fills it with the stored payment information of the transaction. The payment information for the transaction will be filled in immediately, if payment information is missing, an exception will be thrown.","operationId":"TokenService_CreateTokenBasedOnTransaction","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"transactionId","in":"query","description":"The id of the transaction for which we want to create the token.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TokenVersion"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-service--create-token-based-on-transaction"}}},"/token/count":{"post":{"tags":["TokenService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"TokenService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-service--count"}}},"/token/update":{"post":{"tags":["TokenService"],"summary":"Update","description":"This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.","operationId":"TokenService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The object with all the properties which should be updated. The id and the version are required properties.","required":true,"schema":{"$ref":"#/definitions/Token.Update"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Token"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-service--update"}}},"/token/read":{"get":{"tags":["TokenService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"TokenService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the token which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Token"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-service--read"}}},"/token/search":{"post":{"tags":["TokenService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"TokenService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the tokens which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/Token"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-service--search"}}},"/token/delete":{"post":{"tags":["TokenService"],"summary":"Delete","description":"Deletes the entity with the given id.","operationId":"TokenService_Delete","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"id","description":"","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-service--delete"}}},"/token/check-token-creation-possible":{"post":{"tags":["TokenService"],"summary":"Check If Token Creation Is Possible","description":"This operation checks if the given transaction can be used to create a token out of it.","operationId":"TokenService_CheckTokenCreationPossible","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"transactionId","in":"query","description":"The id of the transaction for which we want to check if the token can be created or not.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"boolean"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-service--check-token-creation-possible"}}},"/token-version/read":{"get":{"tags":["TokenVersionService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"TokenVersionService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the token version which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TokenVersion"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-version-service--read"}}},"/token-version/search":{"post":{"tags":["TokenVersionService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"TokenVersionService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the token versions which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/TokenVersion"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-version-service--search"}}},"/token-version/active-version":{"get":{"tags":["TokenVersionService"],"summary":"Active Version","description":"Returns the token version which is currently active given by the token id. In case no token version is active the method will return null.","operationId":"TokenVersionService_ActiveVersion","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of a token for which you want to look up the current active token version.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TokenVersion"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-version-service--active-version"}}},"/token-version/count":{"post":{"tags":["TokenVersionService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"TokenVersionService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#token-version-service--count"}}},"/transaction-comment/read":{"get":{"tags":["TransactionCommentService"],"summary":"Read","description":"Reads the comment with the given 'id' and returns it.","operationId":"TransactionCommentService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the comment which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionComment"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-comment-service--read"}}},"/transaction-comment/delete":{"post":{"tags":["TransactionCommentService"],"summary":"Delete","description":"Deletes the comment with the given id.","operationId":"TransactionCommentService_Delete","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"id","description":"","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-comment-service--delete"}}},"/transaction-comment/update":{"post":{"tags":["TransactionCommentService"],"summary":"Update","description":"This updates the comment with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the comment.","operationId":"TransactionCommentService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The comment object with the properties which should be updated.","required":true,"schema":{"$ref":"#/definitions/TransactionComment.Active"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionComment"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-comment-service--update"}}},"/transaction-comment/create":{"post":{"tags":["TransactionCommentService"],"summary":"Create","description":"Creates the comment with the given properties.","operationId":"TransactionCommentService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The comment object which should be created.","required":true,"schema":{"$ref":"#/definitions/TransactionComment.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionComment"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-comment-service--create"}}},"/transaction-comment/unpin":{"get":{"tags":["TransactionCommentService"],"summary":"Unpin","description":"Unpins the comment from the top.","operationId":"TransactionCommentService_Unpin","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the comment to unpin.","required":true,"type":"integer","format":"int64"}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-comment-service--unpin"}}},"/transaction-comment/pin":{"get":{"tags":["TransactionCommentService"],"summary":"Pin","description":"Pins the comment to the top.","operationId":"TransactionCommentService_Pin","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the comment to pin to the top.","required":true,"type":"integer","format":"int64"}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-comment-service--pin"}}},"/transaction-comment/all":{"post":{"tags":["TransactionCommentService"],"summary":"Find by transaction","description":"Returns all comments of the transaction.","operationId":"TransactionCommentService_All","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"transactionId","in":"query","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/TransactionComment"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-comment-service--all"}}},"/transaction-completion/completePartiallyOffline":{"post":{"tags":["TransactionCompletionService"],"summary":"completePartiallyOffline","description":"This operation can be used to partially complete the transaction offline. The completion is not forwarded to the processor. This implies the processor does not do anything. This method is only here to fix manually the transaction state.","operationId":"TransactionCompletionService_CompletePartiallyOffline","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"completion","description":"","required":true,"schema":{"$ref":"#/definitions/TransactionCompletionRequest"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionCompletion"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-completion-service--complete-partially-offline"}}},"/transaction-completion/completePartiallyOnline":{"post":{"tags":["TransactionCompletionService"],"summary":"completePartiallyOnline","description":"This operation can be used to partially complete the transaction online. The completion is forwarded to the processor. This implies that the processor may take some actions based on the completion.","operationId":"TransactionCompletionService_CompletePartiallyOnline","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"completion","description":"","required":true,"schema":{"$ref":"#/definitions/TransactionCompletionRequest"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionCompletion"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-completion-service--complete-partially-online"}}},"/transaction-completion/completeOffline":{"post":{"tags":["TransactionCompletionService"],"summary":"completeOffline","description":"This operation completes the transaction offline. The completion is not forwarded to the processor. This implies the processor does not do anything. This method is only here to fix manually the transaction state.","operationId":"TransactionCompletionService_CompleteOffline","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction which should be completed.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionCompletion"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-completion-service--complete-offline"}}},"/transaction-completion/count":{"post":{"tags":["TransactionCompletionService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"TransactionCompletionService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-completion-service--count"}}},"/transaction-completion/read":{"get":{"tags":["TransactionCompletionService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"TransactionCompletionService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction completions which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionCompletion"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-completion-service--read"}}},"/transaction-completion/completeOnline":{"post":{"tags":["TransactionCompletionService"],"summary":"completeOnline","description":"This operation completes the transaction online. The completion is forwarded to the processor. This implies that the processor may take some actions based on the completion.","operationId":"TransactionCompletionService_CompleteOnline","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction which should be completed.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionCompletion"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-completion-service--complete-online"}}},"/transaction-completion/search":{"post":{"tags":["TransactionCompletionService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"TransactionCompletionService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the transaction completions which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/TransactionCompletion"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-completion-service--search"}}},"/transaction-iframe/javascript-url":{"get":{"tags":["TransactionIframeService"],"summary":"Build JavaScript URL","description":"This operation creates the URL which can be used to embed the JavaScript for handling the iFrame checkout flow.","operationId":"TransactionIframeService_JavascriptUrl","schemes":["https"],"consumes":[],"produces":["text/plain;charset=utf-8","application/json"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"string"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-iframe-service--javascript-url"}}},"/transaction-invoice-comment/pin":{"get":{"tags":["TransactionInvoiceCommentService"],"summary":"Pin","description":"Pins the comment to the top.","operationId":"TransactionInvoiceCommentService_Pin","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the comment to pin to the top.","required":true,"type":"integer","format":"int64"}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-comment-service--pin"}}},"/transaction-invoice-comment/all":{"post":{"tags":["TransactionInvoiceCommentService"],"summary":"Find by invoice","description":"Returns all comments of the given transaction invoice.","operationId":"TransactionInvoiceCommentService_All","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"invoiceId","in":"query","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/TransactionInvoiceComment"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-comment-service--all"}}},"/transaction-invoice-comment/unpin":{"get":{"tags":["TransactionInvoiceCommentService"],"summary":"Unpin","description":"Unpins the comment from the top.","operationId":"TransactionInvoiceCommentService_Unpin","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the comment to unpin.","required":true,"type":"integer","format":"int64"}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-comment-service--unpin"}}},"/transaction-invoice-comment/update":{"post":{"tags":["TransactionInvoiceCommentService"],"summary":"Update","description":"This updates the comment with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the comment.","operationId":"TransactionInvoiceCommentService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The comment object with the properties which should be updated.","required":true,"schema":{"$ref":"#/definitions/TransactionInvoiceComment.Active"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionInvoiceComment"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-comment-service--update"}}},"/transaction-invoice-comment/create":{"post":{"tags":["TransactionInvoiceCommentService"],"summary":"Create","description":"Creates the comment with the given properties.","operationId":"TransactionInvoiceCommentService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The comment object which should be created.","required":true,"schema":{"$ref":"#/definitions/TransactionInvoiceComment.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionInvoiceComment"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-comment-service--create"}}},"/transaction-invoice-comment/read":{"get":{"tags":["TransactionInvoiceCommentService"],"summary":"Read","description":"Reads the comment with the given 'id' and returns it.","operationId":"TransactionInvoiceCommentService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the comment which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionInvoiceComment"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-comment-service--read"}}},"/transaction-invoice-comment/delete":{"post":{"tags":["TransactionInvoiceCommentService"],"summary":"Delete","description":"Deletes the comment with the given id.","operationId":"TransactionInvoiceCommentService_Delete","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"id","description":"","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-comment-service--delete"}}},"/transaction-invoice/search":{"post":{"tags":["TransactionInvoiceService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"TransactionInvoiceService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the transaction invoices which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/TransactionInvoice"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-service--search"}}},"/transaction-invoice/isReplacementPossible":{"get":{"tags":["TransactionInvoiceService"],"summary":"isReplacementPossible","description":"Returns whether the transaction invoice with the given id can be replaced.","operationId":"TransactionInvoiceService_IsReplacementPossible","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The invoice which should be checked if a replacement is possible.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"boolean"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-service--is-replacement-possible"}}},"/transaction-invoice/count":{"post":{"tags":["TransactionInvoiceService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"TransactionInvoiceService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-service--count"}}},"/transaction-invoice/read":{"get":{"tags":["TransactionInvoiceService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"TransactionInvoiceService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction invoices which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionInvoice"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-service--read"}}},"/transaction-invoice/getInvoiceDocument":{"get":{"tags":["TransactionInvoiceService"],"summary":"getInvoiceDocument","description":"Returns the PDF document for the transaction invoice with given id.","operationId":"TransactionInvoiceService_GetInvoiceDocument","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction invoice to get the document for.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/RenderedDocument"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-service--get-invoice-document"}}},"/transaction-invoice/getInvoiceDocumentWithTargetMediaType":{"get":{"tags":["TransactionInvoiceService"],"summary":"getInvoiceDocumentWithTargetMediaType","description":"Returns the PDF document for the transaction invoice with given id and target media type id.","operationId":"TransactionInvoiceService_GetInvoiceDocumentWithTargetMediaType","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction invoice to get the document for.","required":true,"type":"integer","format":"int64"},{"name":"targetMediaTypeId","in":"query","description":"The id of the target media type for which the invoice should be generated for.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/RenderedDocument"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-service--get-invoice-document-with-target-media-type"}}},"/transaction-invoice/replace":{"post":{"tags":["TransactionInvoiceService"],"summary":"replace","description":"Replaces the transaction invoice with given id with the replacement and returns the new transaction invoice.","operationId":"TransactionInvoiceService_Replace","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction invoices which should be replaced.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"replacement","description":"","required":true,"schema":{"$ref":"#/definitions/TransactionInvoiceReplacement"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionInvoice"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-service--replace"}}},"/transaction-invoice/markAsPaid":{"post":{"tags":["TransactionInvoiceService"],"summary":"Mark as Paid","description":"Marks the transaction invoice with the given id as paid.","operationId":"TransactionInvoiceService_MarkAsPaid","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction invoice which should be marked as paid.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionInvoice"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-service--mark-as-paid"}}},"/transaction-invoice/markAsDerecognized":{"post":{"tags":["TransactionInvoiceService"],"summary":"Mark as Derecognized","description":"Marks the transaction invoice with the given id as derecognized.","operationId":"TransactionInvoiceService_MarkAsDerecognized","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction invoice which should be marked as derecognized.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionInvoice"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-invoice-service--mark-as-derecognized"}}},"/transaction-lightbox/javascript-url":{"get":{"tags":["TransactionLightboxService"],"summary":"Build JavaScript URL","description":"This operation creates the URL which can be used to embed the JavaScript for handling the Lightbox checkout flow.","operationId":"TransactionLightboxService_JavascriptUrl","schemes":["https"],"consumes":[],"produces":["text/plain;charset=utf-8","application/json"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"string"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-lightbox-service--javascript-url"}}},"/transaction-line-item-version/count":{"post":{"tags":["TransactionLineItemVersionService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"TransactionLineItemVersionService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-line-item-version-service--count"}}},"/transaction-line-item-version/read":{"get":{"tags":["TransactionLineItemVersionService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"TransactionLineItemVersionService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The ID of the line item version which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionLineItemVersion"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-line-item-version-service--read"}}},"/transaction-line-item-version/search":{"post":{"tags":["TransactionLineItemVersionService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"TransactionLineItemVersionService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts line item versions which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/TransactionLineItemVersion"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-line-item-version-service--search"}}},"/transaction-line-item-version/create":{"post":{"tags":["TransactionLineItemVersionService"],"summary":"create","description":"This operation applies a line item version on a particular transaction.","operationId":"TransactionLineItemVersionService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"lineItemVersion","description":"The line item version object which should be created.","required":true,"schema":{"$ref":"#/definitions/TransactionLineItemVersion.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionLineItemVersion"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-line-item-version-service--create"}}},"/transaction-payment-page/payment-page-url":{"get":{"tags":["TransactionPaymentPageService"],"summary":"Build Payment Page URL","description":"This operation creates the URL to which the user should be redirected to when the payment page should be used.","operationId":"TransactionPaymentPageService_PaymentPageUrl","schemes":["https"],"consumes":[],"produces":["text/plain;charset=utf-8","application/json"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"string"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-payment-page-service--payment-page-url"}}},"/transaction/confirm":{"post":{"tags":["TransactionService"],"summary":"Confirm","description":"The confirm operation marks the transaction as confirmed. Once the transaction is confirmed no more changes can be applied.","operationId":"TransactionService_Confirm","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"transactionModel","description":"The transaction JSON object to update and confirm.","required":true,"schema":{"$ref":"#/definitions/Transaction.Pending"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Transaction"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--confirm"}}},"/transaction/processWithoutUserInteraction":{"post":{"tags":["TransactionService"],"summary":"Process Without User Interaction","description":"This operation processes the transaction without requiring that the customer is present. Means this operation applies strategies to process the transaction without a direct interaction with the buyer. This operation is suitable for recurring transactions.","operationId":"TransactionService_ProcessWithoutUserInteraction","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction which should be processed.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Transaction"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--process-without-user-interaction"}}},"/transaction/getPackingSlip":{"get":{"tags":["TransactionService"],"summary":"getPackingSlip","description":"Returns the packing slip for the transaction with given id.","operationId":"TransactionService_GetPackingSlip","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction to get the packing slip for.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/RenderedDocument"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--get-packing-slip"}}},"/transaction/fetchOneClickTokensWithCredentials":{"get":{"tags":["TransactionService"],"summary":"Fetch One Click Tokens with Credentials","description":"This operation returns the token version objects which references the tokens usable as one-click payment tokens for the provided transaction.","operationId":"TransactionService_FetchOneClickTokensWithCredentials","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"credentials","in":"query","description":"The credentials identifies the transaction and contains the security details which grants the access this operation.","required":true,"type":"string"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/TokenVersion"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--fetch-one-click-tokens-with-credentials"}}},"/transaction/export":{"post":{"tags":["TransactionService"],"summary":"Export","description":"Exports the transactions into a CSV file. The file will contain the properties defined in the request.","operationId":"TransactionService_Export","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["text/csv","application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"The request controls the entries which are exported.","required":true,"schema":{"$ref":"#/definitions/EntityExportRequest"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"string","format":"binary"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--export"}}},"/transaction/readWithCredentials":{"get":{"tags":["TransactionService"],"summary":"Read With Credentials","description":"Reads the transaction with the given 'id' and returns it. This method uses the credentials to authenticate and identify the transaction.","operationId":"TransactionService_ReadWithCredentials","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"credentials","in":"query","description":"The credentials identifies the transaction and contains the security details which grants the access this operation.","required":true,"type":"string"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Transaction"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--read-with-credentials"}}},"/transaction/search":{"post":{"tags":["TransactionService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"TransactionService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the transactions which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/Transaction"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--search"}}},"/transaction/fetch-payment-methods-with-credentials":{"get":{"tags":["TransactionService"],"summary":"Fetch Possible Payment Methods with Credentials","description":"This operation allows to get the payment method configurations which can be used with the provided transaction.","operationId":"TransactionService_FetchPaymentMethodsWithCredentials","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"credentials","in":"query","description":"The credentials identifies the transaction and contains the security details which grants the access this operation.","required":true,"type":"string"},{"name":"integrationMode","in":"query","description":"The integration mode defines the type of integration that is applied on the transaction.","required":true,"type":"string"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentMethodConfiguration"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--fetch-payment-methods-with-credentials"}}},"/transaction/createTransactionCredentials":{"post":{"tags":["TransactionService"],"summary":"Create Transaction Credentials","description":"This operation allows to create transaction credentials to delegate temporarily the access to the web service API for this particular transaction.","operationId":"TransactionService_CreateTransactionCredentials","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"string"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--create-transaction-credentials"}}},"/transaction/getSuccessfulChargeAttempt":{"get":{"tags":["TransactionService"],"summary":"Get Successful Charge Attempt","description":"Returns the successful charge attempt that authorized the transaction with the given id. When the transaction has no successful charge attempt yet, the transaction status is returned instead, so the endpoint can be polled until the charge attempt appears. Note that a successful charge attempt confirms the authorization of the transaction, not its completion. When the transaction is charged with deferred payment, a successful charge attempt does not guarantee that the transaction will be completed and fulfilled, so this operation is not suited to confirming the final fulfillment of such a transaction. In that case, we recommend confirming that the transaction has been captured and is successful, using either the completion read API or the transaction read API.","operationId":"TransactionService_GetSuccessfulChargeAttempt","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction to get the successful charge attempt for.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/ChargeAttemptLookupResult"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--get-successful-charge-attempt"}}},"/transaction/processOneClickTokenAndRedirectWithCredentials":{"post":{"tags":["TransactionService"],"summary":"Process One-Click Token with Credentials","description":"This operation assigns the given token to the transaction and process it. This method will return an URL where the customer has to be redirect to complete the transaction.","operationId":"TransactionService_ProcessOneClickTokenAndRedirectWithCredentials","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"credentials","in":"query","description":"The credentials identifies the transaction and contains the security details which grants the access this operation.","required":true,"type":"string"},{"name":"tokenId","in":"query","description":"The token ID is used to load the corresponding token and to process the transaction with it.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"string"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--process-one-click-token-and-redirect-with-credentials"}}},"/transaction/deleteOneClickTokenWithCredentials":{"post":{"tags":["TransactionService"],"summary":"Delete One-Click Token with Credentials","description":"This operation removes the given token.","operationId":"TransactionService_DeleteOneClickTokenWithCredentials","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"credentials","in":"query","description":"The credentials identifies the transaction and contains the security details which grants the access this operation.","required":true,"type":"string"},{"name":"tokenId","in":"query","description":"The token ID will be used to find the token which should be removed.","required":true,"type":"integer","format":"int64"}],"responses":{"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--delete-one-click-token-with-credentials"}}},"/transaction/update":{"post":{"tags":["TransactionService"],"summary":"Update","description":"This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.","operationId":"TransactionService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The transaction object with the properties which should be updated.","required":true,"schema":{"$ref":"#/definitions/Transaction.Pending"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Transaction"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--update"}}},"/transaction/create":{"post":{"tags":["TransactionService"],"summary":"Create","description":"Creates the entity with the given properties.","operationId":"TransactionService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"transaction","description":"The transaction object which should be created.","required":true,"schema":{"$ref":"#/definitions/Transaction.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Transaction"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--create"}}},"/transaction/read":{"get":{"tags":["TransactionService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"TransactionService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/Transaction"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--read"}}},"/transaction/getLatestTransactionLineItemVersion":{"get":{"tags":["TransactionService"],"summary":"getLatestSuccessfulTransactionLineItemVersion","description":"","operationId":"TransactionService_GetLatestTransactionLineItemVersion","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction to get the latest line item version for.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionLineItemVersion"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--get-latest-transaction-line-item-version"}}},"/transaction/fetch-payment-methods":{"get":{"tags":["TransactionService"],"summary":"Fetch Possible Payment Methods","description":"This operation allows to get the payment method configurations which can be used with the provided transaction.","operationId":"TransactionService_FetchPaymentMethods","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction which should be returned.","required":true,"type":"integer","format":"int64"},{"name":"integrationMode","in":"query","description":"The integration mode defines the type of integration that is applied on the transaction.","required":true,"type":"string"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentMethodConfiguration"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--fetch-payment-methods"}}},"/transaction/getInvoiceDocument":{"get":{"tags":["TransactionService"],"summary":"getInvoiceDocument","description":"Returns the PDF document for the transaction invoice with given id.","operationId":"TransactionService_GetInvoiceDocument","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction to get the invoice document for.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/RenderedDocument"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--get-invoice-document"}}},"/transaction/count":{"post":{"tags":["TransactionService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"TransactionService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-service--count"}}},"/transaction-void/count":{"post":{"tags":["TransactionVoidService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"TransactionVoidService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-void-service--count"}}},"/transaction-void/voidOffline":{"post":{"tags":["TransactionVoidService"],"summary":"voidOffline","description":"This operation voids the transaction offline. The void is not forwarded to the processor. This implies the processor does not do anything. This method is only here to fix manually the transaction state.","operationId":"TransactionVoidService_VoidOffline","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction which should be voided.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionVoid"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-void-service--void-offline"}}},"/transaction-void/voidOnline":{"post":{"tags":["TransactionVoidService"],"summary":"voidOnline","description":"This operation voids the transaction online. The void is forwarded to the processor. This implies that the processor may take some actions based on the void.","operationId":"TransactionVoidService_VoidOnline","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction which should be voided.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionVoid"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-void-service--void-online"}}},"/transaction-void/read":{"get":{"tags":["TransactionVoidService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"TransactionVoidService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the transaction voids which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/TransactionVoid"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-void-service--read"}}},"/transaction-void/search":{"post":{"tags":["TransactionVoidService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"TransactionVoidService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the transaction voids which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/TransactionVoid"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#transaction-void-service--search"}}},"/user-account-role/removeRole":{"post":{"tags":["UserAccountRoleService"],"summary":"Remove Role","description":"This operation removes the specified user account role.","operationId":"UserAccountRoleService_RemoveRole","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of user account role which should be removed","required":true,"type":"integer","format":"int64"}],"responses":{"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#user-account-role-service--remove-role"}}},"/user-account-role/addRole":{"post":{"tags":["UserAccountRoleService"],"summary":"Add Role","description":"This operation grants the role to the given user with in the given account.","operationId":"UserAccountRoleService_AddRole","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"userId","in":"query","description":"The id of the user to whom the role is assigned.","required":true,"type":"integer","format":"int64"},{"name":"accountId","in":"query","description":"The account to which the role is mapped.","required":true,"type":"integer","format":"int64"},{"name":"roleId","in":"query","description":"The role which is mapped to the user and account.","required":true,"type":"integer","format":"int64"},{"name":"appliesOnSubaccount","in":"query","description":"Whether the role applies only on subaccount.","required":false,"type":"boolean"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/UserAccountRole"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#user-account-role-service--add-role"}}},"/user-account-role/list":{"post":{"tags":["UserAccountRoleService"],"summary":"List Roles","description":"List all the roles that are assigned to the given user in the given account.","operationId":"UserAccountRoleService_List","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"userId","in":"query","description":"The id of the user to whom the role is assigned.","required":true,"type":"integer","format":"int64"},{"name":"accountId","in":"query","description":"The account to which the role is mapped.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/UserAccountRole"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#user-account-role-service--list"}}},"/user-space-role/removeRole":{"post":{"tags":["UserSpaceRoleService"],"summary":"Remove Role","description":"This operation removes the specified user space role.","operationId":"UserSpaceRoleService_RemoveRole","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The id of user space role which should be removed","required":true,"type":"integer","format":"int64"}],"responses":{"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#user-space-role-service--remove-role"}}},"/user-space-role/addRole":{"post":{"tags":["UserSpaceRoleService"],"summary":"Add Role","description":"This operation grants the given role to the user in the given space.","operationId":"UserSpaceRoleService_AddRole","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"userId","in":"query","description":"The id of the user to whom the role is assigned.","required":true,"type":"integer","format":"int64"},{"name":"spaceId","in":"query","description":"The space to which the role is mapped.","required":true,"type":"integer","format":"int64"},{"name":"roleId","in":"query","description":"The role which is mapped to the user and space.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/UserSpaceRole"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#user-space-role-service--add-role"}}},"/user-space-role/list":{"post":{"tags":["UserSpaceRoleService"],"summary":"List Roles","description":"List all the roles that are assigned to the given user in the given space.","operationId":"UserSpaceRoleService_List","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"userId","in":"query","description":"The id of the user to whom the role is assigned.","required":true,"type":"integer","format":"int64"},{"name":"spaceId","in":"query","description":"The space to which the role is mapped.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/UserSpaceRole"}}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#user-space-role-service--list"}}},"/web-app/uninstall":{"post":{"tags":["WebAppService"],"summary":"Uninstall","description":"This operation uninstalls the web app from the provided space. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.","operationId":"WebAppService_Uninstall","schemes":["https"],"consumes":[],"produces":[],"parameters":[{"name":"spaceId","in":"query","description":"This parameter identifies the space within which the web app should be uninstalled.","required":true,"type":"integer","format":"int64"}],"responses":{"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#web-app-service--uninstall"}}},"/web-app/confirm":{"post":{"tags":["WebAppService"],"summary":"Confirm","description":"This operation confirms the app installation. This method has to be invoked after the user returns to the web app. The request of the user will contain the code as a request parameter. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.","operationId":"WebAppService_Confirm","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"request","description":"","required":true,"schema":{"$ref":"#/definitions/WebAppConfirmationRequest"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/WebAppConfirmationResponse"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#web-app-service--confirm"}}},"/web-app/check-installation":{"get":{"tags":["WebAppService"],"summary":"Check Installation","description":"This operation returns true when the app is installed in given space. The web app is implied by the client ID resp. user ID that is been used to invoke this operation.","operationId":"WebAppService_CheckInstallation","schemes":["https"],"consumes":[],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"This parameter identifies the space which should be checked if the web app is installed.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"boolean"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#web-app-service--check-installation"}}},"/webhook-encryption/read":{"get":{"tags":["WebhookEncryptionService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"WebhookEncryptionService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"id","in":"query","description":"The ID of the key version.","required":true,"type":"string"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/WebhookEncryptionPublicKey"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#webhook-encryption-service--read"}}},"/webhook-listener/update":{"post":{"tags":["WebhookListenerService"],"summary":"Update","description":"This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.","operationId":"WebhookListenerService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The webhook listener object with all the properties which should be updated. The id and the version are required properties.","required":true,"schema":{"$ref":"#/definitions/WebhookListener.Update"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/WebhookListener"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#webhook-listener-service--update"}}},"/webhook-listener/create":{"post":{"tags":["WebhookListenerService"],"summary":"Create","description":"Creates the entity with the given properties.","operationId":"WebhookListenerService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The webhook listener object with the properties which should be created.","required":true,"schema":{"$ref":"#/definitions/WebhookListener.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/WebhookListener"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#webhook-listener-service--create"}}},"/webhook-listener/search":{"post":{"tags":["WebhookListenerService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"WebhookListenerService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the webhook listeners which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/WebhookListener"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#webhook-listener-service--search"}}},"/webhook-listener/delete":{"post":{"tags":["WebhookListenerService"],"summary":"Delete","description":"Deletes the entity with the given id.","operationId":"WebhookListenerService_Delete","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"id","description":"","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#webhook-listener-service--delete"}}},"/webhook-listener/read":{"get":{"tags":["WebhookListenerService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"WebhookListenerService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the webhook listener which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/WebhookListener"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#webhook-listener-service--read"}}},"/webhook-listener/count":{"post":{"tags":["WebhookListenerService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"WebhookListenerService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#webhook-listener-service--count"}}},"/webhook-url/count":{"post":{"tags":["WebhookUrlService"],"summary":"Count","description":"Counts the number of items in the database as restricted by the given filter.","operationId":"WebhookUrlService_Count","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"filter","description":"The filter which restricts the entities which are used to calculate the count.","required":false,"schema":{"$ref":"#/definitions/EntityQueryFilter"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"integer","format":"int64"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#webhook-url-service--count"}}},"/webhook-url/search":{"post":{"tags":["WebhookUrlService"],"summary":"Search","description":"Searches for the entities as specified by the given query.","operationId":"WebhookUrlService_Search","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"query","description":"The query restricts the webhook urls which are returned by the search.","required":true,"schema":{"$ref":"#/definitions/EntityQuery"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"type":"array","items":{"$ref":"#/definitions/WebhookUrl"}}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#webhook-url-service--search"}}},"/webhook-url/delete":{"post":{"tags":["WebhookUrlService"],"summary":"Delete","description":"Deletes the entity with the given id.","operationId":"WebhookUrlService_Delete","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"id","description":"","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#webhook-url-service--delete"}}},"/webhook-url/update":{"post":{"tags":["WebhookUrlService"],"summary":"Update","description":"This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.","operationId":"WebhookUrlService_Update","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The webhook url object with all the properties which should be updated. The id and the version are required properties.","required":true,"schema":{"$ref":"#/definitions/WebhookUrl.Update"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/WebhookUrl"}},"409":{"description":"This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.","schema":{"$ref":"#/definitions/ClientError"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#webhook-url-service--update"}}},"/webhook-url/create":{"post":{"tags":["WebhookUrlService"],"summary":"Create","description":"Creates the entity with the given properties.","operationId":"WebhookUrlService_Create","schemes":["https"],"consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entity","description":"The webhook url object with the properties which should be created.","required":true,"schema":{"$ref":"#/definitions/WebhookUrl.Create"}}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/WebhookUrl"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#webhook-url-service--create"}}},"/webhook-url/read":{"get":{"tags":["WebhookUrlService"],"summary":"Read","description":"Reads the entity with the given 'id' and returns it.","operationId":"WebhookUrlService_Read","schemes":["https"],"consumes":["*/*"],"produces":["application/json;charset=utf-8"],"parameters":[{"name":"spaceId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The id of the webhook url which should be returned.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"This status code indicates that a client request was successfully received, understood, and accepted.","schema":{"$ref":"#/definitions/WebhookUrl"}},"442":{"description":"This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.","schema":{"$ref":"#/definitions/ClientError"}},"542":{"description":"This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.","schema":{"$ref":"#/definitions/ServerError"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#webhook-url-service--read"}}}},"definitions":{"Abstract.Account.Update":{"type":"object","properties":{"name":{"type":"string","description":"The name used to identify the account.","title":"Name","minLength":3,"maxLength":200},"subaccountLimit":{"type":"integer","format":"int64","description":"The number of sub-accounts that can be created within this account.","title":"Subaccount Limit"}},"title":"Abstract Account","x-model-behavior":"ABSTRACT"},"Abstract.ApplicationUser.Update":{"type":"object","properties":{"name":{"type":"string","description":"The name used to identify the application user.","title":"Name","maxLength":256},"requestLimit":{"type":"integer","format":"int64","description":"The maximum number of API requests that are accepted every 2 minutes.","title":"Request Limit"},"state":{"description":"The object's current state.","title":"State","$ref":"#/definitions/CreationEntityState"}},"title":"Abstract Application User","x-model-behavior":"ABSTRACT"},"Abstract.Customer.Active":{"type":"object","properties":{"customerId":{"type":"string","description":"The customer's ID in the merchant's system.","title":"Customer Id","maxLength":100},"emailAddress":{"type":"string","description":"The customer's email address.","title":"Email Address","maxLength":254},"familyName":{"type":"string","description":"The customer's family or last name.","title":"Family Name","maxLength":100},"givenName":{"type":"string","description":"The customer's given or first name.","title":"Given Name","maxLength":100},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language"},"metaData":{"type":"object","description":"Allow to store additional information about the object.","title":"Meta Data","additionalProperties":{"type":"string"}},"preferredCurrency":{"type":"string","description":"The customer's preferred currency.","title":"Preferred Currency"}},"title":"Abstract Customer","x-model-behavior":"ABSTRACT"},"Abstract.CustomerAddress.Active":{"type":"object","properties":{"address":{"description":"The actual postal address.","title":"Address","$ref":"#/definitions/CustomerPostalAddress.Create"},"addressType":{"description":"Whether the address is for billing or shipping or both.","title":"Address Type","$ref":"#/definitions/CustomerAddressType"}},"title":"Abstract Customer Address","x-model-behavior":"ABSTRACT"},"Abstract.CustomerComment.Active":{"type":"object","properties":{"content":{"type":"string","description":"The comment's actual content.","title":"Content","maxLength":262144}},"title":"Abstract Customer Comment","x-model-behavior":"ABSTRACT"},"Abstract.HumanUser.Update":{"type":"object","properties":{"emailAddress":{"type":"string","description":"The user's email address.","title":"Email Address","maxLength":128},"firstname":{"type":"string","description":"The user's first name.","title":"First Name","maxLength":100},"language":{"type":"string","description":"The user's preferred language.","title":"Language"},"lastname":{"type":"string","description":"The user's last name.","title":"Last Name","maxLength":100},"mobilePhoneNumber":{"type":"string","description":"The user's mobile phone number.","title":"Mobile Phone Number","maxLength":30},"state":{"description":"The object's current state.","title":"State","$ref":"#/definitions/CreationEntityState"},"timeZone":{"type":"string","description":"The user's time zone. If none is specified, the one provided by the browser will be used.","title":"Time Zone"},"twoFactorEnabled":{"type":"boolean","description":"Whether two-factor authentication is enabled for this user.","title":"Two-Factor Authentication"}},"title":"Abstract Human User","x-model-behavior":"ABSTRACT"},"Abstract.RefundComment.Active":{"type":"object","properties":{"content":{"type":"string","description":"The comment's actual content.","title":"Content","maxLength":262144}},"title":"Abstract Comment","x-model-behavior":"ABSTRACT"},"Abstract.Space.Update":{"type":"object","properties":{"name":{"type":"string","description":"The name used to identify the space.","title":"Name","minLength":3,"maxLength":200},"postalAddress":{"description":"The address that is used in communication with clients for example in emails, documents, etc.","title":"Postal Address","$ref":"#/definitions/SpaceAddress.Create"},"primaryCurrency":{"type":"string","description":"The currency that is used to display aggregated amounts in the space.","title":"Primary Currency"},"requestLimit":{"type":"integer","format":"int64","description":"The maximum number of API requests that are accepted within two minutes. This limit can only be changed with special privileges.","title":"Request Limit"},"state":{"description":"The object's current state.","title":"State","$ref":"#/definitions/CreationEntityState"},"technicalContactAddresses":{"type":"array","description":"The email address that will receive messages about technical issues and errors that occur in the space.","title":"Technical Contact Addresses","uniqueItems":true,"items":{"type":"string"}},"timeZone":{"type":"string","description":"The time zone that is used to schedule and run background processes. This does not affect the formatting of dates in the user interface.","title":"Time Zone"}},"title":"Abstract Space","x-model-behavior":"ABSTRACT"},"Abstract.Token.Update":{"type":"object","properties":{"customerEmailAddress":{"type":"string","description":"The customer's email address.","title":"Customer Email Address","maxLength":150},"customerId":{"type":"string","description":"The unique identifier of the customer in the external system.","title":"Customer ID"},"enabledForOneClickPayment":{"type":"boolean","description":"Whether the token is enabled for one-click payments, which simplify the payment process for the customer. One-click tokens are linked to customers via the customer ID.","title":"Enabled For One-Click Payment"},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language"},"timeZone":{"type":"string","description":"The customer's time zone, which affects how dates and times are formatted when communicating with the customer.","title":"Time Zone"},"tokenReference":{"type":"string","description":"The reference used to identify the payment token (e.g. the customer's ID or email address).","title":"Token Reference","maxLength":100}},"title":"Abstract Token . Update","x-model-behavior":"ABSTRACT"},"Abstract.Transaction.Pending":{"type":"object","properties":{"allowedPaymentMethodBrands":{"type":"array","description":"The payment method brands that can be used to authorize the transaction.","title":"Allowed Payment Method Brands","items":{"type":"integer","format":"int64"}},"allowedPaymentMethodConfigurations":{"type":"array","description":"The payment method configurations that can be used to authorize the transaction.","title":"Allowed Payment Method Configurations","items":{"type":"integer","format":"int64"}},"billingAddress":{"description":"The address associated with the payment method for invoicing and transaction processing purposes.","title":"Billing Address","$ref":"#/definitions/Address.Create"},"completionBehavior":{"description":"The behavior that controls when the transaction is completed.","title":"Completion Behavior","$ref":"#/definitions/TransactionCompletionBehavior"},"currency":{"type":"string","description":"The three-letter code (ISO 4217 format) of the transaction's currency.","title":"Currency"},"customerEmailAddress":{"type":"string","description":"The customer's email address.","title":"Customer Email Address","maxLength":254},"customerId":{"type":"string","description":"The unique identifier of the customer in the external system.","title":"Customer ID"},"failedUrl":{"type":"string","description":"The URL to redirect the customer back to after they canceled or failed to authenticated their payment.","title":"Failed Url","minLength":9,"maxLength":2000},"invoiceMerchantReference":{"type":"string","description":"The merchant's reference used to identify the invoice.","title":"Invoice Merchant Reference","maxLength":100},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language"},"lineItems":{"type":"array","description":"The line items purchased by the customer.","title":"Line Items","items":{"$ref":"#/definitions/LineItem.Create"}},"merchantReference":{"type":"string","description":"The merchant's reference used to identify the transaction.","title":"Merchant Reference","maxLength":100},"metaData":{"type":"object","description":"Allow to store additional information about the object.","title":"Meta Data","additionalProperties":{"type":"string"}},"shippingAddress":{"description":"The address to where the order will be shipped.","title":"Shipping Address","$ref":"#/definitions/Address.Create"},"shippingMethod":{"type":"string","description":"The name of the shipping method used to ship the products.","title":"Shipping Method","maxLength":200},"successUrl":{"type":"string","description":"The URL to redirect the customer back to after they successfully authenticated their payment.","title":"Success Url","minLength":9,"maxLength":2000},"timeZone":{"type":"string","description":"The customer's time zone, which affects how dates and times are formatted when communicating with the customer.","title":"Time Zone"},"token":{"type":"integer","format":"int64","description":"The payment token that should be used to charge the customer.","title":"Token"},"tokenizationMode":{"description":"The tokenization mode specifies whether and how the tokenization of payment information is applied to the transaction.","title":"Tokenization Mode","$ref":"#/definitions/TokenizationMode"}},"title":"Abstract Transaction","x-model-behavior":"ABSTRACT"},"Abstract.TransactionComment.Active":{"type":"object","properties":{"content":{"type":"string","description":"The comment's actual content.","title":"Content","maxLength":262144}},"title":"Abstract Comment","x-model-behavior":"ABSTRACT"},"Abstract.TransactionInvoiceComment.Active":{"type":"object","properties":{"content":{"type":"string","description":"The comment's actual content.","title":"Content","maxLength":262144}},"title":"Abstract Comment","x-model-behavior":"ABSTRACT"},"Abstract.WebhookListener.Update":{"type":"object","properties":{"entityStates":{"type":"array","description":"The entity's target states that are to be monitored.","title":"Entity States","uniqueItems":true,"items":{"type":"string"}},"name":{"type":"string","description":"The name used to identify the webhook listener.","title":"Name","maxLength":50},"notifyEveryChange":{"type":"boolean","description":"Whether every update of the entity or only state changes are to be monitored.","title":"Notify Every Change"},"state":{"description":"The object's current state.","title":"State","$ref":"#/definitions/CreationEntityState"}},"title":"Abstract Webhook Listener","x-model-behavior":"ABSTRACT"},"Abstract.WebhookUrl.Update":{"type":"object","properties":{"name":{"type":"string","description":"The name used to identify the webhook URL.","title":"Name","maxLength":50},"state":{"description":"The object's current state.","title":"State","$ref":"#/definitions/CreationEntityState"},"url":{"type":"string","description":"The actual URL where notifications about entity changes are sent to.","title":"Url","minLength":9,"maxLength":500}},"title":"Abstract Webhook URL","x-model-behavior":"ABSTRACT"},"Account":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether this account and all its parent accounts are active.","title":"Active","readOnly":true},"activeOrRestrictedActive":{"type":"boolean","description":"Whether this account and all its parent accounts are active or restricted active.","title":"Active Or Restricted Active","readOnly":true},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the account was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the account was created.","title":"Created On","readOnly":true},"deletedBy":{"type":"integer","format":"int64","description":"The ID of a user the account was deleted by.","title":"Deleted By","readOnly":true},"deletedOn":{"type":"string","format":"date-time","description":"The date and time when the account was deleted.","title":"Deleted On","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the account.","title":"Name","readOnly":true,"minLength":3,"maxLength":200},"parentAccount":{"description":"The parent account responsible for administering this account.","title":"Parent Account","readOnly":true,"$ref":"#/definitions/Account"},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"restrictedActive":{"type":"boolean","description":"Whether this account and all its parent accounts are active or restricted active. There is at least one account that is restricted active.","title":"Restricted Active","readOnly":true},"scope":{"type":"integer","format":"int64","description":"The scope that the account belongs to.","title":"Scope","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/AccountState"},"subaccountLimit":{"type":"integer","format":"int64","description":"The number of sub-accounts that can be created within this account.","title":"Subaccount Limit","readOnly":true},"type":{"description":"The account's type which defines its role and capabilities.","title":"Type","readOnly":true,"$ref":"#/definitions/AccountType"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_account"},"title":"Account","description":"","x-model-behavior":"READ"},"Account.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_account_create"},"title":"Account","allOf":[{"$ref":"#/definitions/Abstract.Account.Update"},{"type":"object","required":["scope"],"properties":{"parentAccount":{"type":"integer","format":"int64","description":"The parent account responsible for administering this account.","title":"Parent Account"},"scope":{"type":"integer","format":"int64","description":"The scope that the account belongs to.","title":"Scope"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_account_create"},"title":"Account","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"Account.Update":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_account_update"},"title":"Account","allOf":[{"$ref":"#/definitions/Abstract.Account.Update"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_account_update"},"title":"Account","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"},"AccountState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_accountstate"},"title":"Account State","description":"","enum":["CREATE","RESTRICTED_ACTIVE","ACTIVE","INACTIVE","DELETING","DELETED"],"x-model-behavior":"ENUM"},"AccountType":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_accounttype"},"title":"Account Type","description":"","enum":["MASTER","REGULAR","SUBACCOUNT"],"x-model-behavior":"ENUM"},"Address":{"type":"object","properties":{"city":{"type":"string","description":"The city, town or village.","title":"City","readOnly":true,"maxLength":100},"commercialRegisterNumber":{"type":"string","description":"The commercial registration number of the organization.","title":"Commercial Register Number","readOnly":true,"maxLength":100},"country":{"type":"string","description":"The two-letter country code (ISO 3166 format).","title":"Country","readOnly":true},"dateOfBirth":{"type":"string","format":"date","description":"The date of birth.","title":"Date Of Birth","readOnly":true},"dependentLocality":{"type":"string","description":"The dependent locality which is a sub-division of the state.","title":"Dependent Locality","readOnly":true,"maxLength":100},"emailAddress":{"type":"string","description":"The email address.","title":"Email Address","readOnly":true,"maxLength":254},"familyName":{"type":"string","description":"The family or last name.","title":"Family Name","readOnly":true,"maxLength":100},"gender":{"description":"The gender.","title":"Gender","readOnly":true,"$ref":"#/definitions/Gender"},"givenName":{"type":"string","description":"The given or first name.","title":"Given Name","readOnly":true,"maxLength":100},"legalOrganizationForm":{"description":"The legal form of the organization.","title":"Legal Organization Form","readOnly":true,"$ref":"#/definitions/LegalOrganizationForm"},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","title":"Mobile Phone Number","readOnly":true,"maxLength":100},"organizationName":{"type":"string","description":"The organization's name.","title":"Organization Name","readOnly":true,"maxLength":100},"phoneNumber":{"type":"string","description":"The phone number.","title":"Phone Number","readOnly":true,"maxLength":100},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","title":"State","readOnly":true},"postcode":{"type":"string","description":"The postal code, also known as ZIP, postcode, etc.","title":"Postcode","readOnly":true,"maxLength":40},"salesTaxNumber":{"type":"string","description":"The sales tax number of the organization.","title":"Sales Tax Number","readOnly":true,"maxLength":100},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","title":"Salutation","readOnly":true,"maxLength":20},"socialSecurityNumber":{"type":"string","description":"The social security number.","title":"Social Security Number","readOnly":true,"maxLength":100},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","title":"Sorting Code","readOnly":true,"maxLength":100},"street":{"type":"string","description":"The street or PO Box.","title":"Street","readOnly":true,"maxLength":300}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_address"},"title":"Address","description":"","x-model-behavior":"READ"},"Address.Create":{"type":"object","properties":{"city":{"type":"string","description":"The city, town or village.","title":"City","maxLength":100},"commercialRegisterNumber":{"type":"string","description":"The commercial registration number of the organization.","title":"Commercial Register Number","maxLength":100},"country":{"type":"string","description":"The country is represented with a two-letter code (ISO 3166-1 alpha-2 standard) - for example, CH for Switzerland.","title":"Country"},"dateOfBirth":{"type":"string","format":"date","description":"The date of birth.","title":"Date Of Birth"},"dependentLocality":{"type":"string","description":"The dependent locality which is a sub-division of the state.","title":"Dependent Locality","maxLength":100},"emailAddress":{"type":"string","description":"The email address.","title":"Email Address","maxLength":254},"familyName":{"type":"string","description":"The family or last name.","title":"Family Name","maxLength":100},"gender":{"description":"The gender.","title":"Gender","$ref":"#/definitions/Gender"},"givenName":{"type":"string","description":"The given or first name.","title":"Given Name","maxLength":100},"legalOrganizationForm":{"type":"integer","format":"int64","description":"The legal form of the organization.","title":"Legal Organization Form"},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","title":"Mobile Phone Number","maxLength":100},"organizationName":{"type":"string","description":"The organization's name.","title":"Organization Name","maxLength":100},"phoneNumber":{"type":"string","description":"The phone number.","title":"Phone Number","maxLength":100},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","title":"State"},"postcode":{"type":"string","description":"The postal code, also known as ZIP, postcode, etc.","title":"Postcode","maxLength":40},"salesTaxNumber":{"type":"string","description":"The sales tax number of the organization.","title":"Sales Tax Number","maxLength":100},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","title":"Salutation","maxLength":20},"socialSecurityNumber":{"type":"string","description":"The social security number.","title":"Social Security Number","maxLength":100},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","title":"Sorting Code","maxLength":100},"street":{"type":"string","description":"The street or PO Box.","title":"Street","maxLength":300}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_address_create"},"title":"Address in Create State","description":"","x-model-behavior":"CREATE"},"ApplicationUser":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_applicationuser"},"title":"Application User","allOf":[{"$ref":"#/definitions/User"},{"type":"object","properties":{"name":{"type":"string","description":"The name used to identify the application user.","title":"Name","readOnly":true,"maxLength":256},"primaryAccount":{"type":"integer","format":"int64","description":"The primary account that the user belongs to.","title":"Primary Account","readOnly":true},"requestLimit":{"type":"integer","format":"int64","description":"The maximum number of API requests that are accepted every 2 minutes.","title":"Request Limit","readOnly":true},"scope":{"type":"integer","format":"int64","description":"The scope that the user belongs to.","title":"Scope","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_applicationuser"},"title":"Application User","description":"","x-model-behavior":"READ"}],"description":"","x-model-behavior":"READ"},"ApplicationUser.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_applicationuser_create"},"title":"Application User","allOf":[{"$ref":"#/definitions/Abstract.ApplicationUser.Update"},{"type":"object","required":["primaryAccount"],"properties":{"primaryAccount":{"type":"integer","format":"int64","description":"The primary account that the user belongs to.","title":"Primary Account"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_applicationuser_create"},"title":"Application User","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"ApplicationUser.CreateWithMacKey":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_applicationuser_createwithmackey"},"title":"Application User","allOf":[{"$ref":"#/definitions/ApplicationUser"},{"type":"object","properties":{"macKey":{"type":"string","description":"The user's authentication key securing requests. Only displayed a single time after the user has been created.","title":"Mac Key","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_applicationuser_createwithmackey"},"title":"Application User","description":"","x-model-behavior":"READ"}],"description":"","x-model-behavior":"READ"},"ApplicationUser.Update":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_applicationuser_update"},"title":"Application User","allOf":[{"$ref":"#/definitions/Abstract.ApplicationUser.Update"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_applicationuser_update"},"title":"Application User","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"},"AuthenticatedCardData":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_authenticatedcarddata"},"title":"Authenticated Card Data","allOf":[{"$ref":"#/definitions/TokenizedCardData"},{"type":"object","properties":{"cardholderAuthentication":{"description":"Optional authentication details for the cardholder, such as 3D Secure authentication, used when the cardholder has already been verified during the transaction for added security.","title":"Cardholder Authentication","readOnly":true,"$ref":"#/definitions/CardholderAuthentication"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_authenticatedcarddata"},"title":"Authenticated Card Data","description":"","x-model-behavior":"READ"}],"description":"","x-model-behavior":"READ"},"AuthenticatedCardData.Create":{"type":"object","required":["primaryAccountNumber"],"properties":{"cardHolderName":{"type":"string","description":"The name of the cardholder, as printed on the card, identifying the card owner.","title":"Cardholder Name","maxLength":100},"cardVerificationCode":{"type":"string","description":"The security code used to validate the card during transactions.","title":"Card Verification Code (CVC)","minLength":3,"maxLength":4},"cardholderAuthentication":{"description":"Optional authentication details for the cardholder, such as 3D Secure authentication, used when the cardholder has already been verified during the transaction for added security.","title":"Cardholder Authentication","$ref":"#/definitions/CardholderAuthentication.Create"},"cryptogram":{"description":"An additional authentication value that enhances the security of tokenized card transactions.","title":"Cryptogram","$ref":"#/definitions/CardCryptogram.Create"},"expiryDate":{"type":"string","description":"The expiry date of the card, indicating its validity period in yyyy-mm format (e.g., 2023-09).","title":"Expiry Date"},"panType":{"description":"The type of PAN or token, indicating the source or security method of the card information.","title":"PAN Type","$ref":"#/definitions/PanType"},"primaryAccountNumber":{"type":"string","description":"The card's primary account number (PAN), the unique identifier of the card.","title":"Primary Account Number (PAN)","minLength":10,"maxLength":30},"recurringIndicator":{"description":"The indicator used to distinguish between recurring and one-time transactions. If omitted, it will be automatically determined based on the transaction's properties.","title":"Recurring Indicator","$ref":"#/definitions/RecurringIndicator"},"schemeTransactionReference":{"type":"string","description":"A reference specific to the card's transaction within its payment scheme.","title":"Scheme Transaction Reference","maxLength":100},"tokenRequestorId":{"type":"string","description":"The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.","title":"Token Requestor Identifier (TRID)"},"transactionLinkIdentifier":{"type":"string","description":"A reference specific to linking card transaction lifecycle events within the payment scheme.","title":"Transaction Link Identifier","maxLength":100}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_authenticatedcarddata_create"},"title":"Authenticated Card Data . Create","description":"","x-model-behavior":"CREATE"},"CardAuthenticationResponse":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_cardauthenticationresponse"},"title":"Card Authentication Response","description":"","enum":["FULLY_AUTHENTICATED","AUTHENTICATION_NOT_REQUIRED","NOT_ENROLLED","ENROLLMENT_ERROR","AUTHENTICATION_ERROR"],"x-model-behavior":"ENUM"},"CardAuthenticationVersion":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_cardauthenticationversion"},"title":"Card Authentication Version","description":"","enum":["V1","V2"],"x-model-behavior":"ENUM"},"CardCryptogram":{"type":"object","properties":{"eci":{"type":"string","description":"The Electronic Commerce Indicator (ECI) represents the authentication level and indicates liability shift during online or card-not-present transactions.","title":"Electronic Commerce Indicator (ECI)","readOnly":true},"value":{"type":"string","description":"The cryptogram value used for securing card transactions, format varying based on the PAN type.","title":"Value","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_cardcryptogram"},"title":"Card Cryptogram","description":"","x-model-behavior":"READ"},"CardCryptogram.Create":{"type":"object","required":["value"],"properties":{"eci":{"type":"string","description":"The Electronic Commerce Indicator (ECI) represents the authentication level and indicates liability shift during online or card-not-present transactions.","title":"Electronic Commerce Indicator (ECI)"},"value":{"type":"string","description":"The cryptogram value used for securing card transactions, format varying based on the PAN type.","title":"Value"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_cardcryptogram_create"},"title":"Card Cryptogram . Create","description":"","x-model-behavior":"CREATE"},"CardholderAuthentication":{"type":"object","properties":{"authenticationIdentifier":{"type":"string","description":"The identifier (e.g., XID or DSTransactionID) assigned by the authentication system for tracking and verification.","title":"Authentication Identifier","readOnly":true},"authenticationResponse":{"description":"The result of the authentication process.","title":"Authentication Response","readOnly":true,"$ref":"#/definitions/CardAuthenticationResponse"},"authenticationValue":{"type":"string","description":"The cryptographic token (CAVV/AAV) generated during the authentication process to validate the cardholder's identity.","title":"Authentication Value","readOnly":true},"electronicCommerceIndicator":{"type":"string","description":"The Electronic Commerce Indicator (ECI) represents the authentication level and indicates liability shift during online or card-not-present transactions.","title":"Electronic Commerce Indicator (ECI)","readOnly":true},"version":{"description":"The version of the authentication protocol (e.g., 3D Secure 1.0 or 2.0) used for the transaction.","title":"Version","readOnly":true,"$ref":"#/definitions/CardAuthenticationVersion"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_cardholderauthentication"},"title":"Cardholder Authentication","description":"","x-model-behavior":"READ"},"CardholderAuthentication.Create":{"type":"object","required":["authenticationResponse","version"],"properties":{"authenticationIdentifier":{"type":"string","description":"The identifier (e.g., XID or DSTransactionID) assigned by the authentication system for tracking and verification.","title":"Authentication Identifier"},"authenticationResponse":{"description":"The result of the authentication process.","title":"Authentication Response","$ref":"#/definitions/CardAuthenticationResponse"},"authenticationValue":{"type":"string","description":"The cryptographic token (CAVV/AAV) generated during the authentication process to validate the cardholder's identity.","title":"Authentication Value"},"electronicCommerceIndicator":{"type":"string","description":"The Electronic Commerce Indicator (ECI) represents the authentication level and indicates liability shift during online or card-not-present transactions.","title":"Electronic Commerce Indicator (ECI)"},"version":{"description":"The version of the authentication protocol (e.g., 3D Secure 1.0 or 2.0) used for the transaction.","title":"Version","$ref":"#/definitions/CardAuthenticationVersion"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_cardholderauthentication_create"},"title":"Cardholder Authentication . Create","description":"","x-model-behavior":"CREATE"},"Charge":{"type":"object","properties":{"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"failureReason":{"description":"The reason for the failure of the charge.","title":"Failure Reason","readOnly":true,"$ref":"#/definitions/FailureReason"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","title":"Space View ID","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/ChargeState"},"timeZone":{"type":"string","description":"The time zone that this object is associated with.","title":"Time Zone","readOnly":true},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the charge will expire.","title":"Timeout On","readOnly":true},"transaction":{"description":"The transaction that the charge belongs to.","title":"Transaction","readOnly":true,"$ref":"#/definitions/Transaction"},"type":{"description":"The type specifying how the customer was charged.","title":"Type","readOnly":true,"$ref":"#/definitions/ChargeType"},"userFailureMessage":{"type":"string","description":"The message that can be displayed to the customer explaining why the charge failed, in the customer's language.","title":"User Failure Message","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_charge"},"title":"Charge","description":"","x-model-behavior":"READ"},"ChargeAttempt":{"type":"object","properties":{"charge":{"description":"The charge that the charge attempt belongs to.","title":"Charge","readOnly":true,"$ref":"#/definitions/Charge"},"completionBehavior":{"description":"The behavior that controls when the transaction is completed.","title":"Completion Behavior","readOnly":true,"$ref":"#/definitions/TransactionCompletionBehavior"},"connectorConfiguration":{"description":"The payment connector configuration that was used for the charge attempt.","title":"Connector Configuration","readOnly":true,"$ref":"#/definitions/PaymentConnectorConfiguration"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"customersPresence":{"description":"The customer's presence indicates whether and in what way the charge attempt's customer is present.","title":"Customers Presence","readOnly":true,"$ref":"#/definitions/CustomersPresence"},"environment":{"description":"The environment in which the charge attempt is executed.","title":"Environment","readOnly":true,"$ref":"#/definitions/ChargeAttemptEnvironment"},"failedOn":{"type":"string","format":"date-time","description":"The date and time when the charge attempt failed.","title":"Failed On","readOnly":true},"failureReason":{"description":"The reason for the failure of the charge attempt.","title":"Failure Reason","readOnly":true,"$ref":"#/definitions/FailureReason"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"initializingTokenVersion":{"type":"boolean","description":"Whether a new token version is being initialized.","title":"Initializing Token Version","readOnly":true},"invocation":{"description":"The connector invocation that the charge attempt belongs to.","title":"Invocation","readOnly":true,"$ref":"#/definitions/ConnectorInvocation"},"labels":{"type":"array","description":"The labels providing additional information about the object.","title":"Labels","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/Label"}},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","title":"Linked Transaction","readOnly":true},"nextUpdateOn":{"type":"string","format":"date-time","description":"The date and time when the next update of the object's state is planned.","title":"Next Update On","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"redirectionUrl":{"type":"string","description":"The URL to redirect the customer to after payment processing.","title":"Redirection Url","readOnly":true},"salesChannel":{"type":"integer","format":"int64","description":"The sales channel through which the charge attempt was made.","title":"Sales Channel","readOnly":true},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","title":"Space View ID","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/ChargeAttemptState"},"succeededOn":{"type":"string","format":"date-time","description":"The date and time when the charge attempt succeeded.","title":"Succeeded On","readOnly":true},"terminal":{"description":"The payment terminal through which the charge attempt was made.","title":"Terminal","readOnly":true,"$ref":"#/definitions/PaymentTerminal"},"timeZone":{"type":"string","description":"The time zone that this object is associated with.","title":"Time Zone","readOnly":true},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the object will expire.","title":"Timeout On","readOnly":true},"tokenVersion":{"description":"The token version used for the charge attempt.","title":"Token Version","readOnly":true,"$ref":"#/definitions/TokenVersion"},"userFailureMessage":{"type":"string","description":"The message that can be displayed to the customer explaining why the charge attempt failed, in the customer's language.","title":"User Failure Message","readOnly":true,"maxLength":2000},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true},"wallet":{"description":"The type of wallet used to make the charge attempt.","title":"Wallet","readOnly":true,"$ref":"#/definitions/WalletType"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargeattempt"},"title":"Charge Attempt","description":"","x-model-behavior":"READ"},"ChargeAttemptEnvironment":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargeattemptenvironment"},"title":"Charge Attempt Environment","description":"","enum":["PRODUCTION","TEST"],"x-model-behavior":"ENUM"},"ChargeAttemptLookupResult":{"type":"object","properties":{"successfulChargeAttempt":{"description":"","title":"Successful Charge Attempt","readOnly":true,"$ref":"#/definitions/ChargeAttemptProjection"},"transaction":{"description":"","title":"Transaction","readOnly":true,"$ref":"#/definitions/TransactionProjection"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargeattemptlookupresult"},"title":"Charge Attempt Lookup Result","description":"","x-model-behavior":"READ"},"ChargeAttemptProjection":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargeattemptprojection"},"title":"Charge Attempt Projection","allOf":[{"$ref":"#/definitions/ChargeAttempt"},{"type":"object","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargeattemptprojection"},"title":"Charge Attempt Projection","description":"","x-model-behavior":"READ"}],"description":"","x-model-behavior":"READ"},"ChargeAttemptState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargeattemptstate"},"title":"Charge Attempt State","description":"","enum":["PROCESSING","FAILED","SUCCESSFUL"],"x-model-behavior":"ENUM"},"ChargeFlow":{"type":"object","properties":{"conditions":{"type":"array","description":"Conditions allow to define criteria that a transaction must fulfill in order for the charge flow to be considered for processing the payment.","title":"Conditions","readOnly":true,"items":{"type":"integer","format":"int64"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the charge flow.","title":"Name","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"priority":{"type":"integer","format":"int32","description":"The priority that determines the order in which charge flows are taken into account when processing a payment. Low values are considered first.","title":"Priority","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargeflow"},"title":"Charge Flow","description":"","x-model-behavior":"READ"},"ChargeFlowLevel":{"type":"object","properties":{"asynchronousCharge":{"type":"integer","format":"int64","description":"The charge to process the payment asynchronously.","title":"Asynchronous Charge","readOnly":true},"configuration":{"description":"The configuration that was used for this charge flow level.","title":"Configuration","readOnly":true,"$ref":"#/definitions/ChargeFlowLevelConfiguration"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","title":"Linked Transaction","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/ChargeFlowLevelState"},"synchronousCharge":{"type":"integer","format":"int64","description":"The charge to process the payment synchronously.","title":"Synchronous Charge","readOnly":true},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the charge flow level will expire.","title":"Timeout On","readOnly":true},"tokenCharge":{"type":"integer","format":"int64","description":"The charge to process the payment using a token.","title":"Token Charge","readOnly":true},"transaction":{"description":"The transaction that the charge flow level belongs to.","title":"Transaction","readOnly":true,"$ref":"#/definitions/Transaction"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargeflowlevel"},"title":"Charge Flow Level","description":"","x-model-behavior":"READ"},"ChargeFlowLevelConfiguration":{"type":"object","properties":{"flow":{"description":"The charge flow that this level configuration belongs to.","title":"Charge Flow","readOnly":true,"$ref":"#/definitions/ChargeFlow"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the charge flow level configuration.","title":"Name","readOnly":true,"maxLength":100},"period":{"type":"string","description":"The duration specifies how long the level remains active before transitioning to the next one.","title":"Period","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"priority":{"type":"integer","format":"int32","description":"The priority that determines the order in which level configurations are taken into account when processing a charge flow. Low values are considered first.","title":"Priority","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"type":{"type":"integer","format":"int64","description":"The type defines the method of delivering the payment link to the customer.","title":"Type","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargeflowlevelconfiguration"},"title":"Charge Flow Level Configuration","description":"","x-model-behavior":"READ"},"ChargeFlowLevelConfigurationType":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"label":{"type":"object","description":"The localized label that describes the action triggered by the configuration type.","title":"Label","readOnly":true,"additionalProperties":{"type":"string"}},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargeflowlevelconfigurationtype"},"title":"Charge Flow Level Configuration Type","description":"","x-model-behavior":"READ"},"ChargeFlowLevelPaymentLink":{"type":"object","properties":{"chargeFlowLevel":{"description":"The charge flow level that the payment link belongs to.","title":"Charge Flow Level","readOnly":true,"$ref":"#/definitions/ChargeFlowLevel"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"paymentLink":{"type":"string","description":"The URL provided to the customer for entering their payment details and completing the transaction.","title":"Payment Link","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargeflowlevelpaymentlink"},"title":"Charge Flow Level Payment Link","description":"","x-model-behavior":"READ"},"ChargeFlowLevelState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargeflowlevelstate"},"title":"Charge Flow Level State","description":"","enum":["PENDING","FAILED","SUCCESSFUL"],"x-model-behavior":"ENUM"},"ChargeState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargestate"},"title":"Charge State","description":"","enum":["PENDING","FAILED","SUCCESSFUL"],"x-model-behavior":"ENUM"},"ChargeType":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_chargetype"},"title":"Charge Type","description":"","enum":["ASYNCHRONOUS","SYNCHRONOUS","TOKEN","TERMINAL"],"x-model-behavior":"ENUM"},"ClientError":{"type":"object","properties":{"date":{"type":"string","description":"Date when an error has occurred.","title":"Date","readOnly":true},"defaultMessage":{"type":"string","description":"The error message which is translated into the default language (i.e. English).","title":"Message in Default Language","readOnly":true},"id":{"type":"string","description":"Unique identifier of an error.","title":"ID","readOnly":true},"message":{"type":"string","description":"The error message which is translated in into the language of the client.","title":"Message","readOnly":true},"type":{"description":"The type of the client error.","title":"Type","readOnly":true,"$ref":"#/definitions/ClientErrorType"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_clienterror"},"title":"Client Error","description":"An error that is returned as the result of a bad user request or a misconfiguration.","x-model-behavior":"READ"},"ClientErrorType":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_clienterrortype"},"title":"Client Error Type","description":"The type of Client Errors which can be returned by a service.","enum":["END_USER_ERROR","CONFIGURATION_ERROR","DEVELOPER_ERROR"],"x-model-behavior":"ENUM"},"CompletionLineItem":{"type":"object","properties":{"amount":{"type":"number","description":"The total amount of the line item to be captured, including taxes.","title":"Amount","readOnly":true},"quantity":{"type":"number","description":"The number of items to be captured.","title":"Quantity","readOnly":true},"uniqueId":{"type":"string","description":"The unique identifier of the line item within the set of line items.","title":"Unique ID","readOnly":true,"maxLength":200}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_completionlineitem"},"title":"Completion Line Item","description":"","x-model-behavior":"READ"},"CompletionLineItem.Create":{"type":"object","required":["amount","quantity","uniqueId"],"properties":{"amount":{"type":"number","description":"The total amount of the line item to be captured, including taxes.","title":"Amount"},"quantity":{"type":"number","description":"The number of items to be captured.","title":"Quantity"},"uniqueId":{"type":"string","description":"The unique identifier of the line item within the set of line items.","title":"Unique ID","maxLength":200}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_completionlineitem_create"},"title":"Completion Line Item . Create","description":"","x-model-behavior":"CREATE"},"Condition":{"type":"object","properties":{"conditionType":{"type":"integer","format":"int64","description":"The condition type determines the criteria that a transaction must fulfill in order for a connector configuration to be considered for processing the payment.","title":"Condition Type","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the condition.","title":"Name","readOnly":true,"maxLength":100},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_condition"},"title":"Connector Condition","description":"A connector condition defines criteria that a transaction must meet for a connector configuration to process the payment.","x-model-behavior":"READ"},"ConditionType":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_conditiontype"},"title":"Condition Type","description":"","x-model-behavior":"READ"},"ConnectorInvocation":{"type":"object","properties":{"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"stage":{"description":"The transaction stage during which the connector invocation was performed.","title":"Stage","readOnly":true,"$ref":"#/definitions/ConnectorInvocationStage"},"timeTookInMilliseconds":{"type":"integer","format":"int64","description":"The duration, in milliseconds, taken to execute the connector invocation.","title":"Time Took In Milliseconds","readOnly":true},"transaction":{"type":"integer","format":"int64","description":"The transaction that the connector invocation belongs to.","title":"Transaction","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_connectorinvocation"},"title":"Connector Invocation","description":"","x-model-behavior":"READ"},"ConnectorInvocationStage":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_connectorinvocationstage"},"title":"Connector Invocation Stage","description":"","enum":["PAYMENT_METHOD_LIST","FORM_GENERATION","VALIDATION","AUTHORIZATION"],"x-model-behavior":"ENUM"},"CreationEntityState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_creationentitystate"},"title":"Creation Entity State","description":"","enum":["CREATE","ACTIVE","INACTIVE","DELETING","DELETED"],"x-model-behavior":"ENUM"},"CriteriaOperator":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_criteriaoperator"},"title":"Criteria Operator","description":"","enum":["CONTAINS","EQUALS","EQUALS_IGNORE_CASE","GREATER_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","NOT_EQUALS","NOT_EQUALS_IGNORE_CASE","NOT_CONTAINS","IS_NULL","IS_NOT_NULL"],"x-model-behavior":"ENUM"},"Customer":{"type":"object","properties":{"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"customerId":{"type":"string","description":"The customer's ID in the merchant's system.","title":"Customer Id","readOnly":true,"maxLength":100},"emailAddress":{"type":"string","description":"The customer's email address.","title":"Email Address","readOnly":true,"maxLength":254},"familyName":{"type":"string","description":"The customer's family or last name.","title":"Family Name","readOnly":true,"maxLength":100},"givenName":{"type":"string","description":"The customer's given or first name.","title":"Given Name","readOnly":true,"maxLength":100},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"metaData":{"type":"object","description":"Allow to store additional information about the object.","title":"Meta Data","readOnly":true,"additionalProperties":{"type":"string"}},"preferredCurrency":{"type":"string","description":"The customer's preferred currency.","title":"Preferred Currency","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customer"},"title":"Customer","description":"","x-model-behavior":"READ"},"Customer.Active":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customer_active"},"title":"Customer","allOf":[{"$ref":"#/definitions/Abstract.Customer.Active"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customer_active"},"title":"Customer","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"},"Customer.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customer_create"},"title":"Customer","allOf":[{"$ref":"#/definitions/Abstract.Customer.Active"},{"type":"object","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customer_create"},"title":"Customer","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"CustomerAddress":{"type":"object","properties":{"address":{"description":"The actual postal address.","title":"Address","readOnly":true,"$ref":"#/definitions/CustomerPostalAddress"},"addressType":{"description":"Whether the address is for billing or shipping or both.","title":"Address Type","readOnly":true,"$ref":"#/definitions/CustomerAddressType"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"customer":{"description":"The customer that the object belongs to.","title":"Customer","readOnly":true,"$ref":"#/definitions/Customer"},"defaultAddress":{"type":"boolean","description":"Whether this is the customer's default address.","title":"Default Address","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customeraddress"},"title":"Customer Address","description":"","x-model-behavior":"READ"},"CustomerAddress.Active":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customeraddress_active"},"title":"Customer Address","allOf":[{"$ref":"#/definitions/Abstract.CustomerAddress.Active"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customeraddress_active"},"title":"Customer Address","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"},"CustomerAddress.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customeraddress_create"},"title":"Customer Address","allOf":[{"$ref":"#/definitions/Abstract.CustomerAddress.Active"},{"type":"object","required":["customer"],"properties":{"customer":{"type":"integer","format":"int64","description":"The customer that the object belongs to.","title":"Customer"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customeraddress_create"},"title":"Customer Address","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"CustomerAddressType":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customeraddresstype"},"title":"Customer Address Type","description":"","enum":["BILLING","SHIPPING","BOTH"],"x-model-behavior":"ENUM"},"CustomerComment":{"type":"object","properties":{"content":{"type":"string","description":"The comment's actual content.","title":"Content","readOnly":true,"maxLength":262144},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"customer":{"type":"integer","format":"int64","description":"The customer that the object belongs to.","title":"Customer","readOnly":true},"editedBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was last updated by.","title":"Edited By","readOnly":true},"editedOn":{"type":"string","format":"date-time","description":"The date and time when the comment was last updated.","title":"Edited On","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"pinned":{"type":"boolean","description":"Whether the comment is pinned to the top.","title":"Pinned","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customercomment"},"title":"Customer Comment","description":"","x-model-behavior":"READ"},"CustomerComment.Active":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customercomment_active"},"title":"Customer Comment","allOf":[{"$ref":"#/definitions/Abstract.CustomerComment.Active"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customercomment_active"},"title":"Customer Comment","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"},"CustomerComment.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customercomment_create"},"title":"Customer Comment","allOf":[{"$ref":"#/definitions/Abstract.CustomerComment.Active"},{"type":"object","required":["customer"],"properties":{"customer":{"type":"integer","format":"int64","description":"The customer that the object belongs to.","title":"Customer"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customercomment_create"},"title":"Customer Comment","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"CustomerPostalAddress":{"type":"object","properties":{"city":{"type":"string","description":"The city, town or village.","title":"City","readOnly":true,"maxLength":100},"commercialRegisterNumber":{"type":"string","description":"The commercial registration number of the organization.","title":"Commercial Register Number","readOnly":true,"maxLength":100},"country":{"type":"string","description":"The two-letter country code (ISO 3166 format).","title":"Country","readOnly":true},"dateOfBirth":{"type":"string","format":"date","description":"The date of birth.","title":"Date Of Birth","readOnly":true},"dependentLocality":{"type":"string","description":"The dependent locality which is a sub-division of the state.","title":"Dependent Locality","readOnly":true,"maxLength":100},"emailAddress":{"type":"string","description":"The email address.","title":"Email Address","readOnly":true,"maxLength":254},"familyName":{"type":"string","description":"The family or last name.","title":"Family Name","readOnly":true,"maxLength":100},"gender":{"description":"The gender.","title":"Gender","readOnly":true,"$ref":"#/definitions/Gender"},"givenName":{"type":"string","description":"The given or first name.","title":"Given Name","readOnly":true,"maxLength":100},"legalOrganizationForm":{"description":"The legal form of the organization.","title":"Legal Organization Form","readOnly":true,"$ref":"#/definitions/LegalOrganizationForm"},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","title":"Mobile Phone Number","readOnly":true,"maxLength":100},"organizationName":{"type":"string","description":"The organization's name.","title":"Organization Name","readOnly":true,"maxLength":100},"phoneNumber":{"type":"string","description":"The phone number.","title":"Phone Number","readOnly":true,"maxLength":100},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","title":"State","readOnly":true},"postcode":{"type":"string","description":"The postal code, also known as ZIP, postcode, etc.","title":"Postcode","readOnly":true,"maxLength":40},"salesTaxNumber":{"type":"string","description":"The sales tax number of the organization.","title":"Sales Tax Number","readOnly":true,"maxLength":100},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","title":"Salutation","readOnly":true,"maxLength":20},"socialSecurityNumber":{"type":"string","description":"The social security number.","title":"Social Security Number","readOnly":true,"maxLength":100},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","title":"Sorting Code","readOnly":true,"maxLength":100},"street":{"type":"string","description":"The street or PO Box.","title":"Street","readOnly":true,"maxLength":300}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customerpostaladdress"},"title":"Customer Postal Address","description":"","x-model-behavior":"READ"},"CustomerPostalAddress.Create":{"type":"object","properties":{"city":{"type":"string","description":"The city, town or village.","title":"City","maxLength":100},"commercialRegisterNumber":{"type":"string","description":"The commercial registration number of the organization.","title":"Commercial Register Number","maxLength":100},"country":{"type":"string","description":"The two-letter country code (ISO 3166 format).","title":"Country"},"dateOfBirth":{"type":"string","format":"date","description":"The date of birth.","title":"Date Of Birth"},"dependentLocality":{"type":"string","description":"The dependent locality which is a sub-division of the state.","title":"Dependent Locality","maxLength":100},"emailAddress":{"type":"string","description":"The email address.","title":"Email Address","maxLength":254},"familyName":{"type":"string","description":"The family or last name.","title":"Family Name","maxLength":100},"gender":{"description":"The gender.","title":"Gender","$ref":"#/definitions/Gender"},"givenName":{"type":"string","description":"The given or first name.","title":"Given Name","maxLength":100},"legalOrganizationForm":{"type":"integer","format":"int64","description":"The legal form of the organization.","title":"Legal Organization Form"},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","title":"Mobile Phone Number","maxLength":100},"organizationName":{"type":"string","description":"The organization's name.","title":"Organization Name","maxLength":100},"phoneNumber":{"type":"string","description":"The phone number.","title":"Phone Number","maxLength":100},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","title":"State"},"postcode":{"type":"string","description":"The postal code, also known as ZIP, postcode, etc.","title":"Postcode","maxLength":40},"salesTaxNumber":{"type":"string","description":"The sales tax number of the organization.","title":"Sales Tax Number","maxLength":100},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","title":"Salutation","maxLength":20},"socialSecurityNumber":{"type":"string","description":"The social security number.","title":"Social Security Number","maxLength":100},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","title":"Sorting Code","maxLength":100},"street":{"type":"string","description":"The street or PO Box.","title":"Street","maxLength":300}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customerpostaladdress_create"},"title":"Customer Postal Address","description":"","x-model-behavior":"CREATE"},"CustomersPresence":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_customerspresence"},"title":"Customer's Presence","description":"","enum":["NOT_PRESENT","VIRTUAL_PRESENT","PHYSICAL_PRESENT"],"x-model-behavior":"ENUM"},"DataCollectionType":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_datacollectiontype"},"title":"Data Collection Type","description":"","enum":["ONSITE","OFFSITE"],"x-model-behavior":"ENUM"},"DeliveryIndication":{"type":"object","properties":{"automaticDecisionReason":{"description":"The reason for the automatic system decision about the delivery indication.","title":"Automatic Decision Reason","readOnly":true,"$ref":"#/definitions/DeliveryIndicationDecisionReason"},"automaticallyDecidedOn":{"type":"string","format":"date-time","description":"The date and time when an automatic decision was made.","title":"Automatically Decided On","readOnly":true},"completion":{"type":"integer","format":"int64","description":"The transaction completion that the delivery indication is linked to.","title":"Completion","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","title":"Linked Transaction","readOnly":true},"manualDecisionTimeoutOn":{"type":"string","format":"date-time","description":"The date and time by which a decision must be made before the system automatically proceeds according to the connector's predefined settings.","title":"Manual Decision Timeout On","readOnly":true},"manuallyDecidedBy":{"type":"integer","format":"int64","description":"The ID of the user who manually decided the delivery indication's state.","title":"Manually Decided By","readOnly":true},"manuallyDecidedOn":{"type":"string","format":"date-time","description":"The date and time when a manual decision was made.","title":"Manually Decided On","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/DeliveryIndicationState"},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the delivery indication will expire.","title":"Timeout On","readOnly":true},"transaction":{"description":"The payment transaction that the delivery indication is linked to.","title":"Transaction","readOnly":true,"$ref":"#/definitions/Transaction"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_deliveryindication"},"title":"Delivery Indication","description":"","x-model-behavior":"READ"},"DeliveryIndicationDecisionReason":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_deliveryindicationdecisionreason"},"title":"Delivery Indication Decision Reason","description":"","x-model-behavior":"READ"},"DeliveryIndicationState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_deliveryindicationstate"},"title":"Delivery Indication State","description":"","enum":["PENDING","NOT_SUITABLE","MANUAL_CHECK_REQUIRED","SUITABLE"],"x-model-behavior":"ENUM"},"DocumentTemplate":{"type":"object","properties":{"defaultTemplate":{"type":"boolean","description":"Whether this is the default document template which is used whenever no specific template is specified for the same template type.","title":"Default Template","readOnly":true},"deliveryEnabled":{"type":"boolean","description":"Whether documents of this template should be delivered.","title":"Delivery Enabled","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the document template.","title":"Name","readOnly":true,"maxLength":100},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"spaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Space ID","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"templateResource":{"description":"The resource path to a custom template to be used to generate PDF documents.","title":"Template Resource","readOnly":true,"$ref":"#/definitions/ResourcePath"},"type":{"type":"integer","format":"int64","description":"The document template's type.","title":"Type","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_documenttemplate"},"title":"Document Template","description":"A document template contains the customizations for a particular document template type.","x-model-behavior":"READ"},"DocumentTemplateType":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the document template type.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"feature":{"type":"integer","format":"int64","description":"The feature that this document template type belongs to.","title":"Feature","readOnly":true},"group":{"description":"The group that this document template type belongs to.","title":"Group","readOnly":true,"$ref":"#/definitions/DocumentTemplateTypeGroup"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"title":{"type":"object","description":"The localized title of the document template type.","title":"Title","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_documenttemplatetype"},"title":"Document Template Type","description":"","x-model-behavior":"READ"},"DocumentTemplateTypeGroup":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"title":{"type":"object","description":"The localized title of the group.","title":"Title","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_documenttemplatetypegroup"},"title":"Document Template Type Group","description":"","x-model-behavior":"READ"},"EntityExportRequest":{"type":"object","required":["properties"],"properties":{"properties":{"type":"array","description":"The properties is a list of property paths which should be exported.","title":"Properties","uniqueItems":true,"items":{"type":"string"}},"query":{"description":"The query limits the returned entries. The query allows to restrict the entries to return and it allows to control the order of them.","title":"Query","$ref":"#/definitions/EntityQuery"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_entityexportrequest"},"title":"Entity Export Request","description":"The entity property export request contains the information required to create an export of a list of entities.","x-model-behavior":"CREATE"},"EntityQuery":{"type":"object","properties":{"filter":{"description":"The filter node defines the root filter node of the query. The root node may contain multiple sub nodes with different filters in it.","title":"Filter","$ref":"#/definitions/EntityQueryFilter"},"language":{"type":"string","description":"The language is applied to the ordering of the entities returned. Some entity fields are language dependent and hence the language is required to order them.","title":"Language"},"numberOfEntities":{"type":"integer","format":"int32","description":"The number of entities defines how many entities should be returned. There is a maximum of 100 entities.","title":"Number Of Entities"},"orderBys":{"type":"array","description":"The order bys allows to define the ordering of the entities returned by the search.","title":"Order Bys","items":{"$ref":"#/definitions/EntityQueryOrderBy"}},"startingEntity":{"type":"integer","format":"int32","description":"The 'starting entity' defines the entity number at which the returned result should start. The entity number is the consecutive number of the entity as returned and it is not the entity id.","title":"Starting Entity"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_entityquery"},"title":"Entity Query","description":"The entity query allows to search for specific entities by providing filters. This is similar to a SQL query.","x-model-behavior":"CREATE"},"EntityQueryFilter":{"type":"object","required":["type"],"properties":{"children":{"type":"array","description":"The 'children' can contain other filter nodes which are applied to the query. This property is only applicable on filter types 'OR' and 'AND'.","title":"Children","uniqueItems":true,"items":{"$ref":"#/definitions/EntityQueryFilter"}},"fieldName":{"type":"string","description":"The 'fieldName' indicates the property on the entity which should be filtered. This property is only applicable on filter type 'LEAF'.","title":"Field Name"},"operator":{"description":"The 'operator' indicates what kind of filtering on the 'fieldName' is executed on. This property is only applicable on filter type 'LEAF'.","title":"Operator","$ref":"#/definitions/CriteriaOperator"},"type":{"description":"The filter type controls how the query node is interpreted. I.e. if the node acts as leaf node or as a filter group.","title":"Type","$ref":"#/definitions/EntityQueryFilterType"},"value":{"type":"object","description":"The 'value' is used to compare with the 'fieldName' as defined by the 'operator'. This property is only applicable on filter type 'LEAF'.","title":"Value"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_entityqueryfilter"},"title":"Entity Query Filter","description":"The query filter allows to restrict the entities which are returned.","x-model-behavior":"CREATE"},"EntityQueryFilterType":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_entityqueryfiltertype"},"title":"Entity Query Filter Type","description":"The filter type defines how the filter is interpreted. Depending of the type different properties are relevant on the filter itself.","enum":["LEAF","OR","AND"],"x-model-behavior":"ENUM"},"EntityQueryOrderBy":{"type":"object","required":["fieldName","sorting"],"properties":{"fieldName":{"type":"string","description":"","title":"Field Name"},"sorting":{"description":"","title":"Sorting","$ref":"#/definitions/EntityQueryOrderByType"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_entityqueryorderby"},"title":"Entity Query Order By","description":"The 'order by' allows to order the returned entities.","x-model-behavior":"CREATE"},"EntityQueryOrderByType":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_entityqueryorderbytype"},"title":"Order By Type","description":"The 'order by' type specifies how the result is sorted.","enum":["DESC","ASC"],"x-model-behavior":"ENUM"},"Environment":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_environment"},"title":"Environment","description":"","enum":["LIVE","PREVIEW"],"x-model-behavior":"ENUM"},"FailureCategory":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_failurecategory"},"title":"Failure Category","description":"","enum":["TEMPORARY_ISSUE","INTERNAL","END_USER","CONFIGURATION","DEVELOPER"],"x-model-behavior":"ENUM"},"FailureReason":{"type":"object","properties":{"category":{"description":"The category that the failure reason belongs to.","title":"Category","readOnly":true,"$ref":"#/definitions/FailureCategory"},"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_failurereason"},"title":"Failure Reason","description":"","x-model-behavior":"READ"},"Feature":{"type":"object","properties":{"beta":{"type":"boolean","description":"Whether the feature is in beta stage and there may still be some issues.","title":"Beta","readOnly":true},"category":{"description":"The category that the feature belongs to.","title":"Category","readOnly":true,"$ref":"#/definitions/FeatureCategory"},"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"logoPath":{"type":"string","description":"The path to the feature's logo image.","title":"Logo Path","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}},"requiredFeatures":{"type":"array","description":"The features that must be enabled for this feature to work properly.","title":"Required Features","readOnly":true,"items":{"type":"integer","format":"int64"}},"sortOrder":{"type":"integer","format":"int32","description":"When listing features, they can be sorted by this number.","title":"Sort Order","readOnly":true},"visible":{"type":"boolean","description":"Whether the feature is visible to the user.","title":"Visible","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_feature"},"title":"Feature","description":"","x-model-behavior":"READ"},"FeatureCategory":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}},"orderWeight":{"type":"integer","format":"int32","description":"When listing feature categories, they can be sorted by this number.","title":"Order Weight","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_featurecategory"},"title":"Feature Category","description":"","x-model-behavior":"READ"},"Gender":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_gender"},"title":"Gender","description":"","enum":["MALE","FEMALE"],"x-model-behavior":"ENUM"},"HumanUser":{"type":"object","properties":{"emailAddress":{"type":"string","description":"The user's email address.","title":"Email Address","readOnly":true,"maxLength":128},"emailAddressVerified":{"type":"boolean","description":"Whether the user's email address has been verified.","title":"Email Address Verification","readOnly":true},"firstname":{"type":"string","description":"The user's first name.","title":"First Name","readOnly":true,"maxLength":100},"language":{"type":"string","description":"The user's preferred language.","title":"Language","readOnly":true},"lastname":{"type":"string","description":"The user's last name.","title":"Last Name","readOnly":true,"maxLength":100},"mobilePhoneNumber":{"type":"string","description":"The user's mobile phone number.","title":"Mobile Phone Number","readOnly":true,"maxLength":30},"mobilePhoneVerified":{"type":"boolean","description":"Whether the user's mobile phone number has been verified.","title":"Mobile Phone Number Verification","readOnly":true},"primaryAccount":{"type":"integer","format":"int64","description":"The primary account that the user belongs to.","title":"Primary Account","readOnly":true},"scope":{"type":"integer","format":"int64","description":"The scope that the user belongs to.","title":"Scope","readOnly":true},"timeZone":{"type":"string","description":"The user's time zone. If none is specified, the one provided by the browser will be used.","title":"Time Zone","readOnly":true},"twoFactorEnabled":{"type":"boolean","description":"Whether two-factor authentication is enabled for this user.","title":"Two-Factor Authentication","readOnly":true},"twoFactorType":{"description":"The type of two-factor authentication that is enabled for the user.","title":"Two Factor Type","readOnly":true,"$ref":"#/definitions/TwoFactorAuthenticationType"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_humanuser"},"title":"Human User","description":"","x-model-behavior":"READ"},"HumanUser.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_humanuser_create"},"title":"Human User","allOf":[{"$ref":"#/definitions/Abstract.HumanUser.Update"},{"type":"object","properties":{"primaryAccount":{"type":"integer","format":"int64","description":"The primary account that the user belongs to.","title":"Primary Account"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_humanuser_create"},"title":"Human User","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"HumanUser.Update":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_humanuser_update"},"title":"Human User","allOf":[{"$ref":"#/definitions/Abstract.HumanUser.Update"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_humanuser_update"},"title":"Human User","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"},"Label":{"type":"object","properties":{"content":{"type":"object","description":"The label's actual content.","title":"Content","readOnly":true},"contentAsString":{"type":"string","description":"The label's content formatted as string.","title":"Content As String","readOnly":true},"descriptor":{"description":"The descriptor that describes what information the label provides.","title":"Descriptor","readOnly":true,"$ref":"#/definitions/LabelDescriptor"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_label"},"title":"Label","description":"","x-model-behavior":"READ"},"LabelDescriptor":{"type":"object","properties":{"category":{"description":"The label's category.","title":"Category","readOnly":true,"$ref":"#/definitions/LabelDescriptorCategory"},"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"features":{"type":"array","description":"The features that this label belongs to.","title":"Features","readOnly":true,"items":{"type":"integer","format":"int64"}},"group":{"type":"integer","format":"int64","description":"The group that this label belongs to.","title":"Group","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}},"type":{"type":"integer","format":"int64","description":"The type of the label's value.","title":"Type","readOnly":true},"weight":{"type":"integer","format":"int32","description":"When listing labels, they can be sorted by this number.","title":"Weight","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_labeldescriptor"},"title":"Label Descriptor","description":"","x-model-behavior":"READ"},"LabelDescriptorCategory":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_labeldescriptorcategory"},"title":"Label Descriptor Category","description":"","enum":["HUMAN","APPLICATION"],"x-model-behavior":"ENUM"},"LabelDescriptorGroup":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}},"weight":{"type":"integer","format":"int32","description":"When listing label groups, they can be sorted by this number.","title":"Weight","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_labeldescriptorgroup"},"title":"Label Descriptor Group","description":"","x-model-behavior":"READ"},"LabelDescriptorType":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_labeldescriptortype"},"title":"Label Descriptor Type","description":"","x-model-behavior":"READ"},"LegalOrganizationForm":{"type":"object","properties":{"country":{"type":"string","description":"The two-letter code of the country the legal organization form is used in (ISO 3166-1 alpha-2 format).","title":"Country","readOnly":true},"description":{"type":"array","description":"The localized descriptions of the legal organization form.","title":"Description","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/LocalizedString"}},"englishDescription":{"type":"string","description":"The English name of the legal organization form.","title":"English Description","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"shortcut":{"type":"array","description":"The localized shortcuts of the legal organization form.","title":"Shortcut","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/LocalizedString"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_legalorganizationform"},"title":"Legal Organization Form","description":"","x-model-behavior":"READ"},"LineItem":{"type":"object","properties":{"aggregatedTaxRate":{"type":"number","description":"The total tax rate applied to the item, calculated from the rates of all tax lines.","title":"Aggregated Tax Rate","readOnly":true},"amountExcludingTax":{"type":"number","description":"The line item price with discounts applied, excluding taxes.","title":"Amount Excluding Tax","readOnly":true},"amountIncludingTax":{"type":"number","description":"The line item price with discounts applied, including taxes.","title":"Amount Including Tax","readOnly":true},"attributes":{"type":"object","description":"A map of custom information for the item.","title":"Attributes","readOnly":true,"additionalProperties":{"$ref":"#/definitions/LineItemAttribute"}},"discountExcludingTax":{"type":"number","description":"The discount allocated to the item, excluding taxes.","title":"Discount Excluding Tax","readOnly":true},"discountIncludingTax":{"type":"number","description":"The discount allocated to the item, including taxes.","title":"Discount Including Tax","readOnly":true},"name":{"type":"string","description":"The name of the product, ideally in the customer's language.","title":"Name","readOnly":true,"minLength":1,"maxLength":150},"quantity":{"type":"number","description":"The number of items that were purchased.","title":"Quantity","readOnly":true},"shippingRequired":{"type":"boolean","description":"Whether the item required shipping.","title":"Shipping Required","readOnly":true},"sku":{"type":"string","description":"The SKU (stock-keeping unit) of the product.","title":"SKU","readOnly":true,"maxLength":200},"taxAmount":{"type":"number","description":"The sum of all taxes applied to the item.","title":"Tax Amount","readOnly":true},"taxAmountPerUnit":{"type":"number","description":"The calculated tax amount per unit.","title":"Tax Amount Per Unit","readOnly":true},"taxes":{"type":"array","description":"A set of tax lines, each of which specifies a tax applied to the item.","title":"Taxes","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/Tax"}},"type":{"description":"The type of the line item.","title":"Type","readOnly":true,"$ref":"#/definitions/LineItemType"},"undiscountedAmountExcludingTax":{"type":"number","description":"The line item price with discounts not applied, excluding taxes.","title":"Undiscounted Amount Excluding Tax","readOnly":true},"undiscountedAmountIncludingTax":{"type":"number","description":"The line item price with discounts not applied, including taxes.","title":"Undiscounted Amount Including Tax","readOnly":true},"undiscountedUnitPriceExcludingTax":{"type":"number","description":"The calculated price per unit with discounts not applied, excluding taxes.","title":"Undiscounted Unit Price Excluding Tax","readOnly":true},"undiscountedUnitPriceIncludingTax":{"type":"number","description":"The calculated price per unit with discounts not applied, including taxes.","title":"Undiscounted Unit Price Including Tax","readOnly":true},"uniqueId":{"type":"string","description":"The unique identifier of the line item within the set of line items.","title":"Unique ID","readOnly":true,"maxLength":200},"unitPriceExcludingTax":{"type":"number","description":"The calculated price per unit with discounts applied, excluding taxes.","title":"Unit Price Excluding Tax","readOnly":true},"unitPriceIncludingTax":{"type":"number","description":"The calculated price per unit with discounts applied, including taxes.","title":"Unit Price Including Tax","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_lineitem"},"title":"Line Item","description":"","x-model-behavior":"READ"},"LineItem.Create":{"type":"object","required":["amountIncludingTax","name","quantity","type","uniqueId"],"properties":{"amountIncludingTax":{"type":"number","description":"The line item price with discounts applied, including taxes.","title":"Amount Including Tax"},"attributes":{"type":"object","description":"A map of custom information for the item.","title":"Attributes","additionalProperties":{"$ref":"#/definitions/LineItemAttribute.Create"}},"discountIncludingTax":{"type":"number","description":"The discount allocated to the item, including taxes.","title":"Discount Including Tax"},"name":{"type":"string","description":"The name of the product, ideally in the customer's language.","title":"Name","minLength":1,"maxLength":150},"quantity":{"type":"number","description":"The number of items that were purchased.","title":"Quantity"},"shippingRequired":{"type":"boolean","description":"Whether the item required shipping.","title":"Shipping Required"},"sku":{"type":"string","description":"The SKU (stock-keeping unit) of the product.","title":"SKU","maxLength":200},"taxes":{"type":"array","description":"A set of tax lines, each of which specifies a tax applied to the item.","title":"Taxes","uniqueItems":true,"items":{"$ref":"#/definitions/Tax.Create"}},"type":{"description":"The type of the line item.","title":"Type","$ref":"#/definitions/LineItemType"},"uniqueId":{"type":"string","description":"The unique identifier of the line item within the set of line items.","title":"Unique ID","maxLength":200}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_lineitem_create"},"title":"Line Item","description":"","x-model-behavior":"CREATE"},"LineItemAttribute":{"type":"object","properties":{"label":{"type":"string","description":"The label describing the line item attribute.","title":"Label","readOnly":true,"maxLength":512},"value":{"type":"string","description":"The value of the line item attribute.","title":"Value","readOnly":true,"maxLength":512}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_lineitemattribute"},"title":"Line Item Attribute","description":"","x-model-behavior":"READ"},"LineItemAttribute.Create":{"type":"object","required":["label","value"],"properties":{"label":{"type":"string","description":"The label describing the line item attribute.","title":"Label","maxLength":512},"value":{"type":"string","description":"The value of the line item attribute.","title":"Value","maxLength":512}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_lineitemattribute_create"},"title":"Line Item Attribute . Create","description":"","x-model-behavior":"CREATE"},"LineItemReduction":{"type":"object","properties":{"lineItemUniqueId":{"type":"string","description":"The unique identifier of the line item to which the reduction is applied. This ID ensures the reduction is accurately associated with the correct item.","title":"Unique ID","readOnly":true,"maxLength":200},"quantityReduction":{"type":"number","description":"The quantity removed or reduced from the line item. This value reflects the decrease in the item count due to the reduction.","title":"Quantity Reduction","readOnly":true},"unitPriceReduction":{"type":"number","description":"The monetary amount by which the line item's unit price is discounted. This reduction adjusts the price without altering the quantity.","title":"Unit Price Reduction","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_lineitemreduction"},"title":"Line Item Reduction","description":"","x-model-behavior":"READ"},"LineItemReduction.Create":{"type":"object","required":["lineItemUniqueId","quantityReduction","unitPriceReduction"],"properties":{"lineItemUniqueId":{"type":"string","description":"The unique identifier of the line item to which the reduction is applied. This ID ensures the reduction is accurately associated with the correct item.","title":"Unique ID","maxLength":200},"quantityReduction":{"type":"number","description":"The quantity removed or reduced from the line item. This value reflects the decrease in the item count due to the reduction.","title":"Quantity Reduction"},"unitPriceReduction":{"type":"number","description":"The monetary amount by which the line item's unit price is discounted. This reduction adjusts the price without altering the quantity.","title":"Unit Price Reduction"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_lineitemreduction_create"},"title":"Line Item Reduction . Create","description":"","x-model-behavior":"CREATE"},"LineItemType":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_lineitemtype"},"title":"Line Item Type","description":"","enum":["SHIPPING","DISCOUNT","FEE","PRODUCT","TIP"],"x-model-behavior":"ENUM"},"LocalizedString":{"type":"object","properties":{"language":{"type":"string","description":"The term's language.","title":"Language","readOnly":true},"string":{"type":"string","description":"The localized term.","title":"String","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_localizedstring"},"title":"Localized String","description":"","x-model-behavior":"READ"},"ManualTask":{"type":"object","properties":{"actions":{"type":"array","description":"The actions that can be triggered to handle the manual task.","title":"Actions","readOnly":true,"items":{"type":"integer","format":"int64"}},"contextEntityId":{"type":"integer","format":"int64","description":"The ID of the entity the manual task is linked to.","title":"Context Entity ID","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"expiresOn":{"type":"string","format":"date-time","description":"The date and time until when the manual task has to be handled.","title":"Expires On","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/ManualTaskState"},"type":{"type":"integer","format":"int64","description":"The manual task's type.","title":"Type","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_manualtask"},"title":"Manual Task","description":"A manual task requires the manual intervention of a human.","x-model-behavior":"READ"},"ManualTaskAction":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"label":{"type":"object","description":"The action's label.","title":"Label","readOnly":true,"additionalProperties":{"type":"string"}},"style":{"description":"The action's style.","title":"Style","readOnly":true,"$ref":"#/definitions/ManualTaskActionStyle"},"taskType":{"type":"integer","format":"int64","description":"The type of manual tasks this action belongs to.","title":"Task Type","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_manualtaskaction"},"title":"Manual Task Action","description":"","x-model-behavior":"READ"},"ManualTaskActionStyle":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_manualtaskactionstyle"},"title":"Manual Task Action Style","description":"","enum":["DEFAULT","PRIMARY","DANGER"],"x-model-behavior":"ENUM"},"ManualTaskState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_manualtaskstate"},"title":"Manual Task State","description":"","enum":["OPEN","DONE","EXPIRED"],"x-model-behavior":"ENUM"},"ManualTaskType":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"features":{"type":"array","description":"The features that this type belongs to.","title":"Features","readOnly":true,"items":{"type":"integer","format":"int64"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_manualtasktype"},"title":"Manual Task Type","description":"The manual task type indicates what kind of manual task is required to be executed by the human.","x-model-behavior":"READ"},"OneClickPaymentMode":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_oneclickpaymentmode"},"title":"One Click Payment Mode","description":"","enum":["DISABLED","ALLOW","FORCE"],"x-model-behavior":"ENUM"},"PanType":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_pantype"},"title":"Pan Type","description":"","enum":["PLAIN","PLAIN_GOOGLE_PAY","SCHEME_TOKEN","SCHEME_TOKEN_CLICK_TO_PAY","DEVICE_TOKEN_APPLE_PAY","DEVICE_TOKEN_GOOGLE_PAY","DEVICE_TOKEN_SAMSUNG_PAY","DEVICE_TOKEN_ANDROID_PAY"],"x-model-behavior":"ENUM"},"PaymentAppChargeAttemptTargetState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappchargeattempttargetstate"},"title":"Charge Attempt Target State","description":"The target state indicates the state that should be set on the charge attempt.","enum":["SUCCESSFUL","FAILED"],"x-model-behavior":"ENUM"},"PaymentAppChargeAttemptUpdateRequest":{"type":"object","properties":{"chargeAttemptId":{"type":"integer","format":"int64","description":"This is the ID of the charge attempt that should be updated.","title":"Charge Attempt ID"},"endUserFailureMessage":{"type":"string","description":"The end user failure message indicates to the end user (buyer) why the payment failed. The message has to be in the language of the end user. The language is provided within the payment page invocation URL.","title":"End User Failure Message","maxLength":2000},"failureReasonId":{"type":"integer","format":"int64","description":"The failure reason indicates why the charge attempt failed. It is required when the target state is FAILED.","title":"Failure Reason ID"},"reference":{"type":"string","description":"The reference identifies the charge attempt within the systems of the external service provider. It is required when the target state is SUCCESSFUL.","title":"Reference","maxLength":100},"targetState":{"description":"The target state defines the state into which the charge attempt should be switched into. Once the charge attempt changed the state it will not be possible to change it again.","title":"Target State","$ref":"#/definitions/PaymentAppChargeAttemptTargetState"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappchargeattemptupdaterequest"},"title":"Charge Attempt Update Request","description":"The charge attempt update request allows to change the state of a charge attempt. The charge attempt must be linked with a processor that was created by the payment Web App that invokes the operation.","x-model-behavior":"UPDATE"},"PaymentAppCompletionConfiguration":{"type":"object","properties":{"completionEndpoint":{"type":"string","description":"The URL that the payment service provider will invoke to process a completion request.\nThis endpoint handles communication with the provider for initiating and managing completions.","title":"Completion Endpoint","readOnly":true},"completionTimeoutInMinutes":{"type":"integer","format":"int32","description":"The maximum time (in minutes) to wait for a response from the payment service provider\nafter a completion request is triggered. If no feedback or final status is received\nwithin this period, the completion is considered failed.","title":"Completion Timeout (in minutes)","readOnly":true},"maximalCompletionDelayInDays":{"type":"integer","format":"int32","description":"The maximum number of days after a transaction's authorization during which a\ncompletion or void action can be triggered. Once this period has passed, neither\naction can be executed.","title":"Maximum Completion Delay (in days)","readOnly":true},"multipleCompletionsSupported":{"type":"boolean","description":"Whether the payment connector can process multiple completions for a single transaction.","title":"Multiple Completions Supported","readOnly":true},"voidEndpoint":{"type":"string","description":"The URL that the payment service provider will invoke to process a void request.\nThis endpoint handles communication with the provider for initiating and managing voids.","title":"Void Endpoint","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappcompletionconfiguration"},"title":"Completion Configuration","description":"","x-model-behavior":"READ"},"PaymentAppCompletionConfiguration.Create":{"type":"object","properties":{"completionEndpoint":{"type":"string","description":"The URL that the payment service provider will invoke to process a completion request.\nThis endpoint handles communication with the provider for initiating and managing completions.","title":"Completion Endpoint"},"completionTimeoutInMinutes":{"type":"integer","format":"int32","description":"The maximum time (in minutes) to wait for a response from the payment service provider\nafter a completion request is triggered. If no feedback or final status is received\nwithin this period, the completion is considered failed.","title":"Completion Timeout (in minutes)"},"maximalCompletionDelayInDays":{"type":"integer","format":"int32","description":"The maximum number of days after a transaction's authorization during which a\ncompletion or void action can be triggered. Once this period has passed, neither\naction can be executed.","title":"Maximum Completion Delay (in days)"},"multipleCompletionsSupported":{"type":"boolean","description":"Whether the payment connector can process multiple completions for a single transaction.","title":"Multiple Completions Supported"},"voidEndpoint":{"type":"string","description":"The URL that the payment service provider will invoke to process a void request.\nThis endpoint handles communication with the provider for initiating and managing voids.","title":"Void Endpoint"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappcompletionconfiguration_create"},"title":"Completion Configuration","description":"","x-model-behavior":"UPDATE"},"PaymentAppCompletionTargetState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappcompletiontargetstate"},"title":"Completion Target State","description":"The target state indicates the state that should be set on the completion.","enum":["SUCCESSFUL","FAILED"],"x-model-behavior":"ENUM"},"PaymentAppCompletionUpdateRequest":{"type":"object","properties":{"completionId":{"type":"integer","format":"int64","description":"This is the ID of the completion that should be updated.","title":"Completion ID"},"failureReasonId":{"type":"integer","format":"int64","description":"The failure reason indicates why the completion failed. It is required when the target state is FAILED.","title":"Failure Reason ID"},"reference":{"type":"string","description":"The reference identifies the completion within the systems of the external service provider. It is required when the target state is SUCCESSFUL.","title":"Reference","maxLength":100},"targetState":{"description":"The target state defines the state into which the completion should be switched into. Once the completion changed the state it will not be possible to change it again.","title":"Target State","$ref":"#/definitions/PaymentAppCompletionTargetState"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappcompletionupdaterequest"},"title":"Completion Update Request","description":"The completion update request allows to change the state of a completion. The completion must be linked with a processor that was created by the payment Web App that invokes the operation.","x-model-behavior":"UPDATE"},"PaymentAppConnector":{"type":"object","properties":{"authorizationTimeout":{"type":"string","description":"The duration within which the authorization process for a payment should complete.","title":"Authorization Timeout","readOnly":true},"completionConfiguration":{"description":"The completion configuration controlling how deferred completion is processed. If not present, deferred completion is not supported for this connector.","title":"Completion Configuration","readOnly":true,"$ref":"#/definitions/PaymentAppCompletionConfiguration"},"connectorConfiguration":{"description":"The connector configuration created alongside the connector within its designated space. This configuration is used in transactions created using this connector.","title":"Connector Configuration","readOnly":true,"$ref":"#/definitions/PaymentConnectorConfiguration"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the connector was created.","title":"Created On","readOnly":true},"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID","readOnly":true,"maxLength":40},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the connector.","title":"Name","readOnly":true,"maxLength":100},"paymentPageEndpoint":{"type":"string","description":"The URL where the user is redirected to process a payment. This endpoint is provided by the external service provider.","title":"Payment Page Endpoint","readOnly":true},"processor":{"description":"The payment app processor that the connector belongs to. This relationship is defined when the connector is created.","title":"Processor","readOnly":true,"$ref":"#/definitions/PaymentAppProcessor"},"refundConfiguration":{"description":"The refund configuration controlling the behavior for processing refunds. If not present, refunds are not supported for this connector.","title":"Refund Configuration","readOnly":true,"$ref":"#/definitions/PaymentAppRefundConfiguration"},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/PaymentAppConnectorState"},"updatedOn":{"type":"string","format":"date-time","description":"The date and time when the connector was last updated.","title":"Updated On","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappconnector"},"title":"Connector","description":"","x-model-behavior":"READ"},"PaymentAppConnectorCreationRequest":{"type":"object","required":["authorizationTimeoutInMinutes","connector","externalId","name","paymentPageEndpoint","processorExternalId"],"properties":{"authorizationTimeoutInMinutes":{"type":"integer","format":"int32","description":"When the transaction is not authorized within this timeout the transaction is considered as failed.","title":"Authorization Timeout (in minutes)"},"completionConfiguration":{"description":"The completion configuration allows the connector to support deferred completions on a transaction. If it is not provided the connector will not process transactions in deferred mode.","title":"Completion Configuration","$ref":"#/definitions/PaymentAppCompletionConfiguration.Create"},"connector":{"type":"integer","format":"int64","description":"The ID of the connector identifies which connector that should be linked with this web app connector. The connector defines the payment method.","title":"Connector ID"},"externalId":{"type":"string","description":"The external ID identifies the connector within the external system. It has to be unique per processor external ID and for any subsequent update the same ID must be sent.","title":"External ID","minLength":1,"maxLength":40},"name":{"type":"string","description":"The name of the connector will be displayed within the user interfaces that the merchant is interacting with.","title":"Name","maxLength":100},"paymentPageEndpoint":{"type":"string","description":"The payment page endpoint URL will be invoked by the buyer to carry out the authorization of the payment.","title":"Payment Page Endpoint"},"processorExternalId":{"type":"string","description":"The external ID of the processor identifies the processor to which this connector belongs to. The processor cannot be changed once it has been set on a connector.","title":"Processor External ID","minLength":1,"maxLength":40},"refundConfiguration":{"description":"The refund configuration allows the connector to support refunds on transactions. In case no refund configuration is provided the connector will not support refunds.","title":"Refund Configuration","$ref":"#/definitions/PaymentAppRefundConfiguration.Create"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappconnectorcreationrequest"},"title":"Connector Creation Request","description":"","x-model-behavior":"CREATE"},"PaymentAppConnectorState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappconnectorstate"},"title":"Connector State","description":"","enum":["ACTIVE","DELETED"],"x-model-behavior":"ENUM"},"PaymentAppProcessor":{"type":"object","properties":{"configuredEnvironment":{"description":"The environment (e.g., test or production) currently configured for the processor.","title":"Configured Environment","readOnly":true,"$ref":"#/definitions/ChargeAttemptEnvironment"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the processor was created.","title":"Created On","readOnly":true},"documentationUrl":{"type":"string","description":"A URL pointing to the documentation that explains how to configure and use the processor.","title":"Documentation URL","readOnly":true},"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID","readOnly":true,"maxLength":40},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"installationId":{"type":"integer","format":"int64","description":"The installation ID identifies the Web App installation.","title":"Installation ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the processor.","title":"Name","readOnly":true,"maxLength":100},"processorConfiguration":{"description":"The processor configuration created alongside the process within its designated space. This configuration is used in transactions created using this processor.","title":"Processor Configuration","readOnly":true,"$ref":"#/definitions/PaymentProcessorConfiguration"},"productionModeUrl":{"type":"string","description":"A URL pointing to the site where merchants can set up production mode for the processor.","title":"Configure Production Mode URL","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/PaymentAppProcessorState"},"svgIcon":{"type":"string","description":"An SVG icon representing the processor, displayed to the user in the interface.","title":"SVG Icon","readOnly":true,"maxLength":10000},"updatedOn":{"type":"string","format":"date-time","description":"The date and time when the processor was last updated.","title":"Updated On","readOnly":true},"usableInProduction":{"type":"boolean","description":"Whether the processor is fully prepared and available for handling transactions in a production environment.","title":"Usable In Production","readOnly":true},"usableInProductionSince":{"type":"string","format":"date-time","description":"the date and time when the processor became fully usable and available for handling transactions in a production environment.","title":"Usable In Production Since","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappprocessor"},"title":"Processor","description":"","x-model-behavior":"READ"},"PaymentAppProcessorCreationRequest":{"type":"object","required":["documentationUrl","externalId","name","svgIcon"],"properties":{"documentationUrl":{"type":"string","description":"The documentation URL has to point to a description of how to configure and use the processor.","title":"Documentation URL"},"externalId":{"type":"string","description":"The external ID identifies the processor within the external system. It has to be unique per space and for any subsequent update the same ID must be sent.","title":"External ID","minLength":1,"maxLength":40},"name":{"type":"string","description":"The name of the processor will be displayed within the user interfaces that the merchant is interacting with.","title":"Name","maxLength":100},"productionModeUrl":{"type":"string","description":"The production mode URL has to point to a site on which the merchant can set up the production mode for the processor.","title":"Production Mode URL"},"svgIcon":{"type":"string","description":"The SVG icon will be displayed to the user to represent this processor.","title":"SVG Icon","maxLength":10000}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappprocessorcreationrequest"},"title":"Processor Creation Request","description":"","x-model-behavior":"CREATE"},"PaymentAppProcessorState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappprocessorstate"},"title":"Processor State","description":"","enum":["ACTIVE","DELETED"],"x-model-behavior":"ENUM"},"PaymentAppRefundConfiguration":{"type":"object","properties":{"multipleRefundsSupported":{"type":"boolean","description":"Whether the payment connector can process multiple refunds for a single transaction.","title":"Multiple Refunds Supported","readOnly":true},"refundEndpoint":{"type":"string","description":"The URL that the payment service provider will invoke to process a refund request. This endpoint handles communication with the provider for initiating and managing refunds.","title":"Refund Endpoint","readOnly":true},"refundTimeoutInMinutes":{"type":"integer","format":"int32","description":"The maximum time (in minutes) to wait for a response from the payment service provider after a refund request is triggered. If no feedback or final status is received within this period, the refund is considered failed.","title":"Refund Timeout (in minutes)","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentapprefundconfiguration"},"title":"Refund Configuration","description":"","x-model-behavior":"READ"},"PaymentAppRefundConfiguration.Create":{"type":"object","properties":{"multipleRefundsSupported":{"type":"boolean","description":"Whether the payment connector can process multiple refunds for a single transaction.","title":"Multiple Refunds Supported"},"refundEndpoint":{"type":"string","description":"The URL that the payment service provider will invoke to process a refund request. This endpoint handles communication with the provider for initiating and managing refunds.","title":"Refund Endpoint"},"refundTimeoutInMinutes":{"type":"integer","format":"int32","description":"The maximum time (in minutes) to wait for a response from the payment service provider after a refund request is triggered. If no feedback or final status is received within this period, the refund is considered failed.","title":"Refund Timeout (in minutes)"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentapprefundconfiguration_create"},"title":"Refund Configuration","description":"","x-model-behavior":"UPDATE"},"PaymentAppRefundTargetState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentapprefundtargetstate"},"title":"Refund Target State","description":"The target state indicates the state that should be set on the refund.","enum":["SUCCESSFUL","FAILED"],"x-model-behavior":"ENUM"},"PaymentAppRefundUpdateRequest":{"type":"object","properties":{"failureReasonId":{"type":"integer","format":"int64","description":"The failure reason indicates why the refund failed. It is required when the target state is FAILED.","title":"Failure Reason ID"},"reference":{"type":"string","description":"The reference identifies the refund within the systems of the external service provider. It is required when the target state is SUCCESSFUL.","title":"Reference","maxLength":100},"refundId":{"type":"integer","format":"int64","description":"This is the ID of the refund that should be updated.","title":"Refund ID"},"targetState":{"description":"The target state defines the state into which the refund should be switched into. Once the refund changed the state it will not be possible to change it again.","title":"Target State","$ref":"#/definitions/PaymentAppRefundTargetState"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentapprefundupdaterequest"},"title":"Refund Update Request","description":"The refund update request allows to change the state of a refund. The refund must be linked with a processor that was created by the payment Web App that invokes the operation.","x-model-behavior":"UPDATE"},"PaymentAppVoidTargetState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappvoidtargetstate"},"title":"Void Target State","description":"The target state indicates the state that should be set on the void.","enum":["SUCCESSFUL","FAILED"],"x-model-behavior":"ENUM"},"PaymentAppVoidUpdateRequest":{"type":"object","properties":{"failureReasonId":{"type":"integer","format":"int64","description":"The failure reason indicates why the void failed. It is required when the target state is FAILED.","title":"Failure Reason ID"},"reference":{"type":"string","description":"The reference identifies the void within the systems of the external service provider. It is required when the target state is SUCCESSFUL.","title":"Reference","maxLength":100},"targetState":{"description":"The target state defines the state into which the void should be switched into. Once the void changed the state it will not be possible to change it again.","title":"Target State","$ref":"#/definitions/PaymentAppVoidTargetState"},"voidId":{"type":"integer","format":"int64","description":"This is the ID of the void that should be updated.","title":"Void ID"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentappvoidupdaterequest"},"title":"Void Update Request","description":"The void update request allows to change the state of a void. The void must be linked with a processor that was created by the payment Web App that invokes the operation.","x-model-behavior":"UPDATE"},"PaymentConnector":{"type":"object","properties":{"dataCollectionType":{"description":"The data collection type specifies how the payment information is collected.","title":"Data Collection Type","readOnly":true,"$ref":"#/definitions/DataCollectionType"},"deprecated":{"type":"boolean","description":"Whether the object was deprecated.","title":"Deprecated","readOnly":true},"deprecationReason":{"type":"object","description":"The deprecation reason describes why the object was deprecated.","title":"Deprecation Reason","readOnly":true,"additionalProperties":{"type":"string"}},"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}},"paymentMethod":{"type":"integer","format":"int64","description":"The payment method that the connector supports.","title":"Payment Method","readOnly":true},"paymentMethodBrand":{"description":"The specific brand that this payment connector supports.","title":"Payment Method Brand","readOnly":true,"$ref":"#/definitions/PaymentMethodBrand"},"primaryRiskTaker":{"description":"The entity that bears the main risk in the event that a contracting party fails to meet its obligations.","title":"Primary Risk Taker","readOnly":true,"$ref":"#/definitions/PaymentPrimaryRiskTaker"},"processor":{"type":"integer","format":"int64","description":"The processor that the connector belongs to.","title":"Processor","readOnly":true},"supportedCurrencies":{"type":"array","description":"The currencies that are supported by the connector.","title":"Supported Currencies","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"supportedCustomersPresences":{"type":"array","description":"The types of customer's presence that are supported by the connector.","title":"Supported Customers Presences","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/CustomersPresence"}},"supportedFeatures":{"type":"array","description":"The features that are supported by the connector.","title":"Supported Features","readOnly":true,"items":{"type":"integer","format":"int64"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentconnector"},"title":"Payment Connector","description":"","x-model-behavior":"READ"},"PaymentConnectorConfiguration":{"type":"object","properties":{"applicableForTransactionProcessing":{"type":"boolean","description":"Whether this connector configuration is enabled for processing payments, taking into account the state of the processor and payment method configurations.","title":"Applicable For Transaction Processing","readOnly":true},"conditions":{"type":"array","description":"Conditions allow to define criteria that a transaction must fulfill in order for the connector configuration to be considered for processing the payment.","title":"Conditions","readOnly":true,"items":{"type":"integer","format":"int64"}},"connector":{"type":"integer","format":"int64","description":"The connector that the configuration is for.","title":"Connector","readOnly":true},"enabledSalesChannels":{"type":"array","description":"The sales channels for which the connector configuration is enabled. If empty, it is enabled for all sales channels.","title":"Enabled Sales Channels","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/SalesChannel"}},"enabledSpaceViews":{"type":"array","description":"The space views for which the connector configuration is enabled. If empty, it is enabled for all space views.","title":"Enabled Space Views","readOnly":true,"uniqueItems":true,"items":{"type":"integer","format":"int64"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"imagePath":{"type":"string","description":"The URL to the connector's image.","title":"Image Path","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the connector configuration.","title":"Name","readOnly":true,"maxLength":100},"paymentMethodConfiguration":{"description":"The payment method configuration that the connector configuration belongs to.","title":"Payment Method Configuration","readOnly":true,"$ref":"#/definitions/PaymentMethodConfiguration"},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"priority":{"type":"integer","format":"int32","description":"The priority that determines the order in which connector configurations are taken into account when processing a payment. Low values are considered first.","title":"Priority","readOnly":true},"processorConfiguration":{"description":"The processor configuration that the connector configuration belongs to.","title":"Processor Configuration","readOnly":true,"$ref":"#/definitions/PaymentProcessorConfiguration"},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentconnectorconfiguration"},"title":"Payment Connector Configuration","description":"","x-model-behavior":"READ"},"PaymentConnectorFeature":{"type":"object","properties":{"displayName":{"type":"string","description":"The localized name of the feature.","title":"Display Name","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentconnectorfeature"},"title":"Payment Connector Feature","description":"","x-model-behavior":"READ"},"PaymentContract":{"type":"object","properties":{"account":{"type":"integer","format":"int64","description":"This account that the contract belongs to.","title":"Account","readOnly":true},"activatedOn":{"type":"string","format":"date-time","description":"The date and time when the contract was activated.","title":"Activated On","readOnly":true},"contractIdentifier":{"type":"string","description":"The identifier of the contract.","title":"Contract Identifier","readOnly":true},"contractType":{"description":"The type of the contract.","title":"Contract Type","readOnly":true,"$ref":"#/definitions/PaymentContractType"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the contract was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"rejectedOn":{"type":"string","format":"date-time","description":"The date and time when the contract was rejected.","title":"Rejected On","readOnly":true},"rejectionReason":{"description":"The reason for rejecting the contract.","title":"Rejection Reason","readOnly":true,"$ref":"#/definitions/FailureReason"},"startTerminatingOn":{"type":"string","format":"date-time","description":"The date and time when the termination process of the contract was started.","title":"Start Terminating On","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/PaymentContractState"},"terminatedBy":{"type":"integer","format":"int64","description":"The ID of the user the contract was terminated by.","title":"Terminated By","readOnly":true},"terminatedOn":{"type":"string","format":"date-time","description":"The date and time when the contract was terminated.","title":"Terminated On","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentcontract"},"title":"Contract","description":"","x-model-behavior":"READ"},"PaymentContractState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentcontractstate"},"title":"Payment Contract State","description":"","enum":["PENDING","ACTIVE","TERMINATING","TERMINATED","REJECTED"],"x-model-behavior":"ENUM"},"PaymentContractType":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentcontracttype"},"title":"Contract Type","description":"","x-model-behavior":"READ"},"PaymentInformationHash":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"type":{"description":"The type specifies the algorithm used for calculating the hash.","title":"Type","readOnly":true,"$ref":"#/definitions/PaymentInformationHashType"},"value":{"type":"string","description":"The hash value generated based on the specified type.","title":"Value","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentinformationhash"},"title":"Payment Information Hash","description":"A payment information hash is generated from user input, ensuring consistent and collision-free results for identical inputs.","x-model-behavior":"READ"},"PaymentInformationHashType":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The name that describes the hash type.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentinformationhashtype"},"title":"Payment Information Hash Type","description":"","x-model-behavior":"READ"},"PaymentMethod":{"type":"object","properties":{"dataCollectionTypes":{"type":"array","description":"The data collection types that payment method supports.","title":"Data Collection Types","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/DataCollectionType"}},"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"imagePath":{"type":"string","description":"The path to the payment method's image.","title":"Image Path","readOnly":true},"merchantDescription":{"type":"object","description":"A merchant-focused, localized description of the payment method, providing its purpose and details.","title":"Merchant Description","readOnly":true,"additionalProperties":{"type":"string"}},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}},"supportedCurrencies":{"type":"array","description":"The currencies that the payment method supports.","title":"Supported Currencies","readOnly":true,"uniqueItems":true,"items":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentmethod"},"title":"Payment Method","description":"","x-model-behavior":"READ"},"PaymentMethodBrand":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"grayImagePath":{"type":"string","description":"The path to the payment method brand's grayscale image.","title":"Gray Image Path","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"imagePath":{"type":"string","description":"The path to the payment method brand's image.","title":"Image Path","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}},"paymentMethod":{"type":"integer","format":"int64","description":"The payment method that the brand belongs to.","title":"Payment Method","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentmethodbrand"},"title":"Payment Method Brand","description":"","x-model-behavior":"READ"},"PaymentMethodConfiguration":{"type":"object","properties":{"dataCollectionType":{"description":"The data collection type specifies how the payment information is collected.","title":"Data Collection Type","readOnly":true,"$ref":"#/definitions/DataCollectionType"},"description":{"type":"object","description":"A customer-facing custom description for the payment method.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"imageResourcePath":{"description":"The resource path to a custom image for the payment method, displayed to the customer for visual identification.","title":"Image Resource Path","readOnly":true,"$ref":"#/definitions/ResourcePath"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the payment method configuration.","title":"Name","readOnly":true,"maxLength":100},"oneClickPaymentMode":{"description":"The one-click payment mode determines whether the customer can save their payment details for later payments.","title":"One-Click Payment Mode","readOnly":true,"$ref":"#/definitions/OneClickPaymentMode"},"paymentMethod":{"type":"integer","format":"int64","description":"The payment method that the configuration is for.","title":"Payment Method","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"resolvedDescription":{"type":"object","description":"The description of the payment method displayed to the customer. If a custom description is defined, it will be used; otherwise, the default description of the payment method will be shown.","title":"Resolved Description","readOnly":true,"additionalProperties":{"type":"string"}},"resolvedImageUrl":{"type":"string","description":"The URL to the image of the payment method displayed to the customer. If a custom image is defined, it will be used; otherwise, the default image of the payment method will be shown.","title":"Resolved Image URL","readOnly":true},"resolvedTitle":{"type":"object","description":"The title of the payment method displayed to the customer. If a custom title is defined, it will be used; otherwise, the default title of the payment method will be shown.","title":"Resolved Title","readOnly":true,"additionalProperties":{"type":"string"}},"sortOrder":{"type":"integer","format":"int32","description":"When listing payment methods, they can be sorted by this number.","title":"Sort Order","readOnly":true},"spaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Space ID","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"title":{"type":"object","description":"A customer-facing custom title for the payment method.","title":"Title","readOnly":true,"additionalProperties":{"type":"string"}},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentmethodconfiguration"},"title":"Payment Method Configuration","description":"","x-model-behavior":"READ"},"PaymentPrimaryRiskTaker":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentprimaryrisktaker"},"title":"Primary Risk Taker","description":"The primary risk taker will have the main loss when one party of the contract does not fulfill the contractual duties.","enum":["CUSTOMER","MERCHANT","THIRD_PARTY"],"x-model-behavior":"ENUM"},"PaymentProcessor":{"type":"object","properties":{"companyName":{"type":"object","description":"The name of the company to which the processor belongs.","title":"Company Name","readOnly":true,"additionalProperties":{"type":"string"}},"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"headquartersLocation":{"type":"object","description":"Where the processor's headquarters are located.","title":"Headquarters Location","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"logoPath":{"type":"string","description":"The path to the logo image of the processor.","title":"Logo Path","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}},"productName":{"type":"object","description":"The name of the processor's product.","title":"Product Name","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentprocessor"},"title":"Payment Processor","description":"Payment processors serve as intermediaries that establish connections with third-party\ncompanies, known as payment service providers. These providers are responsible for\nmanaging the technical aspects of payment transactions, ensuring seamless and secure\npayment processing.","x-model-behavior":"READ"},"PaymentProcessorConfiguration":{"type":"object","properties":{"applicationManaged":{"type":"boolean","description":"Whether the processor configuration is managed by the application and therefore cannot be changed.","title":"Application-Managed","readOnly":true},"contractId":{"type":"integer","format":"int64","description":"The ID of the payment contract the processor configuration is linked to.","title":"Payment Contract ID","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the payment method configuration.","title":"Name","readOnly":true,"maxLength":100},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"processor":{"type":"integer","format":"int64","description":"The payment processor that the configuration is for.","title":"Processor","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentprocessorconfiguration"},"title":"Payment Processor Configuration","description":"","x-model-behavior":"READ"},"PaymentTerminal":{"type":"object","properties":{"activatedOn":{"type":"string","format":"date-time","description":"","title":"Activated On","readOnly":true},"activationCode":{"type":"string","description":"","title":"Activation Code","readOnly":true},"configurationVersion":{"description":"The configuration that is assigned to the terminal and determines how it works.","title":"Configuration Version","readOnly":true,"$ref":"#/definitions/PaymentTerminalConfigurationVersion"},"deactivatedOn":{"type":"string","format":"date-time","description":"","title":"Deactivated On","readOnly":true},"decommissionedOn":{"type":"string","format":"date-time","description":"","title":"Decommissioned On","readOnly":true},"defaultCurrency":{"type":"string","description":"The default currency of the terminal.","title":"Default Currency","readOnly":true},"deviceName":{"type":"string","description":"The name of the device that is currently linked to the payment terminal.","title":"Device Name","readOnly":true},"deviceSerialNumber":{"type":"string","description":"The serial number of the device that is currently linked to the payment terminal.","title":"Device Serial Number","readOnly":true},"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"identifier":{"type":"string","description":"The unique identifier of the terminal, that is displayed on the device.","title":"Identifier","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"locationVersion":{"description":"The physical location where the terminal is used.","title":"Location Version","readOnly":true,"$ref":"#/definitions/PaymentTerminalLocationVersion"},"name":{"type":"string","description":"The name used to identify the payment terminal.","title":"Name","readOnly":true,"maxLength":100},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/PaymentTerminalState"},"type":{"description":"The type of the payment terminal.","title":"Type","readOnly":true,"$ref":"#/definitions/PaymentTerminalType"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentterminal"},"title":"Terminal","description":"","x-model-behavior":"READ"},"PaymentTerminalAddress":{"type":"object","properties":{"city":{"type":"string","description":"The city, town or village.","title":"City","readOnly":true},"country":{"type":"string","description":"The two-letter country code (ISO 3166 format).","title":"Country","readOnly":true},"dependentLocality":{"type":"string","description":"The dependent locality which is a sub-division of the state.","title":"Dependent Locality","readOnly":true,"maxLength":100},"emailAddress":{"type":"string","description":"The email address.","title":"Email Address","readOnly":true,"maxLength":80},"familyName":{"type":"string","description":"The family or last name.","title":"Family Name","readOnly":true},"givenName":{"type":"string","description":"The given or first name.","title":"Given Name","readOnly":true},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","title":"Mobile Phone Number","readOnly":true,"maxLength":100},"organizationName":{"type":"string","description":"The organization's name.","title":"Organization Name","readOnly":true},"phoneNumber":{"type":"string","description":"The phone number.","title":"Phone Number","readOnly":true,"maxLength":20},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","title":"State","readOnly":true},"postcode":{"type":"string","description":"The postal code, also known as ZIP, postcode, etc.","title":"Postcode","readOnly":true,"maxLength":12},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","title":"Salutation","readOnly":true,"maxLength":20},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","title":"Sorting Code","readOnly":true,"maxLength":100},"street":{"type":"string","description":"The street or PO Box.","title":"Street","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentterminaladdress"},"title":"Terminal Address","description":"","x-model-behavior":"READ"},"PaymentTerminalConfiguration":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the payment terminal configuration.","title":"Name","readOnly":true,"maxLength":100},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/PaymentTerminalConfigurationState"},"type":{"description":"The type of payment terminals that this configuration can be assigned to.","title":"Type","readOnly":true,"$ref":"#/definitions/PaymentTerminalType"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentterminalconfiguration"},"title":"Terminal Configuration","description":"","x-model-behavior":"READ"},"PaymentTerminalConfigurationState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentterminalconfigurationstate"},"title":"Payment Terminal Configuration State","description":"","enum":["CREATE","ACTIVE","DELETING","DELETED"],"x-model-behavior":"ENUM"},"PaymentTerminalConfigurationVersion":{"type":"object","properties":{"configuration":{"description":"The payment terminal configuration that the version belongs to.","title":"Configuration","readOnly":true,"$ref":"#/definitions/PaymentTerminalConfiguration"},"connectorConfigurations":{"type":"array","description":"The payment connector configurations that are available on the payment terminal.","title":"Connector Configurations","readOnly":true,"items":{"type":"integer","format":"int64"}},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the payment terminal configuration version was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"defaultCurrency":{"type":"string","description":"The default currency that is used if none is set on the payment terminal itself. If it is empty, the currency is derived from the location of the terminal.","title":"Default Currency","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"maintenanceWindowDuration":{"type":"string","description":"The permitted duration of the terminal's maintenance window.","title":"Maintenance Window Duration","readOnly":true},"maintenanceWindowStart":{"type":"string","description":"The start time of the terminal's maintenance window.","title":"Maintenance Window Start","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/PaymentTerminalConfigurationVersionState"},"timeZone":{"type":"string","description":"The time zone of the payment terminal used to determine the maintenance window.","title":"Time Zone","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true},"versionAppliedImmediately":{"type":"boolean","description":"Whether payment terminals are immediately updated to this configuration version. If not, it will be applied during the maintenance window.","title":"Version Applied Immediately","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentterminalconfigurationversion"},"title":"Terminal Configuration Version","description":"","x-model-behavior":"READ"},"PaymentTerminalConfigurationVersionState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentterminalconfigurationversionstate"},"title":"Payment Terminal Configuration Version State","description":"","enum":["PENDING","SCHEDULING","ACTIVE","DELETING","DELETED"],"x-model-behavior":"ENUM"},"PaymentTerminalLocation":{"type":"object","properties":{"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the payment terminal location.","title":"Name","readOnly":true,"maxLength":100},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"productionMerchantId":{"type":"string","description":"The production merchant identifier assigned to the location.","title":"Production Merchant ID","readOnly":true,"minLength":15,"maxLength":15},"state":{"description":"The current state of the payment terminal location.","title":"State","readOnly":true,"$ref":"#/definitions/PaymentTerminalLocationState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentterminallocation"},"title":"Terminal Location","description":"","x-model-behavior":"READ"},"PaymentTerminalLocationState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentterminallocationstate"},"title":"Payment Terminal Location State","description":"","enum":["CREATE","ACTIVE","DELETING","DELETED"],"x-model-behavior":"ENUM"},"PaymentTerminalLocationVersion":{"type":"object","properties":{"address":{"description":"The postal address of the location where the payment terminals are used.","title":"Address","readOnly":true,"$ref":"#/definitions/PaymentTerminalAddress"},"contactAddress":{"description":"The contact details if the person responsible for the payment terminals at this location.","title":"Contact Address","readOnly":true,"$ref":"#/definitions/PaymentTerminalAddress"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the payment terminal location version was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"location":{"description":"The payment terminal location that the version belongs to.","title":"Location","readOnly":true,"$ref":"#/definitions/PaymentTerminalLocation"},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/PaymentTerminalLocationVersionState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true},"versionAppliedImmediately":{"type":"boolean","description":"Whether payment terminals are immediately updated to this configuration version. If not, it will be applied during the maintenance window.","title":"Version Applied Immediately","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentterminallocationversion"},"title":"Terminal Location Version","description":"","x-model-behavior":"READ"},"PaymentTerminalLocationVersionState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentterminallocationversionstate"},"title":"Payment Terminal Location Version State","description":"","enum":["PENDING","SCHEDULING","ACTIVE","OBSOLETE","DELETING","DELETED"],"x-model-behavior":"ENUM"},"PaymentTerminalState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentterminalstate"},"title":"Terminal State","description":"","enum":["CREATE","PREPARING","ACTIVE","INACTIVE","DECOMMISSIONING","DECOMMISSIONED"],"x-model-behavior":"ENUM"},"PaymentTerminalType":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_paymentterminaltype"},"title":"Terminal Type","description":"","x-model-behavior":"READ"},"Permission":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"feature":{"type":"integer","format":"int64","description":"The feature that this permission belongs to.","title":"Feature","readOnly":true},"group":{"type":"boolean","description":"Whether this is a permission group.","title":"Group","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"leaf":{"type":"boolean","description":"Whether this is a leaf in the tree of permissions, and not a group.","title":"Leaf","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}},"parent":{"type":"integer","format":"int64","description":"The group that this permission belongs to.","title":"Parent","readOnly":true},"pathToRoot":{"type":"array","description":"All parents of this permission up to the root of the permission tree.","title":"Path To Root","readOnly":true,"items":{"type":"integer","format":"int64"}},"title":{"type":"object","description":"The localized name of the object.","title":"Title","readOnly":true,"additionalProperties":{"type":"string"}},"twoFactorRequired":{"type":"boolean","description":"Whether users with this permission are required to enable two-factor authentication.","title":"Two Factor Required","readOnly":true},"webAppEnabled":{"type":"boolean","description":"","title":"Web App Enabled","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_permission"},"title":"Permission","description":"","x-model-behavior":"READ"},"RecurringIndicator":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_recurringindicator"},"title":"Recurring Indicator","description":"","enum":["REGULAR_TRANSACTION","INITIAL_RECURRING_TRANSACTION","MERCHANT_INITIATED_RECURRING_TRANSACTION","CUSTOMER_INITIATED_RECURRING_TRANSACTION"],"x-model-behavior":"ENUM"},"Refund":{"type":"object","properties":{"amount":{"type":"number","description":"The total monetary amount of the refund, representing the exact credit issued to the customer.","title":"Amount","readOnly":true},"baseLineItems":{"type":"array","description":"The original base line items from the transaction prior to the refund, serving as a reference for the refunded amounts.","title":"Base Line Items","readOnly":true,"items":{"$ref":"#/definitions/LineItem"}},"completion":{"type":"integer","format":"int64","description":"The transaction completion that the refund belongs to.","title":"Completion","readOnly":true},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the refund was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"environment":{"description":"The environment used when rendering resources.","title":"Environment","readOnly":true,"$ref":"#/definitions/Environment"},"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID","readOnly":true,"minLength":1,"maxLength":100},"failedOn":{"type":"string","format":"date-time","description":"The date and time when the refund failed.","title":"Failed On","readOnly":true},"failureReason":{"description":"The reason for the failure of the refund.","title":"Failure Reason","readOnly":true,"$ref":"#/definitions/FailureReason"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"labels":{"type":"array","description":"The labels providing additional information about the object.","title":"Labels","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/Label"}},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language","readOnly":true},"lineItems":{"type":"array","description":"The line items included in the refund, representing the reductions.","title":"Line Items","readOnly":true,"items":{"$ref":"#/definitions/LineItem"}},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"merchantReference":{"type":"string","description":"The merchant's reference used to identify the refund.","title":"Merchant Reference","readOnly":true,"maxLength":100},"metaData":{"type":"object","description":"Allow to store additional information about the object.","title":"Meta Data","readOnly":true,"additionalProperties":{"type":"string"}},"nextUpdateOn":{"type":"string","format":"date-time","description":"The date and time when the next update of the object's state is planned.","title":"Next Update On","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"processingOn":{"type":"string","format":"date-time","description":"The date and time when the processing of the refund was started.","title":"Processing On","readOnly":true},"processorReference":{"type":"string","description":"The reference ID provided by the payment processor, used to trace the refund through the external payment system.","title":"Processor Reference","readOnly":true,"maxLength":150},"reducedLineItems":{"type":"array","description":"The line items from the original transaction, adjusted to reflect any reductions applied during the refund process.","title":"Reduced Line Items","readOnly":true,"items":{"$ref":"#/definitions/LineItem"}},"reductions":{"type":"array","description":"The reductions applied on the original transaction items, detailing specific adjustments associated with the refund.","title":"Reductions","readOnly":true,"items":{"$ref":"#/definitions/LineItemReduction"}},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/RefundState"},"succeededOn":{"type":"string","format":"date-time","description":"The date and time when the refund succeeded.","title":"Succeeded On","readOnly":true},"taxes":{"type":"array","description":"The tax breakdown applied to the refund amount, helping with tax calculations or reporting.","title":"Taxes","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/Tax"}},"timeZone":{"type":"string","description":"The time zone that this object is associated with.","title":"Time Zone","readOnly":true},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the object will expire.","title":"Timeout On","readOnly":true},"totalAppliedFees":{"type":"number","description":"The sum of fees applied to the refund transaction, such as processing or service charges.","title":"Total Applied Fees","readOnly":true},"totalSettledAmount":{"type":"number","description":"The total amount settled for the refund, factoring in reductions, taxes, and any additional applied fees.","title":"Total Settled Amount","readOnly":true},"transaction":{"description":"The transaction that the refund belongs to.","title":"Transaction","readOnly":true,"$ref":"#/definitions/Transaction"},"type":{"description":"The type specifying the method and origin of the refund (e.g., initiated by the customer or merchant).","title":"Type","readOnly":true,"$ref":"#/definitions/RefundType"},"updatedInvoice":{"type":"integer","format":"int64","description":"An updated invoice reflecting adjustments made by the refund.","title":"Updated Invoice","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_refund"},"title":"Refund","description":"A refund is a credit issued to the customer, which can be initiated either by the merchant or by the customer as a reversal.","x-model-behavior":"READ"},"Refund.Create":{"type":"object","required":["externalId","type"],"properties":{"amount":{"type":"number","description":"The total monetary amount of the refund, representing the exact credit issued to the customer.","title":"Amount"},"completion":{"type":"integer","format":"int64","description":"The transaction completion that the refund belongs to.","title":"Completion"},"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID","minLength":1,"maxLength":100},"merchantReference":{"type":"string","description":"The merchant's reference used to identify the refund.","title":"Merchant Reference","maxLength":100},"metaData":{"type":"object","description":"Allow to store additional information about the object.","title":"Meta Data","additionalProperties":{"type":"string"}},"reductions":{"type":"array","description":"The reductions applied on the original transaction items, detailing specific adjustments associated with the refund.","title":"Reductions","items":{"$ref":"#/definitions/LineItemReduction.Create"}},"transaction":{"type":"integer","format":"int64","description":"The transaction that the refund belongs to.","title":"Transaction"},"type":{"description":"The type specifying the method and origin of the refund (e.g., initiated by the customer or merchant).","title":"Type","$ref":"#/definitions/RefundType"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_refund_create"},"title":"Refund Create","description":"A refund is a credit issued to the customer, which can be initiated either by the merchant or by the customer as a reversal.","x-model-behavior":"CREATE"},"RefundComment":{"type":"object","properties":{"content":{"type":"string","description":"The comment's actual content.","title":"Content","readOnly":true,"maxLength":262144},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"editedBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was last updated by.","title":"Edited By","readOnly":true},"editedOn":{"type":"string","format":"date-time","description":"The date and time when the comment was last updated.","title":"Edited On","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"pinned":{"type":"boolean","description":"Whether the comment is pinned to the top.","title":"Pinned","readOnly":true},"refund":{"type":"integer","format":"int64","description":"The refund that the comment belongs to.","title":"Refund","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_refundcomment"},"title":"Refund Comment","description":"","x-model-behavior":"READ"},"RefundComment.Active":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_refundcomment_active"},"title":"Comment","allOf":[{"$ref":"#/definitions/Abstract.RefundComment.Active"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_refundcomment_active"},"title":"Comment","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"},"RefundComment.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_refundcomment_create"},"title":"Comment","allOf":[{"$ref":"#/definitions/Abstract.RefundComment.Active"},{"type":"object","required":["refund"],"properties":{"refund":{"type":"integer","format":"int64","description":"The refund that the comment belongs to.","title":"Refund"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_refundcomment_create"},"title":"Comment","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"RefundState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_refundstate"},"title":"Refund State","description":"","enum":["CREATE","SCHEDULED","PENDING","MANUAL_CHECK","FAILED","SUCCESSFUL"],"x-model-behavior":"ENUM"},"RefundType":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_refundtype"},"title":"Refund Type","description":"","enum":["MERCHANT_INITIATED_ONLINE","MERCHANT_INITIATED_OFFLINE","CUSTOMER_INITIATED_AUTOMATIC","CUSTOMER_INITIATED_MANUAL"],"x-model-behavior":"ENUM"},"RenderedDocument":{"type":"object","properties":{"data":{"type":"array","description":"The binary data of the document","title":"Data","readOnly":true,"items":{"type":"string","format":"byte"}},"documentTemplateType":{"type":"integer","format":"int64","description":"The document's template type","title":"Document Template Type","readOnly":true},"mimeType":{"type":"string","description":"The document's content type","title":"Mime Type","readOnly":true},"title":{"type":"string","description":"The title of the rendered document","title":"Title","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_rendereddocument"},"title":"Rendered Document","description":"","x-model-behavior":"READ"},"ResourcePath":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"path":{"type":"string","description":"","title":"Path","readOnly":true,"minLength":4,"maxLength":500},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"spaceId":{"type":"integer","format":"int64","description":"","title":"Space Id","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/ResourceState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_resourcepath"},"title":"Resource Path","description":"","x-model-behavior":"READ"},"ResourceState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_resourcestate"},"title":"Resource State","description":"","enum":["ACTIVE","DELETING","DELETED"],"x-model-behavior":"ENUM"},"RestAddressFormat":{"type":"object","properties":{"postCodeExamples":{"type":"array","description":"A list of sample post codes.","title":"Post Code Examples","readOnly":true,"items":{"type":"string"}},"postCodeRegex":{"type":"string","description":"The regular expression to validate post codes.","title":"Post Code Regex","readOnly":true},"requiredFields":{"type":"array","description":"The fields that are required in the address format.","title":"Required Fields","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/RestAddressFormatField"}},"usedFields":{"type":"array","description":"The fields that are used in the address format.","title":"Used Fields","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/RestAddressFormatField"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_restaddressformat"},"title":"Address Format","description":"","x-model-behavior":"READ"},"RestAddressFormatField":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_restaddressformatfield"},"title":"Address Format Field","description":"","enum":["GIVEN_NAME","FAMILY_NAME","ORGANIZATION_NAME","STREET","DEPENDENT_LOCALITY","CITY","POSTAL_STATE","POST_CODE","SORTING_CODE","COUNTRY"],"x-model-behavior":"ENUM"},"RestCountry":{"type":"object","properties":{"addressFormat":{"description":"The country's way of formatting addresses.","title":"Address Format","readOnly":true,"$ref":"#/definitions/RestAddressFormat"},"isoCode2":{"type":"string","description":"The country's two-letter code (ISO 3166-1 alpha-2 format).","title":"Two-letter Code","readOnly":true},"isoCode3":{"type":"string","description":"The country's three-letter code (ISO 3166-1 alpha-3 format).","title":"Three-letter Code","readOnly":true},"name":{"type":"string","description":"The name of the country.","title":"Name","readOnly":true},"numericCode":{"type":"string","description":"The country's three-digit code (ISO 3166-1 numeric format).","title":"Numeric Code","readOnly":true},"stateCodes":{"type":"array","description":"The codes of all regions (e.g. states, provinces) of the country (ISO 3166-2 format).","title":"State Codes","readOnly":true,"uniqueItems":true,"items":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_restcountry"},"title":"Country","description":"","x-model-behavior":"READ"},"RestCountryState":{"type":"object","properties":{"code":{"type":"string","description":"The state's code used within addresses.","title":"Code","readOnly":true},"countryCode":{"type":"string","description":"The two-letter code of the state's country (ISO 3166-1 alpha-2 format).","title":"Country Code","readOnly":true},"id":{"type":"string","description":"The state's code in ISO 3166-2 format.","title":"Id","readOnly":true},"name":{"type":"string","description":"The name of the state.","title":"Name","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_restcountrystate"},"title":"State","description":"","x-model-behavior":"READ"},"RestCurrency":{"type":"object","properties":{"currencyCode":{"type":"string","description":"The currency's three-letter code (ISO 4217 format).","title":"Currency Code","readOnly":true},"fractionDigits":{"type":"integer","format":"int32","description":"The currency's number of decimals. When calculating amounts in this currency, the fraction digits determine the accuracy.","title":"Fraction Digits","readOnly":true},"name":{"type":"string","description":"The name of the currency.","title":"Name","readOnly":true},"numericCode":{"type":"integer","format":"int32","description":"The currency's three-digit code (ISO 4217 format).","title":"Numeric Code","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_restcurrency"},"title":"Currency","description":"","x-model-behavior":"READ"},"RestLanguage":{"type":"object","properties":{"countryCode":{"type":"string","description":"The two-letter code of the language's region (ISO 3166-1 alpha-2 format).","title":"Country Code","readOnly":true},"ietfCode":{"type":"string","description":"The language's IETF tag consisting of the two-letter ISO code and region e.g. en-US, de-CH.","title":"IETF Code","readOnly":true},"iso2Code":{"type":"string","description":"The language's two-letter code (ISO 639-1 format).","title":"Two-letter Code","readOnly":true},"iso3Code":{"type":"string","description":"The language's three-letter code (ISO 639-2/T format).","title":"Three-letter Code","readOnly":true},"name":{"type":"string","description":"The name of the language.","title":"Name","readOnly":true},"pluralExpression":{"type":"string","description":"The expression to determine the plural index for a given number of items used to find the proper plural form for translations.","title":"Plural Expression","readOnly":true},"primaryOfGroup":{"type":"boolean","description":"Whether this is the primary language in a group of languages.","title":"Primary Of Group","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_restlanguage"},"title":"Language","description":"","x-model-behavior":"READ"},"Role":{"type":"object","properties":{"account":{"description":"The account the role belongs to. The role can only be assigned within this account.","title":"Account","readOnly":true,"$ref":"#/definitions/Account"},"description":{"type":"object","description":"Additional information that describes the role.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The name used to identify the role.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}},"permissions":{"type":"array","description":"The permissions granted to users with this role.","title":"Permissions","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/Permission"}},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/RoleState"},"twoFactorRequired":{"type":"boolean","description":"Whether users with this role are required to use two-factor authentication.","title":"Two-Factor Authentication Required","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_role"},"title":"Role","description":"","x-model-behavior":"READ"},"RoleState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_rolestate"},"title":"Role State","description":"","enum":["CREATE","ACTIVE","DELETING","DELETED"],"x-model-behavior":"ENUM"},"SalesChannel":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}},"sortOrder":{"type":"integer","format":"int32","description":"When listing sales channels, they can be sorted by this number.","title":"Sort Order","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_saleschannel"},"title":"Sales Channel","description":"","x-model-behavior":"READ"},"Scope":{"type":"object","properties":{"domainName":{"type":"string","description":"The domain name that belongs to the scope.","title":"Domain Name","readOnly":true,"maxLength":100},"features":{"type":"array","description":"The list of features that are active in the scope.","title":"Features","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/Feature"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"machineName":{"type":"string","description":"The name identifying the scope in e.g. URLs.","title":"Machine Name","readOnly":true,"maxLength":50},"name":{"type":"string","description":"The name used to identify the scope.","title":"Name","readOnly":true,"maxLength":50},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"port":{"type":"integer","format":"int32","description":"The port where the scope can be accessed.","title":"Port","readOnly":true},"preprodDomainName":{"type":"string","description":"The preprod domain name that belongs to the scope.","title":"Preprod Domain Name","readOnly":true,"maxLength":100},"sandboxDomainName":{"type":"string","description":"The sandbox domain name that belongs to the scope.","title":"Sandbox Domain Name","readOnly":true,"maxLength":100},"sslActive":{"type":"boolean","description":"Whether the scope supports SSL.","title":"SSL Active","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"themes":{"type":"array","description":"The themes that determine the look and feel of the scope's user interface. A fall-through strategy is applied when building the actual theme.","title":"Themes","readOnly":true,"items":{"type":"string"}},"trustedExternalOrigins":{"type":"array","description":"Trusted external origins (e.g. merchant shops) for browser API access (CORS on /api/) and absolute target redirect URLs.","title":"Trusted External Origins","readOnly":true,"items":{"type":"string"}},"url":{"type":"string","description":"The URL where the scope can be accessed.","title":"Url","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_scope"},"title":"Scope","description":"","x-model-behavior":"READ"},"ServerError":{"type":"object","properties":{"date":{"type":"string","description":"Date when an error has occurred.","title":"Date","readOnly":true},"id":{"type":"string","description":"Unique identifier of an error.","title":"ID","readOnly":true},"message":{"type":"string","description":"This message describes an error.","title":"Message","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_servererror"},"title":"Server Error","description":"This error is thrown when something unexpected happens on our side.","x-model-behavior":"READ"},"Space":{"type":"object","properties":{"account":{"description":"The account that the space belongs to.","title":"Account","readOnly":true,"$ref":"#/definitions/Account"},"active":{"type":"boolean","description":"Whether this space and all its parent accounts are active.","title":"Active","readOnly":true},"activeOrRestrictedActive":{"type":"boolean","description":"Whether this space and all its parent accounts are active or restricted active.","title":"Active Or Restricted Active","readOnly":true},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the space was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the space was created.","title":"Created On","readOnly":true},"database":{"description":"The database the space is connected to and that holds the space's data.","title":"Database","readOnly":true,"$ref":"#/definitions/TenantDatabase"},"deletedBy":{"type":"integer","format":"int64","description":"The ID of the user the space was deleted by.","title":"Deleted By","readOnly":true},"deletedOn":{"type":"string","format":"date-time","description":"The date and time when the space was deleted.","title":"Deleted On","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the space.","title":"Name","readOnly":true,"minLength":3,"maxLength":200},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"postalAddress":{"description":"The address that is used in communication with clients for example in emails, documents, etc.","title":"Postal Address","readOnly":true,"$ref":"#/definitions/SpaceAddress"},"primaryCurrency":{"type":"string","description":"The currency that is used to display aggregated amounts in the space.","title":"Primary Currency","readOnly":true},"requestLimit":{"type":"integer","format":"int64","description":"The maximum number of API requests that are accepted within two minutes. This limit can only be changed with special privileges.","title":"Request Limit","readOnly":true},"restrictedActive":{"type":"boolean","description":"Whether this space and all its parent accounts are active or restricted active. There is least one parent account that is restricted active.","title":"Restricted Active","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"technicalContactAddresses":{"type":"array","description":"The email address that will receive messages about technical issues and errors that occur in the space.","title":"Technical Contact Addresses","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"timeZone":{"type":"string","description":"The time zone that is used to schedule and run background processes. This does not affect the formatting of dates in the user interface.","title":"Time Zone","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_space"},"title":"Space","description":"","x-model-behavior":"READ"},"Space.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_space_create"},"title":"Space","allOf":[{"$ref":"#/definitions/Abstract.Space.Update"},{"type":"object","required":["account"],"properties":{"account":{"type":"integer","format":"int64","description":"The account that the space belongs to.","title":"Account"},"database":{"type":"integer","format":"int64","description":"The database the space is connected to and that holds the space's data.","title":"Database"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_space_create"},"title":"Space","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"Space.Update":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_space_update"},"title":"Space","allOf":[{"$ref":"#/definitions/Abstract.Space.Update"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_space_update"},"title":"Space","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"},"SpaceAddress":{"type":"object","properties":{"city":{"type":"string","description":"The city, town or village.","title":"City","readOnly":true},"country":{"type":"string","description":"The two-letter country code (ISO 3166 format).","title":"Country","readOnly":true},"dependentLocality":{"type":"string","description":"The dependent locality which is a sub-division of the state.","title":"Dependent Locality","readOnly":true,"maxLength":100},"emailAddress":{"type":"string","description":"The email address used for communication with clients.","title":"Email Address","readOnly":true},"familyName":{"type":"string","description":"The family or last name.","title":"Family Name","readOnly":true,"maxLength":100},"givenName":{"type":"string","description":"The given or first name.","title":"Given Name","readOnly":true,"maxLength":100},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","title":"Mobile Phone Number","readOnly":true,"maxLength":100},"organizationName":{"type":"string","description":"The organization's name.","title":"Organization Name","readOnly":true,"maxLength":100},"phoneNumber":{"type":"string","description":"The phone number.","title":"Phone Number","readOnly":true,"maxLength":100},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","title":"State","readOnly":true},"postcode":{"type":"string","description":"The postal code, also known as ZIP, postcode, etc.","title":"Postcode","readOnly":true},"salesTaxNumber":{"type":"string","description":"The sales tax number of the organization.","title":"Sales Tax Number","readOnly":true,"maxLength":100},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","title":"Salutation","readOnly":true,"maxLength":20},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","title":"Sorting Code","readOnly":true,"maxLength":100},"street":{"type":"string","description":"The street or PO Box.","title":"Street","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_spaceaddress"},"title":"Space Address","description":"","x-model-behavior":"READ"},"SpaceAddress.Create":{"type":"object","properties":{"city":{"type":"string","description":"The city, town or village.","title":"City"},"country":{"type":"string","description":"The two-letter country code (ISO 3166 format).","title":"Country"},"dependentLocality":{"type":"string","description":"The dependent locality which is a sub-division of the state.","title":"Dependent Locality","maxLength":100},"emailAddress":{"type":"string","description":"The email address used for communication with clients.","title":"Email Address"},"familyName":{"type":"string","description":"The family or last name.","title":"Family Name","maxLength":100},"givenName":{"type":"string","description":"The given or first name.","title":"Given Name","maxLength":100},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","title":"Mobile Phone Number","maxLength":100},"organizationName":{"type":"string","description":"The organization's name.","title":"Organization Name","maxLength":100},"phoneNumber":{"type":"string","description":"The phone number.","title":"Phone Number","maxLength":100},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","title":"State"},"postcode":{"type":"string","description":"The postal code, also known as ZIP, postcode, etc.","title":"Postcode"},"salesTaxNumber":{"type":"string","description":"The sales tax number of the organization.","title":"Sales Tax Number","maxLength":100},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","title":"Salutation","maxLength":20},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","title":"Sorting Code","maxLength":100},"street":{"type":"string","description":"The street or PO Box.","title":"Street"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_spaceaddress_create"},"title":"Space Address","description":"","x-model-behavior":"CREATE"},"SpaceView":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the space view.","title":"Name","readOnly":true,"minLength":3,"maxLength":200},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"space":{"description":"The space that the space view belongs to.","title":"Space","readOnly":true,"$ref":"#/definitions/Space"},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_spaceview"},"title":"Space View","description":"","x-model-behavior":"READ"},"StaticValue":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"features":{"type":"array","description":"The features that this static value belongs to.","title":"Features","readOnly":true,"items":{"type":"integer","format":"int64"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_staticvalue"},"title":"Static Value","description":"","x-model-behavior":"READ"},"Tax":{"type":"object","properties":{"rate":{"type":"number","description":"The tax rate to be applied.","title":"Rate","readOnly":true},"title":{"type":"string","description":"The name of the tax.","title":"Title","readOnly":true,"minLength":2,"maxLength":40}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_tax"},"title":"Tax","description":"","x-model-behavior":"READ"},"Tax.Create":{"type":"object","required":["rate","title"],"properties":{"rate":{"type":"number","description":"The tax rate to be applied.","title":"Rate"},"title":{"type":"string","description":"The name of the tax.","title":"Title","minLength":2,"maxLength":40}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_tax_create"},"title":"Tax (in creation)","description":"","x-model-behavior":"CREATE"},"TenantDatabase":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the database.","title":"Name","readOnly":true,"maxLength":200},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_tenantdatabase"},"title":"Database","description":"","x-model-behavior":"READ"},"Token":{"type":"object","properties":{"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"customerEmailAddress":{"type":"string","description":"The customer's email address.","title":"Customer Email Address","readOnly":true,"maxLength":150},"customerId":{"type":"string","description":"The unique identifier of the customer in the external system.","title":"Customer ID","readOnly":true},"enabledForOneClickPayment":{"type":"boolean","description":"Whether the token is enabled for one-click payments, which simplify the payment process for the customer. One-click tokens are linked to customers via the customer ID.","title":"Enabled For One-Click Payment","readOnly":true},"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"timeZone":{"type":"string","description":"The customer's time zone, which affects how dates and times are formatted when communicating with the customer.","title":"Time Zone","readOnly":true},"tokenReference":{"type":"string","description":"The reference used to identify the payment token (e.g. the customer's ID or email address).","title":"Token Reference","readOnly":true,"maxLength":100},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_token"},"title":"Token","description":"","x-model-behavior":"READ"},"Token.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_token_create"},"title":"Token . Create","allOf":[{"$ref":"#/definitions/Abstract.Token.Update"},{"type":"object","required":["externalId"],"properties":{"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID"},"state":{"description":"The object's current state.","title":"State","$ref":"#/definitions/CreationEntityState"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_token_create"},"title":"Token . Create","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"Token.Update":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_token_update"},"title":"Token . Update","allOf":[{"$ref":"#/definitions/Abstract.Token.Update"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_token_update"},"title":"Token . Update","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"},"TokenVersion":{"type":"object","properties":{"activatedOn":{"type":"string","format":"date-time","description":"The date and time when the token version was activated.","title":"Activated On","readOnly":true},"billingAddress":{"description":"The billing address to be used for the transaction if no explicit billing address is provided during payment processing.","title":"Billing Address","readOnly":true,"$ref":"#/definitions/Address"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"environment":{"description":"The environment in which the token version was created.","title":"Environment","readOnly":true,"$ref":"#/definitions/ChargeAttemptEnvironment"},"expiresOn":{"type":"string","format":"date-time","description":"The date and time when the token version is set to expire, after which it will be marked as obsolete.","title":"Expires On","readOnly":true},"iconUrl":{"type":"string","description":"The URL to the token's icon displayed to the customer.","title":"Icon Url","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"labels":{"type":"array","description":"The labels providing additional information about the object.","title":"Labels","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/Label"}},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language","readOnly":true},"lastRetriedOn":{"type":"string","format":"date-time","description":"The date and time when the system last attempted a retry for this token version.","title":"Last Retried On","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the token.","title":"Name","readOnly":true,"maxLength":150},"obsoletedOn":{"type":"string","format":"date-time","description":"The date and time when the token version was marked obsolete.","title":"Obsoleted On","readOnly":true},"paymentConnectorConfiguration":{"description":"The payment connector configuration that initialized the token version.","title":"Payment Connector Configuration","readOnly":true,"$ref":"#/definitions/PaymentConnectorConfiguration"},"paymentInformationHashes":{"type":"array","description":"The hashed payment information that the token version represents.","title":"Payment Information Hashes","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/PaymentInformationHash"}},"paymentMethod":{"type":"integer","format":"int64","description":"The payment method that initialized the token version.","title":"Payment Method","readOnly":true},"paymentMethodBrand":{"type":"integer","format":"int64","description":"The payment method brand that initialized the token version.","title":"Payment Method Brand","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"processorToken":{"type":"string","description":"The token name as specified by the processor.","title":"Processor Token","readOnly":true,"maxLength":150},"retryIn":{"type":"string","description":"Retry interval when the strategy advises retrying later.","title":"Retry In","readOnly":true},"retryStrategy":{"description":"Retry advice derived from processor decline codes. If empty, no restriction applies and the system may retry when appropriate.","title":"Retry Strategy","readOnly":true,"$ref":"#/definitions/TokenVersionRetryStrategy"},"shippingAddress":{"description":"The shipping address to be used for the transaction if no explicit shipping address is provided during payment processing.","title":"Shipping Address","readOnly":true,"$ref":"#/definitions/Address"},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/TokenVersionState"},"token":{"description":"The token that the token version belongs to.","title":"Token","readOnly":true,"$ref":"#/definitions/Token"},"type":{"description":"The type specifies the nature of the token and identifies the payment connector capable of processing it.","title":"Type","readOnly":true,"$ref":"#/definitions/TokenVersionType"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_tokenversion"},"title":"Token Version","description":"","x-model-behavior":"READ"},"TokenVersionRetryStrategy":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_tokenversionretrystrategy"},"title":"Token Version Retry Strategy","description":"","enum":["NO_RETRY","RETRY_LATER","REFRESH_TOKEN"],"x-model-behavior":"ENUM"},"TokenVersionState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_tokenversionstate"},"title":"Token Version State","description":"","enum":["UNINITIALIZED","ACTIVE","OBSOLETE"],"x-model-behavior":"ENUM"},"TokenVersionType":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"feature":{"description":"The feature that the token version type belongs to.","title":"Feature","readOnly":true,"$ref":"#/definitions/Feature"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_tokenversiontype"},"title":"Token Version Type","description":"","x-model-behavior":"READ"},"TokenizationMode":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_tokenizationmode"},"title":"Tokenization Mode","description":"The tokenization mode controls how the tokenization of payment information is applied on the transaction.","enum":["FORCE_UPDATE","FORCE_CREATION","FORCE_CREATION_WITH_ONE_CLICK_PAYMENT","ALLOW_ONE_CLICK_PAYMENT"],"x-model-behavior":"ENUM"},"TokenizedCardData":{"type":"object","properties":{"cryptogram":{"description":"An additional authentication value that enhances the security of tokenized card transactions.","title":"Cryptogram","readOnly":true,"$ref":"#/definitions/CardCryptogram"},"initialRecurringTransaction":{"type":"boolean","description":"Whether the transaction is an initial recurring transaction, based on the recurring indicator. This is used to identify the first transaction in a recurring payment setup.","title":"Initial Recurring Transaction","readOnly":true},"recurringIndicator":{"description":"The indicator used to distinguish between recurring and one-time transactions. If omitted, it will be automatically determined based on the transaction's properties.","title":"Recurring Indicator","readOnly":true,"$ref":"#/definitions/RecurringIndicator"},"tokenRequestorId":{"type":"string","description":"The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.","title":"Token Requestor Identifier (TRID)","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_tokenizedcarddata"},"title":"Tokenized Card Data","description":"","x-model-behavior":"READ"},"TokenizedCardData.Create":{"type":"object","required":["primaryAccountNumber"],"properties":{"cardHolderName":{"type":"string","description":"The name of the cardholder, as printed on the card, identifying the card owner.","title":"Cardholder Name","maxLength":100},"cardVerificationCode":{"type":"string","description":"The security code used to validate the card during transactions.","title":"Card Verification Code (CVC)","minLength":3,"maxLength":4},"cryptogram":{"description":"An additional authentication value that enhances the security of tokenized card transactions.","title":"Cryptogram","$ref":"#/definitions/CardCryptogram.Create"},"expiryDate":{"type":"string","description":"The expiry date of the card, indicating its validity period in yyyy-mm format (e.g., 2023-09).","title":"Expiry Date"},"panType":{"description":"The type of PAN or token, indicating the source or security method of the card information.","title":"PAN Type","$ref":"#/definitions/PanType"},"primaryAccountNumber":{"type":"string","description":"The card's primary account number (PAN), the unique identifier of the card.","title":"Primary Account Number (PAN)","minLength":10,"maxLength":30},"recurringIndicator":{"description":"The indicator used to distinguish between recurring and one-time transactions. If omitted, it will be automatically determined based on the transaction's properties.","title":"Recurring Indicator","$ref":"#/definitions/RecurringIndicator"},"schemeTransactionReference":{"type":"string","description":"A reference specific to the card's transaction within its payment scheme.","title":"Scheme Transaction Reference","maxLength":100},"tokenRequestorId":{"type":"string","description":"The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.","title":"Token Requestor Identifier (TRID)"},"transactionLinkIdentifier":{"type":"string","description":"A reference specific to linking card transaction lifecycle events within the payment scheme.","title":"Transaction Link Identifier","maxLength":100}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_tokenizedcarddata_create"},"title":"Tokenized Card Data . Create","description":"","x-model-behavior":"CREATE"},"Transaction":{"type":"object","properties":{"acceptHeader":{"type":"string","description":"The 'Accept' header of the customer's web browser.","title":"Accept Header","readOnly":true},"acceptLanguageHeader":{"type":"string","description":"The 'Accept Language' header of the customer's web browser.","title":"Accept Language Header","readOnly":true},"allowedPaymentMethodBrands":{"type":"array","description":"The payment method brands that can be used to authorize the transaction.","title":"Allowed Payment Method Brands","readOnly":true,"items":{"type":"integer","format":"int64"}},"allowedPaymentMethodConfigurations":{"type":"array","description":"The payment method configurations that can be used to authorize the transaction.","title":"Allowed Payment Method Configurations","readOnly":true,"items":{"type":"integer","format":"int64"}},"authorizationAmount":{"type":"number","description":"The sum of all line item prices including taxes in the transaction's currency.","title":"Authorization Amount","readOnly":true},"authorizationEnvironment":{"description":"The environment in which the transaction was authorized.","title":"Authorization Environment","readOnly":true,"$ref":"#/definitions/ChargeAttemptEnvironment"},"authorizationSalesChannel":{"type":"integer","format":"int64","description":"The sales channel through which the transaction was placed.","title":"Sales Channel","readOnly":true},"authorizationTimeoutOn":{"type":"string","format":"date-time","description":"The date and time when the transaction must be authorized, otherwise it will canceled.","title":"Authorization Timeout On","readOnly":true},"authorizedOn":{"type":"string","format":"date-time","description":"The date and time when the transaction was authorized.","title":"Authorized On","readOnly":true},"autoConfirmationEnabled":{"type":"boolean","description":"Whether the transaction can be confirmed automatically or whether this must be done explicitly via the API. Default is true.","title":"Auto Confirmation Enabled","readOnly":true},"billingAddress":{"description":"The address associated with the payment method for invoicing and transaction processing purposes.","title":"Billing Address","readOnly":true,"$ref":"#/definitions/Address"},"chargeRetryEnabled":{"type":"boolean","description":"Whether the customer can make further payment attempts if the first one has failed. Default is true.","title":"Charge Retry Enabled","readOnly":true},"completedAmount":{"type":"number","description":"The total amount that was completed, in the transaction's currency.","title":"Completed Amount","readOnly":true},"completedOn":{"type":"string","format":"date-time","description":"The date and time when the transaction was completed.","title":"Completed On","readOnly":true},"completionBehavior":{"description":"The behavior that controls when the transaction is completed.","title":"Completion Behavior","readOnly":true,"$ref":"#/definitions/TransactionCompletionBehavior"},"completionTimeoutOn":{"type":"string","format":"date-time","description":"The date and time when the transaction is completed automatically.","title":"Completion Timeout On","readOnly":true},"confirmedBy":{"type":"integer","format":"int64","description":"The ID of the user the transaction was confirmed by.","title":"Confirmed By","readOnly":true},"confirmedOn":{"type":"string","format":"date-time","description":"The date and time when the transaction was created.","title":"Confirmed On","readOnly":true},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the transaction was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"currency":{"type":"string","description":"The three-letter code (ISO 4217 format) of the transaction's currency.","title":"Currency","readOnly":true},"customerEmailAddress":{"type":"string","description":"The customer's email address.","title":"Customer Email Address","readOnly":true,"maxLength":254},"customerId":{"type":"string","description":"The unique identifier of the customer in the external system.","title":"Customer ID","readOnly":true},"customersPresence":{"description":"The customer's presence indicates whether and in what way the transaction's customer is present. Default is VIRTUAL_PRESENT.","title":"Customers Presence","readOnly":true,"$ref":"#/definitions/CustomersPresence"},"deliveryDecisionMadeOn":{"type":"string","format":"date-time","description":"This date and time when the decision was made as to whether the order should be shipped.","title":"Delivery Decision Made On","readOnly":true},"deviceSessionIdentifier":{"type":"string","description":"Allows to link the transaction to the data collected from the customer's device.","title":"Device Session Identifier","readOnly":true,"minLength":10,"maxLength":40},"emailsDisabled":{"type":"boolean","description":"Whether email sending is deactivated for the transaction. Default is false.","title":"Emails Disabled","readOnly":true},"endOfLife":{"type":"string","format":"date-time","description":"The date and time when the transaction reaches its end of live. No further actions can be carried out at this time.","title":"End Of Life","readOnly":true},"environment":{"description":"The environment used when rendering resources.","title":"Environment","readOnly":true,"$ref":"#/definitions/Environment"},"environmentSelectionStrategy":{"description":"The strategy for determining whether the transaction is to be processed in the test or production environment.","title":"Environment Selection Strategy","readOnly":true,"$ref":"#/definitions/TransactionEnvironmentSelectionStrategy"},"failedOn":{"type":"string","format":"date-time","description":"The date and time when the transaction failed.","title":"Failed On","readOnly":true},"failedUrl":{"type":"string","description":"The URL to redirect the customer back to after they canceled or failed to authenticated their payment.","title":"Failed Url","readOnly":true,"minLength":9,"maxLength":2000},"failureReason":{"description":"The reason for the failure of the transaction.","title":"Failure Reason","readOnly":true,"$ref":"#/definitions/FailureReason"},"group":{"description":"The group that the transaction belongs to.","title":"Group","readOnly":true,"$ref":"#/definitions/TransactionGroup"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"internetProtocolAddress":{"type":"string","description":"The IP address of the customer's device.","title":"Internet Protocol (IP) Address","readOnly":true},"internetProtocolAddressCountry":{"type":"string","description":"The country determined from the IP address of the customer's device.","title":"Internet Protocol Address Country","readOnly":true},"invoiceMerchantReference":{"type":"string","description":"The merchant's reference used to identify the invoice.","title":"Invoice Merchant Reference","readOnly":true,"maxLength":100},"javaEnabled":{"type":"boolean","description":"Whether Java is enabled on the customer's web browser.","title":"Java Enabled","readOnly":true},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language","readOnly":true},"lineItems":{"type":"array","description":"The line items purchased by the customer.","title":"Line Items","readOnly":true,"items":{"$ref":"#/definitions/LineItem"}},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"merchantReference":{"type":"string","description":"The merchant's reference used to identify the transaction.","title":"Merchant Reference","readOnly":true,"maxLength":100},"metaData":{"type":"object","description":"Allow to store additional information about the object.","title":"Meta Data","readOnly":true,"additionalProperties":{"type":"string"}},"parent":{"type":"integer","format":"int64","description":"The parent transaction which was (partially) replaced by this transaction.","title":"Parent","readOnly":true},"paymentConnectorConfiguration":{"description":"The payment connector configuration that was used to authorize the transaction.","title":"Payment Connector Configuration","readOnly":true,"$ref":"#/definitions/PaymentConnectorConfiguration"},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"processingOn":{"type":"string","format":"date-time","description":"The date and time when the processing of the transaction was started.","title":"Processing On","readOnly":true},"refundedAmount":{"type":"number","description":"The total amount that was refunded, in the transaction's currency.","title":"Refunded Amount","readOnly":true},"screenColorDepth":{"type":"string","description":"The screen color depth of the customer's web browser.","title":"Screen Color Depth","readOnly":true},"screenHeight":{"type":"string","description":"The screen height of the customer's web browser.","title":"Screen Height","readOnly":true},"screenWidth":{"type":"string","description":"The screen width of the customer's web browser.","title":"Screen Width","readOnly":true},"shippingAddress":{"description":"The address to where the order will be shipped.","title":"Shipping Address","readOnly":true,"$ref":"#/definitions/Address"},"shippingMethod":{"type":"string","description":"The name of the shipping method used to ship the products.","title":"Shipping Method","readOnly":true,"maxLength":200},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","title":"Space View ID","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/TransactionState"},"successUrl":{"type":"string","description":"The URL to redirect the customer back to after they successfully authenticated their payment.","title":"Success Url","readOnly":true,"minLength":9,"maxLength":2000},"terminal":{"description":"The payment terminal through which the payment was processed.","title":"Terminal","readOnly":true,"$ref":"#/definitions/PaymentTerminal"},"timeZone":{"type":"string","description":"The customer's time zone, which affects how dates and times are formatted when communicating with the customer.","title":"Time Zone","readOnly":true},"token":{"description":"The payment token that should be used to charge the customer.","title":"Token","readOnly":true,"$ref":"#/definitions/Token"},"tokenizationMode":{"description":"The tokenization mode specifies whether and how the tokenization of payment information is applied to the transaction.","title":"Tokenization Mode","readOnly":true,"$ref":"#/definitions/TokenizationMode"},"totalAppliedFees":{"type":"number","description":"The total of all fees charged, in the transaction's currency.","title":"Total Applied Fees","readOnly":true},"totalSettledAmount":{"type":"number","description":"The total amount that was settled, in the transaction's currency.","title":"Total Settled Amount","readOnly":true},"userAgentHeader":{"type":"string","description":"The 'User Agent' header of the customer's web browser.","title":"User Agent Header","readOnly":true},"userFailureMessage":{"type":"string","description":"The message that can be displayed to the customer explaining why the transaction failed, in the customer's language.","title":"User Failure Message","readOnly":true},"userInterfaceType":{"description":"The type of user interface the customer used to provide the payment information.","title":"User Interface Type","readOnly":true,"$ref":"#/definitions/TransactionUserInterfaceType"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true},"windowHeight":{"type":"string","description":"The window height of the customer's web browser.","title":"Window Height","readOnly":true},"windowWidth":{"type":"string","description":"The window width of the customer's web browser.","title":"Window Width","readOnly":true},"yearsToKeep":{"type":"integer","format":"int32","description":"The number of years the transaction is kept after its authorization.","title":"Years To Keep","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transaction"},"title":"Transaction","description":"","x-model-behavior":"READ"},"Transaction.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transaction_create"},"title":"Transaction","allOf":[{"$ref":"#/definitions/Abstract.Transaction.Pending"},{"type":"object","required":["lineItems"],"properties":{"autoConfirmationEnabled":{"type":"boolean","description":"Whether the transaction can be confirmed automatically or whether this must be done explicitly via the API. Default is true.","title":"Auto Confirmation Enabled"},"billingAddress":{"description":"The address associated with the payment method for invoicing and transaction processing purposes.","title":"Billing Address","$ref":"#/definitions/Address.Create"},"chargeRetryEnabled":{"type":"boolean","description":"Whether the customer can make further payment attempts if the first one has failed. Default is true.","title":"Charge Retry Enabled"},"customersPresence":{"description":"The customer's presence indicates whether and in what way the transaction's customer is present. Default is VIRTUAL_PRESENT.","title":"Customers Presence","$ref":"#/definitions/CustomersPresence"},"deviceSessionIdentifier":{"type":"string","description":"Allows to link the transaction to the data collected from the customer's device.","title":"Device Session Identifier","minLength":10,"maxLength":40},"emailsDisabled":{"type":"boolean","description":"Whether email sending is deactivated for the transaction. Default is false.","title":"Emails Disabled"},"environment":{"description":"The environment used when rendering resources.","title":"Environment","$ref":"#/definitions/Environment"},"environmentSelectionStrategy":{"description":"The strategy for determining whether the transaction is to be processed in the test or production environment.","title":"Environment Selection Strategy","$ref":"#/definitions/TransactionEnvironmentSelectionStrategy"},"lineItems":{"type":"array","description":"The line items purchased by the customer.","title":"Line Items","items":{"$ref":"#/definitions/LineItem.Create"}},"shippingAddress":{"description":"The address to where the order will be shipped.","title":"Shipping Address","$ref":"#/definitions/Address.Create"},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","title":"Space View ID"},"token":{"type":"integer","format":"int64","description":"The payment token that should be used to charge the customer.","title":"Token"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transaction_create"},"title":"Transaction","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"Transaction.Pending":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transaction_pending"},"title":"Transaction","allOf":[{"$ref":"#/definitions/Abstract.Transaction.Pending"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transaction_pending"},"title":"Transaction","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"},"TransactionComment":{"type":"object","properties":{"content":{"type":"string","description":"The comment's actual content.","title":"Content","readOnly":true,"maxLength":262144},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"editedBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was last updated by.","title":"Edited By","readOnly":true},"editedOn":{"type":"string","format":"date-time","description":"The date and time when the comment was last updated.","title":"Edited On","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"pinned":{"type":"boolean","description":"Whether the comment is pinned to the top.","title":"Pinned","readOnly":true},"transaction":{"type":"integer","format":"int64","description":"The transaction that the comment belongs to.","title":"Transaction","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioncomment"},"title":"Transaction Comment","description":"","x-model-behavior":"READ"},"TransactionComment.Active":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioncomment_active"},"title":"Comment","allOf":[{"$ref":"#/definitions/Abstract.TransactionComment.Active"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioncomment_active"},"title":"Comment","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"},"TransactionComment.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioncomment_create"},"title":"Comment","allOf":[{"$ref":"#/definitions/Abstract.TransactionComment.Active"},{"type":"object","required":["transaction"],"properties":{"transaction":{"type":"integer","format":"int64","description":"The transaction that the comment belongs to.","title":"Transaction"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioncomment_create"},"title":"Comment","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"TransactionCompletion":{"type":"object","properties":{"amount":{"type":"number","description":"The total amount to be captured in this completion, including taxes.","title":"Amount","readOnly":true},"baseLineItems":{"type":"array","description":"The original line items from the transaction that serve as the baseline for this completion.","title":"Base Line Items","readOnly":true,"items":{"$ref":"#/definitions/LineItem"}},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the transaction completion was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID","readOnly":true,"minLength":1,"maxLength":100},"failedOn":{"type":"string","format":"date-time","description":"The date and time when the transaction completion failed.","title":"Failed On","readOnly":true},"failureReason":{"description":"The reason for the failure of the transaction completion.","title":"Failure Reason","readOnly":true,"$ref":"#/definitions/FailureReason"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"invoiceMerchantReference":{"type":"string","description":"The merchant's reference used to identify the invoice.","title":"Invoice Merchant Reference","readOnly":true,"maxLength":100},"labels":{"type":"array","description":"The labels providing additional information about the object.","title":"Labels","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/Label"}},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language","readOnly":true},"lastCompletion":{"type":"boolean","description":"Whether this is the final completion for the transaction. After the last completion is successfully created, the transaction enters its final state, and no further completions can occur.","title":"Last Completion","readOnly":true},"lineItemVersion":{"description":"The specific version of the line items that are being used for this completion.","title":"Line Item Version","readOnly":true,"$ref":"#/definitions/TransactionLineItemVersion"},"lineItems":{"type":"array","description":"The line items captured in this transaction completion.","title":"Line Items","readOnly":true,"items":{"$ref":"#/definitions/LineItem"}},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","title":"Linked Transaction","readOnly":true},"metaData":{"type":"object","description":"Allow to store additional information about the object.","title":"Meta Data","readOnly":true,"additionalProperties":{"type":"string"}},"mode":{"description":"The mode of transaction completion, such as online or offline, determining how the completion process is executed.","title":"Mode","readOnly":true,"$ref":"#/definitions/TransactionCompletionMode"},"nextUpdateOn":{"type":"string","format":"date-time","description":"The date and time when the next update of the object's state is planned.","title":"Next Update On","readOnly":true},"paymentInformation":{"type":"string","description":"Payment-specific details related to this transaction completion such as payment instructions or references needed for processing.","title":"Payment Information","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"processingOn":{"type":"string","format":"date-time","description":"The date and time when the processing of the transaction completion was started.","title":"Processing On","readOnly":true},"processorReference":{"type":"string","description":"The reference ID provided by the payment processor, used to trace the completion through the external payment system.","title":"Processor Reference","readOnly":true},"remainingLineItems":{"type":"array","description":"The line items yet to be captured in the transaction.","title":"Remaining Line Items","readOnly":true,"items":{"$ref":"#/definitions/LineItem"}},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","title":"Space View ID","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/TransactionCompletionState"},"statementDescriptor":{"type":"string","description":"The statement descriptor that appears on a customer's bank statement, providing an explanation for charges or payments, helping customers identify the transaction.","title":"Statement Descriptor","readOnly":true,"maxLength":80},"succeededOn":{"type":"string","format":"date-time","description":"The date and time when the transaction completion succeeded.","title":"Succeeded On","readOnly":true},"taxAmount":{"type":"number","description":"The portion of the captured amount that corresponds to taxes.","title":"Tax Amount","readOnly":true},"timeZone":{"type":"string","description":"The time zone that this object is associated with.","title":"Time Zone","readOnly":true},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the object will expire.","title":"Timeout On","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioncompletion"},"title":"Completion","description":"","x-model-behavior":"READ"},"TransactionCompletionBehavior":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioncompletionbehavior"},"title":"Transaction Completion Behavior","description":"","enum":["COMPLETE_IMMEDIATELY","COMPLETE_DEFERRED","USE_CONFIGURATION"],"x-model-behavior":"ENUM"},"TransactionCompletionMode":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioncompletionmode"},"title":"Transaction Completion Mode","description":"","enum":["DIRECT","ONLINE","OFFLINE"],"x-model-behavior":"ENUM"},"TransactionCompletionRequest":{"type":"object","required":["externalId","lastCompletion","transactionId"],"properties":{"externalId":{"type":"string","description":"The external ID helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.","title":"External ID","minLength":1,"maxLength":100},"invoiceMerchantReference":{"type":"string","description":"","title":"Invoice Merchant Reference","maxLength":100},"lastCompletion":{"type":"boolean","description":"The last completion flag indicates if this is the last completion. After the last completion is created no further completions can be issued.","title":"Last Completion"},"lineItems":{"type":"array","description":"The line items which will be used to complete the transaction.","title":"Line Items","items":{"$ref":"#/definitions/CompletionLineItem.Create"}},"metaData":{"type":"object","description":"","title":"Meta Data","additionalProperties":{"type":"string"}},"statementDescriptor":{"type":"string","description":"The statement descriptor that appears on a customer's bank statement, providing an explanation for charges or payments, helping customers identify the transaction.","title":"Statement Descriptor","maxLength":80},"transactionId":{"type":"integer","format":"int64","description":"The ID of the transaction which should be completed.","title":"Transaction ID"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioncompletionrequest"},"title":"Transaction Completion Request","description":"","x-model-behavior":"CREATE"},"TransactionCompletionState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioncompletionstate"},"title":"Transaction Completion State","description":"","enum":["CREATE","SCHEDULED","PENDING","FAILED","SUCCESSFUL"],"x-model-behavior":"ENUM"},"TransactionEnvironmentSelectionStrategy":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactionenvironmentselectionstrategy"},"title":"Transaction Environment Selection Strategy","description":"","enum":["FORCE_TEST_ENVIRONMENT","FORCE_PRODUCTION_ENVIRONMENT","USE_CONFIGURATION"],"x-model-behavior":"ENUM"},"TransactionGroup":{"type":"object","properties":{"beginDate":{"type":"string","format":"date-time","description":"The date and time when the initial transaction in the group was created.","title":"Begin Date","readOnly":true},"customerId":{"type":"string","description":"The unique identifier of the customer in the external system.","title":"Customer ID","readOnly":true,"maxLength":100},"endDate":{"type":"string","format":"date-time","description":"The date and time when the final transaction in the group was last updated.","title":"End Date","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/TransactionGroupState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactiongroup"},"title":"Transaction Group","description":"","x-model-behavior":"READ"},"TransactionGroupState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactiongroupstate"},"title":"Transaction Group State","description":"","enum":["PENDING","FAILED","SUCCESSFUL"],"x-model-behavior":"ENUM"},"TransactionInvoice":{"type":"object","properties":{"amount":{"type":"number","description":"The total sum of all line items on the invoice, including taxes.","title":"Amount","readOnly":true},"billingAddress":{"description":"The address associated with the invoice, used for billing purposes.","title":"Billing Address","readOnly":true,"$ref":"#/definitions/Address"},"completion":{"description":"The transaction completion this object is linked to.","title":"Completion","readOnly":true,"$ref":"#/definitions/TransactionCompletion"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"derecognizedBy":{"type":"integer","format":"int64","description":"The ID of the user the invoice was derecognized by.","title":"Derecognized By","readOnly":true},"derecognizedOn":{"type":"string","format":"date-time","description":"The date and time when the invoice was derecognized, meaning it is no longer considered outstanding or valid in the system.","title":"Derecognized On","readOnly":true},"dueOn":{"type":"string","format":"date-time","description":"The due date for payment of the invoice.","title":"Due On","readOnly":true},"environment":{"description":"The environment used when rendering resources.","title":"Environment","readOnly":true,"$ref":"#/definitions/Environment"},"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID","readOnly":true,"minLength":1,"maxLength":100},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language","readOnly":true},"lineItems":{"type":"array","description":"The invoiced line items that will appear on the invoice document.","title":"Line Items","readOnly":true,"items":{"$ref":"#/definitions/LineItem"}},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","title":"Linked Transaction","readOnly":true},"merchantReference":{"type":"string","description":"The merchant's reference used to identify the invoice.","title":"Merchant Reference","readOnly":true,"maxLength":100},"outstandingAmount":{"type":"number","description":"The remaining amount the buyer owes to the merchant. A negative value indicates the invoice has been overpaid.","title":"Outstanding Amount","readOnly":true},"paidOn":{"type":"string","format":"date-time","description":"The date and time when the invoice was recorded as paid. May differ from the actual payment date due to processing delays.","title":"Paid On","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","title":"Space View ID","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/TransactionInvoiceState"},"taxAmount":{"type":"number","description":"The portion of the invoiced amount that corresponds to taxes.","title":"Tax Amount","readOnly":true},"timeZone":{"type":"string","description":"The time zone that this object is associated with.","title":"Time Zone","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioninvoice"},"title":"Invoice","description":"","x-model-behavior":"READ"},"TransactionInvoiceComment":{"type":"object","properties":{"content":{"type":"string","description":"The comment's actual content.","title":"Content","readOnly":true,"maxLength":262144},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"editedBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was last updated by.","title":"Edited By","readOnly":true},"editedOn":{"type":"string","format":"date-time","description":"The date and time when the comment was last updated.","title":"Edited On","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"pinned":{"type":"boolean","description":"Whether the comment is pinned to the top.","title":"Pinned","readOnly":true},"transactionInvoice":{"type":"integer","format":"int64","description":"The transaction invoice that the comment belongs to.","title":"Transaction Invoice","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioninvoicecomment"},"title":"Invoice Comment","description":"","x-model-behavior":"READ"},"TransactionInvoiceComment.Active":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioninvoicecomment_active"},"title":"Comment","allOf":[{"$ref":"#/definitions/Abstract.TransactionInvoiceComment.Active"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioninvoicecomment_active"},"title":"Comment","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"},"TransactionInvoiceComment.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioninvoicecomment_create"},"title":"Comment","allOf":[{"$ref":"#/definitions/Abstract.TransactionInvoiceComment.Active"},{"type":"object","required":["transactionInvoice"],"properties":{"transactionInvoice":{"type":"integer","format":"int64","description":"The transaction invoice that the comment belongs to.","title":"Transaction Invoice"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioninvoicecomment_create"},"title":"Comment","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"TransactionInvoiceReplacement":{"type":"object","required":["externalId","lineItems"],"properties":{"billingAddress":{"description":"The address associated with the invoice, used for billing purposes.","title":"Billing Address","$ref":"#/definitions/Address.Create"},"dueOn":{"type":"string","format":"date-time","description":"The due date for payment of the invoice.","title":"Due On"},"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID","minLength":1,"maxLength":100},"lineItems":{"type":"array","description":"The invoiced line items that will appear on the invoice document.","title":"Line Items","items":{"$ref":"#/definitions/LineItem.Create"}},"merchantReference":{"type":"string","description":"The merchant's reference used to identify the invoice.","title":"Merchant Reference","maxLength":100},"sentToCustomer":{"type":"boolean","description":"Whether the invoice will be sent to the customer via email.","title":"Sent To Customer"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioninvoicereplacement"},"title":"Invoice Replacement","description":"","x-model-behavior":"CREATE"},"TransactionInvoiceState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactioninvoicestate"},"title":"Transaction Invoice State","description":"","enum":["CREATE","OPEN","OVERDUE","CANCELED","PAID","DERECOGNIZED","NOT_APPLICABLE"],"x-model-behavior":"ENUM"},"TransactionLineItemVersion":{"type":"object","properties":{"amount":{"type":"number","description":"The total amount of the updated line items, including taxes.","title":"Amount","readOnly":true},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the line item version was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID","readOnly":true},"failedOn":{"type":"string","format":"date-time","description":"The date and time when the processing of the line item version failed.","title":"Failed On","readOnly":true},"failureReason":{"description":"","title":"Failure Reason","readOnly":true,"$ref":"#/definitions/FailureReason"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"labels":{"type":"array","description":"The labels providing additional information about the object.","title":"Labels","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/Label"}},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language","readOnly":true},"lineItems":{"type":"array","description":"The line items that replace the original line items in the transaction.","title":"Line Items","readOnly":true,"items":{"$ref":"#/definitions/LineItem"}},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","title":"Linked Transaction","readOnly":true},"nextUpdateOn":{"type":"string","format":"date-time","description":"The date and time when the next update of the line item version's state is planned.","title":"Next Update On","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"processingOn":{"type":"string","format":"date-time","description":"The date and time when the processing of the line item version was started.","title":"Processing On","readOnly":true},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","title":"Space View ID","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/TransactionLineItemVersionState"},"succeededOn":{"type":"string","format":"date-time","description":"The date and time when the line item version was processed successfully.","title":"Succeeded On","readOnly":true},"taxAmount":{"type":"number","description":"The portion of the total amount that corresponds to taxes.","title":"Tax Amount","readOnly":true},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time by when the line item version is expected to be processed.","title":"Timeout On","readOnly":true},"transaction":{"description":"The transaction that the line item version belongs to.","title":"Transaction","readOnly":true,"$ref":"#/definitions/Transaction"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactionlineitemversion"},"title":"Line Item Version","description":"","x-model-behavior":"READ"},"TransactionLineItemVersion.Create":{"type":"object","required":["externalId","lineItems","transaction"],"properties":{"externalId":{"type":"string","description":"A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.","title":"External ID"},"lineItems":{"type":"array","description":"The line items that replace the original line items in the transaction.","title":"Line Items","items":{"$ref":"#/definitions/LineItem.Create"}},"transaction":{"type":"integer","format":"int64","description":"The transaction that the line item version belongs to.","title":"Transaction"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactionlineitemversion_create"},"title":"Line Item Version","description":"","x-model-behavior":"CREATE"},"TransactionLineItemVersionState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactionlineitemversionstate"},"title":"Transaction Line Item Version State","description":"","enum":["CREATE","SCHEDULED","PENDING","SUCCESSFUL","FAILED"],"x-model-behavior":"ENUM"},"TransactionProjection":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactionprojection"},"title":"Transaction Projection","allOf":[{"$ref":"#/definitions/Transaction"},{"type":"object","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactionprojection"},"title":"Transaction Projection","description":"","x-model-behavior":"READ"}],"description":"","x-model-behavior":"READ"},"TransactionState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactionstate"},"title":"Transaction State","description":"","enum":["CREATE","PENDING","CONFIRMED","PROCESSING","FAILED","AUTHORIZED","VOIDED","COMPLETED","FULFILL","DECLINE"],"x-model-behavior":"ENUM"},"TransactionUserInterfaceType":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactionuserinterfacetype"},"title":"Transaction User Interface Type","description":"","enum":["IFRAME","LIGHTBOX","PAYMENT_PAGE","MOBILE_SDK","TERMINAL","CLOUD_TILL_INTERFACE","EXPRESS_CHECKOUT"],"x-model-behavior":"ENUM"},"TransactionVoid":{"type":"object","properties":{"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the transaction void was created by.","title":"Created By","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","title":"Created On","readOnly":true},"failedOn":{"type":"string","format":"date-time","description":"The date and time when the transaction void failed.","title":"Failed On","readOnly":true},"failureReason":{"description":"The reason for the failure of the transaction void.","title":"Failure Reason","readOnly":true,"$ref":"#/definitions/FailureReason"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"labels":{"type":"array","description":"The labels providing additional information about the object.","title":"Labels","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/Label"}},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","title":"Linked Transaction","readOnly":true},"mode":{"description":"The mode of transaction void, such as online or offline, determining how the void process is executed.","title":"Mode","readOnly":true,"$ref":"#/definitions/TransactionVoidMode"},"nextUpdateOn":{"type":"string","format":"date-time","description":"The date and time when the next update of the object's state is planned.","title":"Next Update On","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"processorReference":{"type":"string","description":"The reference ID provided by the payment processor, used to trace the void through the external payment system.","title":"Processor Reference","readOnly":true},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","title":"Space View ID","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/TransactionVoidState"},"succeededOn":{"type":"string","format":"date-time","description":"The date and time when the transaction void succeeded.","title":"Succeeded On","readOnly":true},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the object will expire.","title":"Timeout On","readOnly":true},"transaction":{"description":"The transaction that the void belongs to.","title":"Transaction","readOnly":true,"$ref":"#/definitions/Transaction"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactionvoid"},"title":"Transaction Void","description":"","x-model-behavior":"READ"},"TransactionVoidMode":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactionvoidmode"},"title":"Transaction Void Mode","description":"","enum":["ONLINE","OFFLINE"],"x-model-behavior":"ENUM"},"TransactionVoidState":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_transactionvoidstate"},"title":"Transaction Void State","description":"","enum":["CREATE","PENDING","FAILED","SUCCESSFUL"],"x-model-behavior":"ENUM"},"TwoFactorAuthenticationType":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"feature":{"type":"integer","format":"int64","description":"The feature that this type belongs to.","title":"Feature","readOnly":true},"icon":{"type":"string","description":"The identifier of the icon representing this type.","title":"Icon","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_twofactorauthenticationtype"},"title":"Two Factor Authentication Type","description":"","x-model-behavior":"READ"},"User":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"scope":{"type":"integer","format":"int64","description":"The scope that the user belongs to.","title":"Scope","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"userType":{"description":"The user's type which defines its role and capabilities.","title":"User Type","readOnly":true,"$ref":"#/definitions/UserType"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_user"},"title":"User","description":"","x-model-behavior":"READ"},"UserAccountRole":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_useraccountrole"},"title":"User Account Role","allOf":[{"$ref":"#/definitions/UserRole"},{"type":"object","properties":{"account":{"type":"integer","format":"int64","description":"The account in which the role is assigned to the user.","title":"Account","readOnly":true},"appliesOnSubAccount":{"type":"boolean","description":"Whether the role is assigned to the user in subaccounts only.","title":"Applies On Sub Account","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_useraccountrole"},"title":"User Account Role","description":"","x-model-behavior":"READ"}],"description":"","x-model-behavior":"READ"},"UserRole":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"role":{"type":"integer","format":"int64","description":"The role that is assigned to the user.","title":"Role","readOnly":true},"user":{"type":"integer","format":"int64","description":"The user whose role this defines.","title":"User","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_userrole"},"title":"User Role","description":"","x-model-behavior":"READ"},"UserSpaceRole":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_userspacerole"},"title":"User Space Role","allOf":[{"$ref":"#/definitions/UserRole"},{"type":"object","properties":{"space":{"type":"integer","format":"int64","description":"The space in which the role is assigned to the user.","title":"Space","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_userspacerole"},"title":"User Space Role","description":"","x-model-behavior":"READ"}],"description":"","x-model-behavior":"READ"},"UserType":{"type":"string","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_usertype"},"title":"User Type","description":"","enum":["HUMAN_USER","SINGLE_SIGNON_USER","APPLICATION_USER","ANONYMOUS_USER","SERVER_USER"],"x-model-behavior":"ENUM"},"WalletType":{"type":"object","properties":{"description":{"type":"object","description":"The localized description of the object.","title":"Description","readOnly":true,"additionalProperties":{"type":"string"}},"expressCheckoutSupported":{"type":"boolean","description":"","title":"Express Checkout Supported","readOnly":true},"feature":{"description":"","title":"Feature","readOnly":true,"$ref":"#/definitions/Feature"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The localized name of the object.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}},"navigationPath":{"type":"string","description":"","title":"Navigation Path","readOnly":true},"requiredFeatures":{"type":"array","description":"","title":"Required Features","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/Feature"}},"sortOrder":{"type":"integer","format":"int32","description":"","title":"Sort Order","readOnly":true},"standardCheckoutSupported":{"type":"boolean","description":"","title":"Standard Checkout Supported","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_wallettype"},"title":"Wallet Type","description":"","x-model-behavior":"READ"},"WebAppConfirmationRequest":{"type":"object","properties":{"code":{"type":"string","description":"The user returns to the web app after granting the permission. The HTTP request contains the code. Provide it here to confirm the web app installation.","title":"Code","maxLength":100}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webappconfirmationrequest"},"title":"Web App Confirmation Request","description":"","x-model-behavior":"UPDATE"},"WebAppConfirmationResponse":{"type":"object","properties":{"access_token":{"type":"string","description":"The access code granting permissions to the web service API according to the OAuth standard.","title":"Access _ token","readOnly":true},"scope":{"type":"string","description":"The list of the permissions granted to the web app within the space.","title":"Scope","readOnly":true},"space":{"description":"The space that the web app was installed in.","title":"Space","readOnly":true,"$ref":"#/definitions/Space"},"state":{"type":"string","description":"The state parameter that was provided in the authorization request.","title":"State","readOnly":true},"token_type":{"type":"string","description":"The type of the access token that determines the authentication mechanism to use for accessing the web service API.","title":"Token _ type","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webappconfirmationresponse"},"title":"Web App Confirmation Response","description":"The confirmation response provides details about the installation of the web app.","x-model-behavior":"READ"},"WebhookEncryptionPublicKey":{"type":"object","properties":{"id":{"type":"string","description":"The ID of encryption key","title":"ID","readOnly":true},"publicKey":{"type":"string","description":"The BASE64 encoded public key","title":"Public Key","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webhookencryptionpublickey"},"title":"Webhook Encryption Public Key","description":"The webhook encryption public key is used to verify the webhook content signature.","x-model-behavior":"READ"},"WebhookIdentity":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the webhook identity.","title":"Name","readOnly":true,"maxLength":50},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webhookidentity"},"title":"Webhook Identity","description":"The webhook identity represents a set of keys that will be used to sign the webhook messages.","x-model-behavior":"READ"},"WebhookListener":{"type":"object","properties":{"enablePayloadSignatureAndState":{"type":"boolean","description":"Whether signature header and 'state' property are enabled in webhook payload.","title":"Enable Payload Signature And State","readOnly":true},"entity":{"type":"integer","format":"int64","description":"The entity that is to be monitored.","title":"Entity","readOnly":true},"entityStates":{"type":"array","description":"The entity's target states that are to be monitored.","title":"Entity States","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"identity":{"description":"The identity used to sign messages.","title":"Identity","readOnly":true,"$ref":"#/definitions/WebhookIdentity"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the webhook listener.","title":"Name","readOnly":true,"maxLength":50},"notifyEveryChange":{"type":"boolean","description":"Whether every update of the entity or only state changes are to be monitored.","title":"Notify Every Change","readOnly":true},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"url":{"description":"The URL where notifications about entity changes are sent to.","title":"Url","readOnly":true,"$ref":"#/definitions/WebhookUrl"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webhooklistener"},"title":"Webhook Listener","description":"","x-model-behavior":"READ"},"WebhookListener.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webhooklistener_create"},"title":"Webhook Listener","allOf":[{"$ref":"#/definitions/Abstract.WebhookListener.Update"},{"type":"object","required":["entity","url"],"properties":{"entity":{"type":"integer","format":"int64","description":"The entity that is to be monitored.","title":"Entity"},"identity":{"type":"integer","format":"int64","description":"The identity used to sign messages.","title":"Identity"},"url":{"type":"integer","format":"int64","description":"The URL where notifications about entity changes are sent to.","title":"Url"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webhooklistener_create"},"title":"Webhook Listener","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"WebhookListener.Update":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webhooklistener_update"},"title":"Webhook Listener","allOf":[{"$ref":"#/definitions/Abstract.WebhookListener.Update"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webhooklistener_update"},"title":"Webhook Listener","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"},"WebhookListenerEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"name":{"type":"object","description":"The name used to identify the webhook listener entity.","title":"Name","readOnly":true,"additionalProperties":{"type":"string"}},"technicalName":{"type":"string","description":"The name used to programmatically identify the webhook listener entity.","title":"Technical Name","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webhooklistenerentity"},"title":"Webhook Listener Entity","description":"","x-model-behavior":"READ"},"WebhookUrl":{"type":"object","properties":{"applicationManaged":{"type":"boolean","description":"Whether the webhook URL is managed by the application, and therefore cannot be changed via the user interface.","title":"Application Managed","readOnly":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","title":"ID","readOnly":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","title":"Linked Space ID","readOnly":true},"name":{"type":"string","description":"The name used to identify the webhook URL.","title":"Name","readOnly":true,"maxLength":50},"plannedPurgeDate":{"type":"string","format":"date-time","description":"The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.","title":"Planned Purge Date","readOnly":true},"state":{"description":"The object's current state.","title":"State","readOnly":true,"$ref":"#/definitions/CreationEntityState"},"url":{"type":"string","description":"The actual URL where notifications about entity changes are sent to.","title":"Url","readOnly":true,"minLength":9,"maxLength":500},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","title":"Version","readOnly":true}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webhookurl"},"title":"Webhook URL","description":"","x-model-behavior":"READ"},"WebhookUrl.Create":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webhookurl_create"},"title":"Webhook URL","allOf":[{"$ref":"#/definitions/Abstract.WebhookUrl.Update"},{"type":"object","externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webhookurl_create"},"title":"Webhook URL","description":"","x-model-behavior":"CREATE"}],"description":"","x-model-behavior":"CREATE"},"WebhookUrl.Update":{"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webhookurl_update"},"title":"Webhook URL","allOf":[{"$ref":"#/definitions/Abstract.WebhookUrl.Update"},{"type":"object","required":["id","version"],"properties":{"id":{"type":"integer","format":"int64","description":"The ID is the primary key of the entity. The ID identifies the entity uniquely.","title":"Id"},"version":{"type":"integer","format":"int64","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"externalDocs":{"description":"For more information visit this link.","url":"https://weareplanet-preprod.app-wallee.com/doc/api/web-service/v1#_webhookurl_update"},"title":"Webhook URL","description":"","x-model-behavior":"UPDATE"}],"description":"","x-model-behavior":"UPDATE"}}}