{"openapi":"3.0.1","info":{"title":"Secupay API","description":"The Secupay API allows to create integrations, retrieve data and automate workflows.","version":"2.0"},"servers":[{"url":"https://shopportal.secupay.com/api/v2.0"}],"security":[{"macAuth":[]},{"jwtAuth":[]},{"cookieAuth":[]}],"tags":[{"name":"Accounts","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#accounts-service"}},{"name":"ApplicationUsers","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#application-users-service"}},{"name":"ApplicationUsersRoles","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#application-users-roles-service"}},{"name":"ChargeAttempts","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#charge-attempts-service"}},{"name":"ChargeFlowLevels","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#charge-flow-levels-service"}},{"name":"ChargeFlows","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#charge-flows-service"}},{"name":"ChargeFlowsLevelPaymentLinks","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#charge-flows-level-payment-links-service"}},{"name":"ConditionTypes","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#condition-types-service"}},{"name":"Countries","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#countries-service"}},{"name":"Currencies","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#currencies-service"}},{"name":"CustomerAddresses","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#customer-addresses-service"}},{"name":"CustomerComments","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#customer-comments-service"}},{"name":"Customers","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#customers-service"}},{"name":"DeliveryIndications","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#delivery-indications-service"}},{"name":"DocumentTemplateTypes","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#document-template-types-service"}},{"name":"DocumentTemplates","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#document-templates-service"}},{"name":"DunningCases","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#dunning-cases-service"}},{"name":"DunningFlowLevels","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#dunning-flow-levels-service"}},{"name":"DunningFlows","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#dunning-flows-service"}},{"name":"HumanUsers","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#human-users-service"}},{"name":"HumanUsersRoles","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#human-users-roles-service"}},{"name":"LabelDescriptors","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#label-descriptors-service"}},{"name":"Languages","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#languages-service"}},{"name":"LegalOrganizationForms","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#legal-organization-forms-service"}},{"name":"ManualTasks","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#manual-tasks-service"}},{"name":"PaymentConnectorConfigurations","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#payment-connector-configurations-service"}},{"name":"PaymentConnectors","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#payment-connectors-service"}},{"name":"PaymentMethodBrands","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#payment-method-brands-service"}},{"name":"PaymentMethodConfigurations","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#payment-method-configurations-service"}},{"name":"PaymentMethods","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#payment-methods-service"}},{"name":"PaymentProcessorConfigurations","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#payment-processor-configurations-service"}},{"name":"PaymentProcessors","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#payment-processors-service"}},{"name":"PaymentSalesChannels","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#payment-sales-channels-service"}},{"name":"PaymentWebApps","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#payment-web-apps-service"}},{"name":"Permissions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#permissions-service"}},{"name":"RefundComments","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#refund-comments-service"}},{"name":"Refunds","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#refunds-service"}},{"name":"Roles","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#roles-service"}},{"name":"SingleSignOnUsers","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#single-sign-on-users-service"}},{"name":"SingleSignOnUsersRoles","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#single-sign-on-users-roles-service"}},{"name":"Spaces","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#spaces-service"}},{"name":"StaticValues","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#static-values-service"}},{"name":"TokenVersions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#token-versions-service"}},{"name":"Tokens","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#tokens-service"}},{"name":"TransactionClientPlatforms","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#transaction-client-platforms-service"}},{"name":"TransactionComments","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#transaction-comments-service"}},{"name":"TransactionCompletions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#transaction-completions-service"}},{"name":"TransactionInvoiceComments","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#transaction-invoice-comments-service"}},{"name":"TransactionInvoices","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#transaction-invoices-service"}},{"name":"TransactionLineItemVersions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#transaction-line-item-versions-service"}},{"name":"TransactionVoids","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#transaction-voids-service"}},{"name":"Transactions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#transactions-service"}},{"name":"WebApps","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#web-apps-service"}},{"name":"WebhookEncryptionKeys","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#webhook-encryption-keys-service"}},{"name":"WebhookListeners","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#webhook-listeners-service"}},{"name":"WebhookURLs","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#webhook-u-r-ls-service"}}],"paths":{"/accounts/{id}":{"get":{"tags":["Accounts"],"summary":"Retrieve an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getAccountsId"},"operationId":"getAccountsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["Accounts"],"summary":"Delete an account","description":"Permanently deletes an account. It cannot be undone.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteAccountsId"},"operationId":"deleteAccountsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["Accounts"],"summary":"Update an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchAccountsId"},"operationId":"patchAccountsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account.Update"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/accounts":{"get":{"tags":["Accounts"],"summary":"List all accounts","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getAccounts"},"operationId":"getAccounts","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Account"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Account List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["Accounts"],"summary":"Create an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postAccounts"},"operationId":"postAccounts","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/accounts/search":{"get":{"tags":["Accounts"],"summary":"Search accounts","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getAccountsSearch"},"operationId":"getAccountsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Account"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Account Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/accounts/{id}/activate":{"post":{"tags":["Accounts"],"summary":"Activate an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postAccountsIdActivate"},"operationId":"postAccountsIdActivate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/accounts/{id}/deactivate":{"post":{"tags":["Accounts"],"summary":"Deactivate an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postAccountsIdDeactivate"},"operationId":"postAccountsIdDeactivate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/application-users/{id}":{"get":{"tags":["ApplicationUsers"],"summary":"Retrieve an application user","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getApplicationUsersId"},"operationId":"getApplicationUsersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUser"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["ApplicationUsers"],"summary":"Delete an application user","description":"Permanently deletes a application user. It cannot be undone.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteApplicationUsersId"},"operationId":"deleteApplicationUsersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["ApplicationUsers"],"summary":"Update an application user","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchApplicationUsersId"},"operationId":"patchApplicationUsersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUser.Update"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUser"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/application-users/{userId}/keys/{id}":{"delete":{"tags":["ApplicationUsers"],"summary":"Deactivate an authentication key","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteApplicationUsersUserIdKeysId"},"operationId":"deleteApplicationUsersUserIdKeysId","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/application-users":{"get":{"tags":["ApplicationUsers"],"summary":"List all application users","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getApplicationUsers"},"operationId":"getApplicationUsers","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ApplicationUser"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Application User List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["ApplicationUsers"],"summary":"Create an application user","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postApplicationUsers"},"operationId":"postApplicationUsers","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUser.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUser.CreateWithMacKey"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/application-users/search":{"get":{"tags":["ApplicationUsers"],"summary":"Search application users","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getApplicationUsersSearch"},"operationId":"getApplicationUsersSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ApplicationUser"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Application User Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/application-users/{userId}/keys":{"get":{"tags":["ApplicationUsers"],"summary":"List a user's authentication keys","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getApplicationUsersUserIdKeys"},"operationId":"getApplicationUsersUserIdKeys","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestApplicationUserMacKey"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["ApplicationUsers"],"summary":"Generate a new authentication key","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postApplicationUsersUserIdKeys"},"operationId":"postApplicationUsersUserIdKeys","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApplicationUserMacKey.Created"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/application-users/{userId}/account-roles":{"get":{"tags":["ApplicationUsersRoles"],"summary":"List all roles of an application user for an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getApplicationUsersUserIdAccountRoles"},"operationId":"getApplicationUsersUserIdAccountRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"account","in":"header","description":"Specifies the ID of the account the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/UserAccountRole"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"User Account Role List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["ApplicationUsersRoles"],"summary":"Assign a role to an application user for an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postApplicationUsersUserIdAccountRoles"},"operationId":"postApplicationUsersUserIdAccountRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"roleId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"appliesOnSubAccount","in":"query","description":"Whether the role should be assigned to the user in subaccounts only.","schema":{"type":"boolean"}},{"name":"account","in":"header","description":"Specifies the ID of the account the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccountRole"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["ApplicationUsersRoles"],"summary":"Unassign a role from an application user for an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteApplicationUsersUserIdAccountRoles"},"operationId":"deleteApplicationUsersUserIdAccountRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"roleId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"account","in":"header","description":"Specifies the ID of the account the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/application-users/{userId}/space-roles":{"get":{"tags":["ApplicationUsersRoles"],"summary":"List all roles of an application user for a space","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getApplicationUsersUserIdSpaceRoles"},"operationId":"getApplicationUsersUserIdSpaceRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/UserSpaceRole"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"User Space Role List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["ApplicationUsersRoles"],"summary":"Assign a role to an application user for a space","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postApplicationUsersUserIdSpaceRoles"},"operationId":"postApplicationUsersUserIdSpaceRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"roleId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSpaceRole"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["ApplicationUsersRoles"],"summary":"Unassign a role from an application user for a space","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteApplicationUsersUserIdSpaceRoles"},"operationId":"deleteApplicationUsersUserIdSpaceRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"roleId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/charge-attempts":{"get":{"tags":["ChargeAttempts"],"summary":"List all charge attempts","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentChargeAttempts"},"operationId":"getPaymentChargeAttempts","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ChargeAttempt"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Charge Attempt List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/charge-attempts/{id}":{"get":{"tags":["ChargeAttempts"],"summary":"Retrieve a charge attempt","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentChargeAttemptsId"},"operationId":"getPaymentChargeAttemptsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeAttempt"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/charge-attempts/search":{"get":{"tags":["ChargeAttempts"],"summary":"Search charge attempts","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentChargeAttemptsSearch"},"operationId":"getPaymentChargeAttemptsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ChargeAttempt"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Charge Attempt Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/charge-flows/levels/payment-links":{"get":{"tags":["ChargeFlowsLevelPaymentLinks"],"summary":"List all charge flow payment links","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentChargeFlowsLevelsPaymentLinks"},"operationId":"getPaymentChargeFlowsLevelsPaymentLinks","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ChargeFlowLevelPaymentLink"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Charge Flow Level Payment Link List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/charge-flows/levels/payment-links/{id}":{"get":{"tags":["ChargeFlowsLevelPaymentLinks"],"summary":"Retrieve a charge flow payment link","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentChargeFlowsLevelsPaymentLinksId"},"operationId":"getPaymentChargeFlowsLevelsPaymentLinksId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeFlowLevelPaymentLink"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/charge-flows/levels/payment-links/search":{"get":{"tags":["ChargeFlowsLevelPaymentLinks"],"summary":"Search charge flow payment links","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentChargeFlowsLevelsPaymentLinksSearch"},"operationId":"getPaymentChargeFlowsLevelsPaymentLinksSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ChargeFlowLevelPaymentLink"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Charge Flow Level Payment Link Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/charge-flows/levels":{"get":{"tags":["ChargeFlowLevels"],"summary":"List all charge flow levels","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentChargeFlowsLevels"},"operationId":"getPaymentChargeFlowsLevels","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ChargeFlowLevel"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Charge Flow Level List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/charge-flows/levels/{id}":{"get":{"tags":["ChargeFlowLevels"],"summary":"Retrieve a charge flow level","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentChargeFlowsLevelsId"},"operationId":"getPaymentChargeFlowsLevelsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeFlowLevel"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/charge-flows/levels/search":{"get":{"tags":["ChargeFlowLevels"],"summary":"Search charge flow levels","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentChargeFlowsLevelsSearch"},"operationId":"getPaymentChargeFlowsLevelsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ChargeFlowLevel"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Charge Flow Level Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/charge-flows/levels/{id}/send-message":{"post":{"tags":["ChargeFlowLevels"],"summary":"Send a payment link","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentChargeFlowsLevelsIdSendMessage"},"operationId":"postPaymentChargeFlowsLevelsIdSendMessage","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/charge-flows":{"get":{"tags":["ChargeFlows"],"summary":"List all charge flows","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentChargeFlows"},"operationId":"getPaymentChargeFlows","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ChargeFlow"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Charge Flow List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/charge-flows/{id}":{"get":{"tags":["ChargeFlows"],"summary":"Retrieve a charge flow","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentChargeFlowsId"},"operationId":"getPaymentChargeFlowsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeFlow"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/charge-flows/search":{"get":{"tags":["ChargeFlows"],"summary":"Search charge flows","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentChargeFlowsSearch"},"operationId":"getPaymentChargeFlowsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ChargeFlow"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Charge Flow Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/condition-types":{"get":{"tags":["ConditionTypes"],"summary":"List all condition types.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentConditionTypes"},"operationId":"getPaymentConditionTypes","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ConditionType"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Condition Type List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/condition-types/{id}":{"get":{"tags":["ConditionTypes"],"summary":"Retrieve a condition type.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentConditionTypesId"},"operationId":"getPaymentConditionTypesId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConditionType"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/condition-types/search":{"get":{"tags":["ConditionTypes"],"summary":"Search condition types.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentConditionTypesSearch"},"operationId":"getPaymentConditionTypesSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ConditionType"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Condition Type Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/countries":{"get":{"tags":["Countries"],"summary":"List all countries","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCountries"},"operationId":"getCountries","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/RestCountry"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Country List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/countries/{code}":{"get":{"tags":["Countries"],"summary":"Retrieve a country","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCountriesCode"},"operationId":"getCountriesCode","parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestCountry"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/countries/{countryCode}/states":{"get":{"tags":["Countries"],"summary":"List all states for a country","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCountriesCountryCodeStates"},"operationId":"getCountriesCountryCodeStates","parameters":[{"name":"countryCode","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/RestCountryState"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"State List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/countries/search":{"get":{"tags":["Countries"],"summary":"Search countries","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCountriesSearch"},"operationId":"getCountriesSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/RestCountry"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Country Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/countries/states":{"get":{"tags":["Countries"],"summary":"List all country states","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCountriesStates"},"operationId":"getCountriesStates","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/RestCountryState"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"State List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/countries/states/{id}":{"get":{"tags":["Countries"],"summary":"Retrieve a country state","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCountriesStatesId"},"operationId":"getCountriesStatesId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestCountryState"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/currencies":{"get":{"tags":["Currencies"],"summary":"List all currencies","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCurrencies"},"operationId":"getCurrencies","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/RestCurrency"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Currency List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/currencies/{code}":{"get":{"tags":["Currencies"],"summary":"Retrieve a currency","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCurrenciesCode"},"operationId":"getCurrenciesCode","parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestCurrency"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/currencies/search":{"get":{"tags":["Currencies"],"summary":"Search currencies","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCurrenciesSearch"},"operationId":"getCurrenciesSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/RestCurrency"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Currency Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/{customerId}/addresses/{id}":{"get":{"tags":["CustomerAddresses"],"summary":"Retrieve a customer address","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCustomersCustomerIdAddressesId"},"operationId":"getCustomersCustomerIdAddressesId","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddress"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["CustomerAddresses"],"summary":"Delete a customer address","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteCustomersCustomerIdAddressesId"},"operationId":"deleteCustomersCustomerIdAddressesId","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["CustomerAddresses"],"summary":"Update a customer address","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchCustomersCustomerIdAddressesId"},"operationId":"patchCustomersCustomerIdAddressesId","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddress.Active"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddress"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/{customerId}/addresses":{"get":{"tags":["CustomerAddresses"],"summary":"List all customer addresses","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCustomersCustomerIdAddresses"},"operationId":"getCustomersCustomerIdAddresses","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/CustomerAddress"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Customer Address List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["CustomerAddresses"],"summary":"Create a customer address","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postCustomersCustomerIdAddresses"},"operationId":"postCustomersCustomerIdAddresses","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddress.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddress"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/{customerId}/addresses/search":{"get":{"tags":["CustomerAddresses"],"summary":"Search customer addresses","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCustomersCustomerIdAddressesSearch"},"operationId":"getCustomersCustomerIdAddressesSearch","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/CustomerAddress"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Customer Address Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/{customerId}/addresses/{id}/default":{"post":{"tags":["CustomerAddresses"],"summary":"Set the default address for a customer","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postCustomersCustomerIdAddressesIdDefault"},"operationId":"postCustomersCustomerIdAddressesIdDefault","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/{customerId}/comments/{id}":{"get":{"tags":["CustomerComments"],"summary":"Retrieve a customer comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCustomersCustomerIdCommentsId"},"operationId":"getCustomersCustomerIdCommentsId","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerComment"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["CustomerComments"],"summary":"Delete a customer comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteCustomersCustomerIdCommentsId"},"operationId":"deleteCustomersCustomerIdCommentsId","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["CustomerComments"],"summary":"Update a customer comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchCustomersCustomerIdCommentsId"},"operationId":"patchCustomersCustomerIdCommentsId","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerComment.Active"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerComment"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/{customerId}/comments":{"get":{"tags":["CustomerComments"],"summary":"List all customer comments","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCustomersCustomerIdComments"},"operationId":"getCustomersCustomerIdComments","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/CustomerComment"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Customer Comment List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["CustomerComments"],"summary":"Create a customer comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postCustomersCustomerIdComments"},"operationId":"postCustomersCustomerIdComments","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerComment.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerComment"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/{customerId}/comments/search":{"get":{"tags":["CustomerComments"],"summary":"Search customer comments","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCustomersCustomerIdCommentsSearch"},"operationId":"getCustomersCustomerIdCommentsSearch","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/CustomerComment"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Customer Comment Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/{customerId}/comments/{id}/pin":{"post":{"tags":["CustomerComments"],"summary":"Pin a comment to the top","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postCustomersCustomerIdCommentsIdPin"},"operationId":"postCustomersCustomerIdCommentsIdPin","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/{customerId}/comments/{id}/unpin":{"post":{"tags":["CustomerComments"],"summary":"Remove a pinned comment from the top","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postCustomersCustomerIdCommentsIdUnpin"},"operationId":"postCustomersCustomerIdCommentsIdUnpin","parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/bulk":{"post":{"tags":["Customers"],"summary":"Create multiple customers","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postCustomersBulk"},"operationId":"postCustomersBulk","parameters":[{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Customer.Create"}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestApiBulkOperationResult"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"413":{"$ref":"#/components/responses/413"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["Customers"],"summary":"Delete multiple customers","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteCustomersBulk"},"operationId":"deleteCustomersBulk","parameters":[{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestApiBulkOperationResult"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"413":{"$ref":"#/components/responses/413"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["Customers"],"summary":"Update multiple customers","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchCustomersBulk"},"operationId":"patchCustomersBulk","parameters":[{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Customer.Active"}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestApiBulkOperationResult"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"413":{"$ref":"#/components/responses/413"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/{id}":{"get":{"tags":["Customers"],"summary":"Retrieve a customer","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCustomersId"},"operationId":"getCustomersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["Customers"],"summary":"Delete a customer","description":"Permanently deletes a customer. It cannot be undone.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteCustomersId"},"operationId":"deleteCustomersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["Customers"],"summary":"Update a customer","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchCustomersId"},"operationId":"patchCustomersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer.Active"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers":{"get":{"tags":["Customers"],"summary":"List all customers","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCustomers"},"operationId":"getCustomers","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Customer"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Customer List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["Customers"],"summary":"Create a customer","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postCustomers"},"operationId":"postCustomers","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/{id}/email-addresses":{"get":{"tags":["Customers"],"summary":"List a customer's email addresses","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCustomersIdEmailAddresses"},"operationId":"getCustomersIdEmailAddresses","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/RestCustomerEmailAddress"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Customer Email Address List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/search":{"get":{"tags":["Customers"],"summary":"Search customers","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getCustomersSearch"},"operationId":"getCustomersSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Customer"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Customer Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/customers/{id}/merge/{other}":{"post":{"tags":["Customers"],"summary":"Merge two customers","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postCustomersIdMergeOther"},"operationId":"postCustomersIdMergeOther","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"other","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/delivery-indications":{"get":{"tags":["DeliveryIndications"],"summary":"List all delivery indications","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentDeliveryIndications"},"operationId":"getPaymentDeliveryIndications","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/DeliveryIndication"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Delivery Indication List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/delivery-indications/{id}":{"get":{"tags":["DeliveryIndications"],"summary":"Retrieve a delivery indication","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentDeliveryIndicationsId"},"operationId":"getPaymentDeliveryIndicationsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryIndication"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/delivery-indications/search":{"get":{"tags":["DeliveryIndications"],"summary":"Search delivery indications","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentDeliveryIndicationsSearch"},"operationId":"getPaymentDeliveryIndicationsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/DeliveryIndication"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Delivery Indication Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/delivery-indications/{id}/mark-not-suitable":{"post":{"tags":["DeliveryIndications"],"summary":"Mark a delivery indication as not suitable.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentDeliveryIndicationsIdMarkNotSuitable"},"operationId":"postPaymentDeliveryIndicationsIdMarkNotSuitable","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryIndication"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/delivery-indications/{id}/mark-suitable":{"post":{"tags":["DeliveryIndications"],"summary":"Mark a delivery indication as suitable.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentDeliveryIndicationsIdMarkSuitable"},"operationId":"postPaymentDeliveryIndicationsIdMarkSuitable","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryIndication"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/document-templates":{"get":{"tags":["DocumentTemplates"],"summary":"List all document templates","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getDocumentTemplates"},"operationId":"getDocumentTemplates","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/DocumentTemplate"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Document Template List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/document-templates/{id}":{"get":{"tags":["DocumentTemplates"],"summary":"Retrieve a document template","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getDocumentTemplatesId"},"operationId":"getDocumentTemplatesId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplate"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/document-templates/search":{"get":{"tags":["DocumentTemplates"],"summary":"Search document templates","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getDocumentTemplatesSearch"},"operationId":"getDocumentTemplatesSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/DocumentTemplate"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Document Template Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/document-templates/types":{"get":{"tags":["DocumentTemplateTypes"],"summary":"List all document template types","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getDocumentTemplatesTypes"},"operationId":"getDocumentTemplatesTypes","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/DocumentTemplateType"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Document Template Type List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/document-templates/types/{id}":{"get":{"tags":["DocumentTemplateTypes"],"summary":"Retrieve a document template type","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getDocumentTemplatesTypesId"},"operationId":"getDocumentTemplatesTypesId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateType"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/document-templates/types/search":{"get":{"tags":["DocumentTemplateTypes"],"summary":"Search document template types","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getDocumentTemplatesTypesSearch"},"operationId":"getDocumentTemplatesTypesSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/DocumentTemplateType"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Document Template Type Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/dunning-cases":{"get":{"tags":["DunningCases"],"summary":"List all dunning cases","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentDunningCases"},"operationId":"getPaymentDunningCases","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/DunningCase"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Dunning Case List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/dunning-cases/{id}":{"get":{"tags":["DunningCases"],"summary":"Retrieve a dunning case","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentDunningCasesId"},"operationId":"getPaymentDunningCasesId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DunningCase"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/dunning-cases/search":{"get":{"tags":["DunningCases"],"summary":"Search dunning cases","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentDunningCasesSearch"},"operationId":"getPaymentDunningCasesSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/DunningCase"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Dunning Case Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/dunning-cases/{id}/suspend":{"post":{"tags":["DunningCases"],"summary":"Suspend a dunning case","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentDunningCasesIdSuspend"},"operationId":"postPaymentDunningCasesIdSuspend","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"plannedEndDate","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/dunning-cases/invoice/{invoiceId}":{"post":{"tags":["DunningCases"],"summary":"Create a dunning case for an invoice","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentDunningCasesInvoiceInvoiceId"},"operationId":"postPaymentDunningCasesInvoiceInvoiceId","parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/dunning-flows/levels":{"get":{"tags":["DunningFlowLevels"],"summary":"List all dunning flow levels","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentDunningFlowsLevels"},"operationId":"getPaymentDunningFlowsLevels","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/DunningFlowLevel"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Dunning Flow Level List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/dunning-flows/levels/{id}":{"get":{"tags":["DunningFlowLevels"],"summary":"Retrieve a dunning flow level","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentDunningFlowsLevelsId"},"operationId":"getPaymentDunningFlowsLevelsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DunningFlowLevel"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/dunning-flows/levels/search":{"get":{"tags":["DunningFlowLevels"],"summary":"Search dunning flow levels","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentDunningFlowsLevelsSearch"},"operationId":"getPaymentDunningFlowsLevelsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/DunningFlowLevel"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Dunning Flow Level Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/dunning-flows":{"get":{"tags":["DunningFlows"],"summary":"List all dunning flows","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentDunningFlows"},"operationId":"getPaymentDunningFlows","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/DunningFlow"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Dunning Flow List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/dunning-flows/{id}":{"get":{"tags":["DunningFlows"],"summary":"Retrieve a dunning flow","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentDunningFlowsId"},"operationId":"getPaymentDunningFlowsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DunningFlow"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/dunning-flows/search":{"get":{"tags":["DunningFlows"],"summary":"Search dunning flows","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentDunningFlowsSearch"},"operationId":"getPaymentDunningFlowsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/DunningFlow"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Dunning Flow Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/human-users/{id}":{"get":{"tags":["HumanUsers"],"summary":"Retrieve a human user","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getHumanUsersId"},"operationId":"getHumanUsersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HumanUser"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["HumanUsers"],"summary":"Delete a human user","description":"Permanently deletes a human user. It cannot be undone.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteHumanUsersId"},"operationId":"deleteHumanUsersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["HumanUsers"],"summary":"Update a human user","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchHumanUsersId"},"operationId":"patchHumanUsersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HumanUser.Update"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HumanUser"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/human-users":{"get":{"tags":["HumanUsers"],"summary":"List all human users","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getHumanUsers"},"operationId":"getHumanUsers","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/HumanUser"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Human User List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["HumanUsers"],"summary":"Create a human user","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postHumanUsers"},"operationId":"postHumanUsers","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HumanUser.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HumanUser"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/human-users/export":{"get":{"tags":["HumanUsers"],"summary":"Export human users","description":"Export human users into a CSV file.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getHumanUsersExport"},"operationId":"getHumanUsersExport","parameters":[{"name":"fields","in":"query","description":"The fields to be included in the export.","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Default is 2,000.","schema":{"type":"integer","format":"int32","minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":100000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"text/csv":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}},"x-client-request-timeout-in-seconds":60}},"/human-users/search":{"get":{"tags":["HumanUsers"],"summary":"Search human users","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getHumanUsersSearch"},"operationId":"getHumanUsersSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/HumanUser"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Human User Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/human-users/{userId}/account-roles":{"get":{"tags":["HumanUsersRoles"],"summary":"List all roles of a human user for an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getHumanUsersUserIdAccountRoles"},"operationId":"getHumanUsersUserIdAccountRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"account","in":"header","description":"Specifies the ID of the account the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/UserAccountRole"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"User Account Role List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["HumanUsersRoles"],"summary":"Assign a role to a human user for an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postHumanUsersUserIdAccountRoles"},"operationId":"postHumanUsersUserIdAccountRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"roleId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"appliesOnSubAccount","in":"query","description":"Whether the role should be assigned to the user in subaccounts only.","schema":{"type":"boolean"}},{"name":"account","in":"header","description":"Specifies the ID of the account the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccountRole"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["HumanUsersRoles"],"summary":"Unassign a role from a human user for an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteHumanUsersUserIdAccountRoles"},"operationId":"deleteHumanUsersUserIdAccountRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"roleId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"account","in":"header","description":"Specifies the ID of the account the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/human-users/{userId}/space-roles":{"get":{"tags":["HumanUsersRoles"],"summary":"List all roles of a human user for a space","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getHumanUsersUserIdSpaceRoles"},"operationId":"getHumanUsersUserIdSpaceRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/UserSpaceRole"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"User Space Role List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["HumanUsersRoles"],"summary":"Assign a role to a human user for a space","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postHumanUsersUserIdSpaceRoles"},"operationId":"postHumanUsersUserIdSpaceRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"roleId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSpaceRole"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["HumanUsersRoles"],"summary":"Unassign a role from a human user for a space","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteHumanUsersUserIdSpaceRoles"},"operationId":"deleteHumanUsersUserIdSpaceRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"roleId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/label-descriptors":{"get":{"tags":["LabelDescriptors"],"summary":"List all label descriptors","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getLabelDescriptors"},"operationId":"getLabelDescriptors","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/LabelDescriptor"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Label Descriptor List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/label-descriptors/groups":{"get":{"tags":["LabelDescriptors"],"summary":"List all label descriptor groups","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getLabelDescriptorsGroups"},"operationId":"getLabelDescriptorsGroups","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/LabelDescriptorGroup"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Label Descriptor Group List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/label-descriptors/groups/{id}":{"get":{"tags":["LabelDescriptors"],"summary":"Retrieve a label descriptor group","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getLabelDescriptorsGroupsId"},"operationId":"getLabelDescriptorsGroupsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelDescriptorGroup"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/label-descriptors/groups/search":{"get":{"tags":["LabelDescriptors"],"summary":"Search label descriptor groups","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getLabelDescriptorsGroupsSearch"},"operationId":"getLabelDescriptorsGroupsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/LabelDescriptorGroup"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Label Descriptor Group Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/label-descriptors/{id}":{"get":{"tags":["LabelDescriptors"],"summary":"Retrieve a label descriptor","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getLabelDescriptorsId"},"operationId":"getLabelDescriptorsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelDescriptor"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/label-descriptors/search":{"get":{"tags":["LabelDescriptors"],"summary":"Search label descriptors","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getLabelDescriptorsSearch"},"operationId":"getLabelDescriptorsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/LabelDescriptor"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Label Descriptor Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/languages":{"get":{"tags":["Languages"],"summary":"List all languages","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getLanguages"},"operationId":"getLanguages","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/RestLanguage"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Language List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/languages/{code}":{"get":{"tags":["Languages"],"summary":"Retrieve a language","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getLanguagesCode"},"operationId":"getLanguagesCode","parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestLanguage"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/languages/search":{"get":{"tags":["Languages"],"summary":"Search languages","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getLanguagesSearch"},"operationId":"getLanguagesSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/RestLanguage"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Language Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/legal-organization-forms":{"get":{"tags":["LegalOrganizationForms"],"summary":"List all legal organization forms","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getLegalOrganizationForms"},"operationId":"getLegalOrganizationForms","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/LegalOrganizationForm"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Legal Organization Form List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/legal-organization-forms/{id}":{"get":{"tags":["LegalOrganizationForms"],"summary":"Retrieve a legal organization form","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getLegalOrganizationFormsId"},"operationId":"getLegalOrganizationFormsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalOrganizationForm"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/legal-organization-forms/search":{"get":{"tags":["LegalOrganizationForms"],"summary":"Search legal organization forms","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getLegalOrganizationFormsSearch"},"operationId":"getLegalOrganizationFormsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/LegalOrganizationForm"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Legal Organization Form Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/manual-tasks":{"get":{"tags":["ManualTasks"],"summary":"List all manual tasks","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getManualTasks"},"operationId":"getManualTasks","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ManualTask"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Manual Task List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/manual-tasks/{id}":{"get":{"tags":["ManualTasks"],"summary":"Retrieve a manual task","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getManualTasksId"},"operationId":"getManualTasksId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManualTask"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/manual-tasks/{id}/notification":{"get":{"tags":["ManualTasks"],"summary":"Retrieve a manual task's notification message","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getManualTasksIdNotification"},"operationId":"getManualTasksIdNotification","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/manual-tasks/search":{"get":{"tags":["ManualTasks"],"summary":"Search manual tasks","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getManualTasksSearch"},"operationId":"getManualTasksSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/ManualTask"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Manual Task Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/manual-tasks/{id}/action/{actionId}":{"post":{"tags":["ManualTasks"],"summary":"Process a manual task's action","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postManualTasksIdActionActionId"},"operationId":"postManualTasksIdActionActionId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/web-apps/connectors/{connectorExternalId}":{"delete":{"tags":["PaymentWebApps"],"summary":"Delete a connector","description":"Permanently deletes a connector. It cannot be undone.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deletePaymentWebAppsConnectorsConnectorExternalId"},"operationId":"deletePaymentWebAppsConnectorsConnectorExternalId","parameters":[{"name":"connectorExternalId","in":"path","description":"The unique identifier assigned during connector's creation.","required":true,"schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["PaymentWebApps"],"summary":"Update a connector","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentWebAppsConnectorsConnectorExternalId"},"operationId":"patchPaymentWebAppsConnectorsConnectorExternalId","parameters":[{"name":"connectorExternalId","in":"path","description":"The unique identifier assigned during connector's creation.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAppConnectorDetails"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAppConnector"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/web-apps/processors/{externalId}":{"delete":{"tags":["PaymentWebApps"],"summary":"Delete a processor","description":"Permanently deletes a processor. It cannot be undone.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deletePaymentWebAppsProcessorsExternalId"},"operationId":"deletePaymentWebAppsProcessorsExternalId","parameters":[{"name":"externalId","in":"path","description":"The unique identifier assigned during processor's creation.","required":true,"schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["PaymentWebApps"],"summary":"Update a processor","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentWebAppsProcessorsExternalId"},"operationId":"patchPaymentWebAppsProcessorsExternalId","parameters":[{"name":"externalId","in":"path","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAppProcessorDetails"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAppProcessor"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/web-apps/charge-attempts/{id}":{"patch":{"tags":["PaymentWebApps"],"summary":"Update a charge attempt","description":"Updates the state of a charge attempt for transactions created with a processor linked to the invoking web app, returning the specified charge attempt.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentWebAppsChargeAttemptsId"},"operationId":"patchPaymentWebAppsChargeAttemptsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAppChargeAttemptUpdate"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeAttempt"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/web-apps/completions/{id}":{"patch":{"tags":["PaymentWebApps"],"summary":"Update a completion","description":"Updates the state of a completion for transactions created with a processor linked to the invoking web app, returning the specified completion.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentWebAppsCompletionsId"},"operationId":"patchPaymentWebAppsCompletionsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAppCompletionUpdate"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCompletion"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/web-apps/refunds/{id}":{"patch":{"tags":["PaymentWebApps"],"summary":"Update a refund","description":"Updates the state of a refund for transactions created with a processor linked to the invoking web app, returning the specified refund.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentWebAppsRefundsId"},"operationId":"patchPaymentWebAppsRefundsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAppRefundUpdate"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/web-apps/voids/{id}":{"patch":{"tags":["PaymentWebApps"],"summary":"Update a void","description":"Updates the state of a void for transactions created with a processor linked to the invoking web app, returning the specified void.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentWebAppsVoidsId"},"operationId":"patchPaymentWebAppsVoidsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAppVoidUpdate"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionVoid"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/web-apps/processors":{"post":{"tags":["PaymentWebApps"],"summary":"Create a processor","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentWebAppsProcessors"},"operationId":"postPaymentWebAppsProcessors","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAppProcessorDetails.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAppProcessor"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/web-apps/processors/{externalId}/activate-for-production":{"post":{"tags":["PaymentWebApps"],"summary":"Activate a processor for production","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentWebAppsProcessorsExternalIdActivateForProduction"},"operationId":"postPaymentWebAppsProcessorsExternalIdActivateForProduction","parameters":[{"name":"externalId","in":"path","description":"The unique identifier assigned during processor's creation.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAppProcessor"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/web-apps/processors/{externalId}/connectors":{"post":{"tags":["PaymentWebApps"],"summary":"Create a connector","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentWebAppsProcessorsExternalIdConnectors"},"operationId":"postPaymentWebAppsProcessorsExternalIdConnectors","parameters":[{"name":"externalId","in":"path","description":"The unique identifier assigned during processor's creation.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAppConnectorDetails.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAppConnector"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/connector-configurations/{id}":{"get":{"tags":["PaymentConnectorConfigurations"],"summary":"Retrieve a payment connector configuration","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentConnectorConfigurationsId"},"operationId":"getPaymentConnectorConfigurationsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentConnectorConfiguration"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["PaymentConnectorConfigurations"],"summary":"Delete a payment connector configuration","description":"Permanently deletes a payment connector configuration. It cannot be undone.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deletePaymentConnectorConfigurationsId"},"operationId":"deletePaymentConnectorConfigurationsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["PaymentConnectorConfigurations"],"summary":"Update a payment connector configuration","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentConnectorConfigurationsId"},"operationId":"patchPaymentConnectorConfigurationsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentConnectorConfiguration.Update"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentConnectorConfiguration"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/connector-configurations":{"get":{"tags":["PaymentConnectorConfigurations"],"summary":"List all payment connector configurations","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentConnectorConfigurations"},"operationId":"getPaymentConnectorConfigurations","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentConnectorConfiguration"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Connector Configuration List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["PaymentConnectorConfigurations"],"summary":"Create a payment connector configuration","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentConnectorConfigurations"},"operationId":"postPaymentConnectorConfigurations","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentConnectorConfiguration.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentConnectorConfiguration"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/connector-configurations/search":{"get":{"tags":["PaymentConnectorConfigurations"],"summary":"Search payment connector configurations","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentConnectorConfigurationsSearch"},"operationId":"getPaymentConnectorConfigurationsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentConnectorConfiguration"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Connector Configuration Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/connectors":{"get":{"tags":["PaymentConnectors"],"summary":"List all payment connectors.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentConnectors"},"operationId":"getPaymentConnectors","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentConnector"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Connector List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/connectors/{id}":{"get":{"tags":["PaymentConnectors"],"summary":"Retrieve a payment connector.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentConnectorsId"},"operationId":"getPaymentConnectorsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentConnector"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/connectors/search":{"get":{"tags":["PaymentConnectors"],"summary":"Search payment connectors.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentConnectorsSearch"},"operationId":"getPaymentConnectorsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentConnector"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Connector Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/method-brands":{"get":{"tags":["PaymentMethodBrands"],"summary":"List all payment method brands.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentMethodBrands"},"operationId":"getPaymentMethodBrands","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentMethodBrand"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Method Brand List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/method-brands/{id}":{"get":{"tags":["PaymentMethodBrands"],"summary":"Retrieve a payment method brand.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentMethodBrandsId"},"operationId":"getPaymentMethodBrandsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodBrand"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/method-brands/search":{"get":{"tags":["PaymentMethodBrands"],"summary":"Search payment method brands.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentMethodBrandsSearch"},"operationId":"getPaymentMethodBrandsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentMethodBrand"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Method Brand Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/method-configurations/{id}":{"get":{"tags":["PaymentMethodConfigurations"],"summary":"Retrieve a payment method configuration","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentMethodConfigurationsId"},"operationId":"getPaymentMethodConfigurationsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodConfiguration"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["PaymentMethodConfigurations"],"summary":"Delete a payment method configuration","description":"Permanently deletes a payment method configuration.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deletePaymentMethodConfigurationsId"},"operationId":"deletePaymentMethodConfigurationsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["PaymentMethodConfigurations"],"summary":"Update a payment method configuration","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentMethodConfigurationsId"},"operationId":"patchPaymentMethodConfigurationsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodConfiguration.Update"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodConfiguration"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/method-configurations":{"get":{"tags":["PaymentMethodConfigurations"],"summary":"List all payment method configurations","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentMethodConfigurations"},"operationId":"getPaymentMethodConfigurations","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentMethodConfiguration"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Method Configuration List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["PaymentMethodConfigurations"],"summary":"Create a payment method configuration","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentMethodConfigurations"},"operationId":"postPaymentMethodConfigurations","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodConfiguration.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodConfiguration"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/method-configurations/search":{"get":{"tags":["PaymentMethodConfigurations"],"summary":"Search payment method configurations","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentMethodConfigurationsSearch"},"operationId":"getPaymentMethodConfigurationsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentMethodConfiguration"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Method Configuration Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/methods":{"get":{"tags":["PaymentMethods"],"summary":"List all payment methods.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentMethods"},"operationId":"getPaymentMethods","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentMethod"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Method List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/methods/{id}":{"get":{"tags":["PaymentMethods"],"summary":"Retrieve a payment method.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentMethodsId"},"operationId":"getPaymentMethodsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/methods/search":{"get":{"tags":["PaymentMethods"],"summary":"Search payment methods.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentMethodsSearch"},"operationId":"getPaymentMethodsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentMethod"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Method Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/processor-configurations/{id}":{"get":{"tags":["PaymentProcessorConfigurations"],"summary":"Retrieve a payment processor configuration","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentProcessorConfigurationsId"},"operationId":"getPaymentProcessorConfigurationsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProcessorConfiguration"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["PaymentProcessorConfigurations"],"summary":"Delete a payment processor configuration","description":"Permanently deletes a payment processor configuration.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deletePaymentProcessorConfigurationsId"},"operationId":"deletePaymentProcessorConfigurationsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["PaymentProcessorConfigurations"],"summary":"Update a payment processor configuration","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentProcessorConfigurationsId"},"operationId":"patchPaymentProcessorConfigurationsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProcessorConfiguration.Active"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProcessorConfiguration"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/processor-configurations":{"get":{"tags":["PaymentProcessorConfigurations"],"summary":"List all payment processor configurations","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentProcessorConfigurations"},"operationId":"getPaymentProcessorConfigurations","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentProcessorConfiguration"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Processor Configuration List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["PaymentProcessorConfigurations"],"summary":"Create a payment processor configuration","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentProcessorConfigurations"},"operationId":"postPaymentProcessorConfigurations","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProcessorConfiguration.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProcessorConfiguration"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/processor-configurations/search":{"get":{"tags":["PaymentProcessorConfigurations"],"summary":"Search payment processor configurations","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentProcessorConfigurationsSearch"},"operationId":"getPaymentProcessorConfigurationsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentProcessorConfiguration"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Processor Configuration Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/processor-configurations/{id}/link-contract":{"post":{"tags":["PaymentProcessorConfigurations"],"summary":"Link a contract with a payment processor configuration","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentProcessorConfigurationsIdLinkContract"},"operationId":"postPaymentProcessorConfigurationsIdLinkContract","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"contractId","in":"query","description":"The contract to link with the payment processor configuration.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProcessorConfiguration"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/processors":{"get":{"tags":["PaymentProcessors"],"summary":"List all payment processors.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentProcessors"},"operationId":"getPaymentProcessors","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentProcessor"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Processor List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/processors/{id}":{"get":{"tags":["PaymentProcessors"],"summary":"Retrieve a payment processor.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentProcessorsId"},"operationId":"getPaymentProcessorsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentProcessor"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/processors/search":{"get":{"tags":["PaymentProcessors"],"summary":"Search payment processors.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentProcessorsSearch"},"operationId":"getPaymentProcessorsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentProcessor"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Processor Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/permissions":{"get":{"tags":["Permissions"],"summary":"List all permissions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPermissions"},"operationId":"getPermissions","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Permission"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Permission List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/permissions/{id}":{"get":{"tags":["Permissions"],"summary":"Retrieve a permission","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPermissionsId"},"operationId":"getPermissionsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permission"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/permissions/search":{"get":{"tags":["Permissions"],"summary":"Search permissions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPermissionsSearch"},"operationId":"getPermissionsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Permission"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Permission Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/refunds/{refundId}/comments/{id}":{"get":{"tags":["RefundComments"],"summary":"Retrieve a refund comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentRefundsRefundIdCommentsId"},"operationId":"getPaymentRefundsRefundIdCommentsId","parameters":[{"name":"refundId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundComment"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["RefundComments"],"summary":"Delete a refund comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deletePaymentRefundsRefundIdCommentsId"},"operationId":"deletePaymentRefundsRefundIdCommentsId","parameters":[{"name":"refundId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["RefundComments"],"summary":"Update a refund comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentRefundsRefundIdCommentsId"},"operationId":"patchPaymentRefundsRefundIdCommentsId","parameters":[{"name":"refundId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundComment.Active"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundComment"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/refunds/{refundId}/comments":{"get":{"tags":["RefundComments"],"summary":"List all refund comments","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentRefundsRefundIdComments"},"operationId":"getPaymentRefundsRefundIdComments","parameters":[{"name":"refundId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/RefundComment"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Refund Comment List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["RefundComments"],"summary":"Create a refund comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentRefundsRefundIdComments"},"operationId":"postPaymentRefundsRefundIdComments","parameters":[{"name":"refundId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundComment.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundComment"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/refunds/{refundId}/comments/search":{"get":{"tags":["RefundComments"],"summary":"Search refund comments","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentRefundsRefundIdCommentsSearch"},"operationId":"getPaymentRefundsRefundIdCommentsSearch","parameters":[{"name":"refundId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/RefundComment"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Refund Comment Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/refunds/{refundId}/comments/{id}/pin":{"post":{"tags":["RefundComments"],"summary":"Pin a comment to the top","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentRefundsRefundIdCommentsIdPin"},"operationId":"postPaymentRefundsRefundIdCommentsIdPin","parameters":[{"name":"refundId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/refunds/{refundId}/comments/{id}/unpin":{"post":{"tags":["RefundComments"],"summary":"Remove the pinned comment from the top","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentRefundsRefundIdCommentsIdUnpin"},"operationId":"postPaymentRefundsRefundIdCommentsIdUnpin","parameters":[{"name":"refundId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/refunds":{"get":{"tags":["Refunds"],"summary":"List all refunds","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentRefunds"},"operationId":"getPaymentRefunds","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Refund"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Refund List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["Refunds"],"summary":"Create a refund","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentRefunds"},"operationId":"postPaymentRefunds","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/refunds/{id}":{"get":{"tags":["Refunds"],"summary":"Retrieve a refund","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentRefundsId"},"operationId":"getPaymentRefundsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/refunds/{id}/document":{"get":{"tags":["Refunds"],"summary":"Retrieve a refund document","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentRefundsIdDocument"},"operationId":"getPaymentRefundsIdDocument","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderedDocument"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/refunds/search":{"get":{"tags":["Refunds"],"summary":"Search refunds","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentRefundsSearch"},"operationId":"getPaymentRefundsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Refund"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Refund Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/refunds/{id}/mark-failed":{"post":{"tags":["Refunds"],"summary":"Mark a refund as failed","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentRefundsIdMarkFailed"},"operationId":"postPaymentRefundsIdMarkFailed","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/refunds/{id}/mark-succeeded":{"post":{"tags":["Refunds"],"summary":"Mark a refund as successful","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentRefundsIdMarkSucceeded"},"operationId":"postPaymentRefundsIdMarkSucceeded","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/roles/{id}":{"get":{"tags":["Roles"],"summary":"Retrieve a role","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getRolesId"},"operationId":"getRolesId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["Roles"],"summary":"Delete a role","description":"Permanently deletes a role. It cannot be undone.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteRolesId"},"operationId":"deleteRolesId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["Roles"],"summary":"Update a role","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchRolesId"},"operationId":"patchRolesId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role.Update"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/roles":{"get":{"tags":["Roles"],"summary":"List all roles","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getRoles"},"operationId":"getRoles","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Role"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Role List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["Roles"],"summary":"Create a role","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postRoles"},"operationId":"postRoles","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/roles/search":{"get":{"tags":["Roles"],"summary":"Search roles","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getRolesSearch"},"operationId":"getRolesSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Role"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Role Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/sales-channels":{"get":{"tags":["PaymentSalesChannels"],"summary":"List all payment sales channels.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentSalesChannels"},"operationId":"getPaymentSalesChannels","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/SalesChannel"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Sales Channel List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/sales-channels/{id}":{"get":{"tags":["PaymentSalesChannels"],"summary":"Retrieve a payment sales channel.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentSalesChannelsId"},"operationId":"getPaymentSalesChannelsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannel"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/sales-channels/search":{"get":{"tags":["PaymentSalesChannels"],"summary":"Search payment sales channels.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentSalesChannelsSearch"},"operationId":"getPaymentSalesChannelsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/SalesChannel"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Sales Channel Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/single-sign-on-users/{id}":{"get":{"tags":["SingleSignOnUsers"],"summary":"Retrieve a single sign-on user","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getSingleSignOnUsersId"},"operationId":"getSingleSignOnUsersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleSignOnUser"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["SingleSignOnUsers"],"summary":"Delete a single sign-on user","description":"Permanently deletes a single sign-on user. It cannot be undone.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteSingleSignOnUsersId"},"operationId":"deleteSingleSignOnUsersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["SingleSignOnUsers"],"summary":"Update a single sign-on user","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchSingleSignOnUsersId"},"operationId":"patchSingleSignOnUsersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleSignOnUser.Update"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleSignOnUser"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/single-sign-on-users":{"get":{"tags":["SingleSignOnUsers"],"summary":"List all single sign-on users","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getSingleSignOnUsers"},"operationId":"getSingleSignOnUsers","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/SingleSignOnUser"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Single Sign-On User List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["SingleSignOnUsers"],"summary":"Create a single sign-on user","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postSingleSignOnUsers"},"operationId":"postSingleSignOnUsers","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleSignOnUser.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleSignOnUser"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/single-sign-on-users/search":{"get":{"tags":["SingleSignOnUsers"],"summary":"Search single sign-on users","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getSingleSignOnUsersSearch"},"operationId":"getSingleSignOnUsersSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/SingleSignOnUser"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Single Sign-On User Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/single-sign-on-users/{userId}/account-roles":{"get":{"tags":["SingleSignOnUsersRoles"],"summary":"List all roles of a single sign-on user for an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getSingleSignOnUsersUserIdAccountRoles"},"operationId":"getSingleSignOnUsersUserIdAccountRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"account","in":"header","description":"Specifies the ID of the account the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/UserAccountRole"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"User Account Role List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["SingleSignOnUsersRoles"],"summary":"Assign a role to a single sign-on user for an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postSingleSignOnUsersUserIdAccountRoles"},"operationId":"postSingleSignOnUsersUserIdAccountRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"roleId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"appliesOnSubAccount","in":"query","description":"Whether the role should be assigned to the user in subaccounts only.","schema":{"type":"boolean"}},{"name":"account","in":"header","description":"Specifies the ID of the account the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccountRole"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["SingleSignOnUsersRoles"],"summary":"Unassign a role from a single sign-on user for an account","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteSingleSignOnUsersUserIdAccountRoles"},"operationId":"deleteSingleSignOnUsersUserIdAccountRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"roleId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"account","in":"header","description":"Specifies the ID of the account the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/single-sign-on-users/{userId}/space-roles":{"get":{"tags":["SingleSignOnUsersRoles"],"summary":"List all roles of a single sign-on user for a space","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getSingleSignOnUsersUserIdSpaceRoles"},"operationId":"getSingleSignOnUsersUserIdSpaceRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/UserSpaceRole"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"User Space Role List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["SingleSignOnUsersRoles"],"summary":"Assign a role to a single sign-on user for a space","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postSingleSignOnUsersUserIdSpaceRoles"},"operationId":"postSingleSignOnUsersUserIdSpaceRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"roleId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSpaceRole"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["SingleSignOnUsersRoles"],"summary":"Unassign a role from a single sign-on user for a space","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteSingleSignOnUsersUserIdSpaceRoles"},"operationId":"deleteSingleSignOnUsersUserIdSpaceRoles","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"roleId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/spaces/{id}":{"get":{"tags":["Spaces"],"summary":"Retrieve a space","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getSpacesId"},"operationId":"getSpacesId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Space"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["Spaces"],"summary":"Delete a space","description":"Permanently deletes a space. It cannot be undone.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteSpacesId"},"operationId":"deleteSpacesId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["Spaces"],"summary":"Update a space","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchSpacesId"},"operationId":"patchSpacesId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Space.Update"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Space"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/spaces":{"get":{"tags":["Spaces"],"summary":"List all spaces","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getSpaces"},"operationId":"getSpaces","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Space"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Space List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["Spaces"],"summary":"Create a space","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postSpaces"},"operationId":"postSpaces","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Space.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Space"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/spaces/search":{"get":{"tags":["Spaces"],"summary":"Search spaces","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getSpacesSearch"},"operationId":"getSpacesSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Space"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Space Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/static-values":{"get":{"tags":["StaticValues"],"summary":"List all static values","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getStaticValues"},"operationId":"getStaticValues","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/StaticValue"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Static Value List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/static-values/{id}":{"get":{"tags":["StaticValues"],"summary":"Retrieve a static value","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getStaticValuesId"},"operationId":"getStaticValuesId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticValue"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/static-values/search":{"get":{"tags":["StaticValues"],"summary":"Search static values","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getStaticValuesSearch"},"operationId":"getStaticValuesSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/StaticValue"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Static Value Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/tokens/{id}":{"get":{"tags":["Tokens"],"summary":"Retrieve a token","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTokensId"},"operationId":"getPaymentTokensId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["Tokens"],"summary":"Delete a token","description":"Permanently deletes a token. It cannot be undone.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deletePaymentTokensId"},"operationId":"deletePaymentTokensId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["Tokens"],"summary":"Update a token","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentTokensId"},"operationId":"patchPaymentTokensId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token.Update"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/tokens":{"get":{"tags":["Tokens"],"summary":"List all tokens","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTokens"},"operationId":"getPaymentTokens","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Token"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Token List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["Tokens"],"summary":"Create a token","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTokens"},"operationId":"postPaymentTokens","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/tokens/{id}/active-version":{"get":{"tags":["Tokens"],"summary":"Retrieve the active token version","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTokensIdActiveVersion"},"operationId":"getPaymentTokensIdActiveVersion","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenVersion"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/tokens/search":{"get":{"tags":["Tokens"],"summary":"Search tokens","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTokensSearch"},"operationId":"getPaymentTokensSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Token"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Token Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/tokens/{id}/create-transaction-for-token-update":{"post":{"tags":["Tokens"],"summary":"Create a transaction for token update","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTokensIdCreateTransactionForTokenUpdate"},"operationId":"postPaymentTokensIdCreateTransactionForTokenUpdate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/token-versions":{"get":{"tags":["TokenVersions"],"summary":"List all token versions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTokenVersions"},"operationId":"getPaymentTokenVersions","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TokenVersion"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Token Version List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/token-versions/{id}":{"get":{"tags":["TokenVersions"],"summary":"Retrieve a token version","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTokenVersionsId"},"operationId":"getPaymentTokenVersionsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenVersion"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/token-versions/search":{"get":{"tags":["TokenVersions"],"summary":"Search token token versions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTokenVersionsSearch"},"operationId":"getPaymentTokenVersionsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TokenVersion"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Token Version Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transaction/client-platforms":{"get":{"tags":["TransactionClientPlatforms"],"summary":"List all client platforms","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionClientPlatforms"},"operationId":"getPaymentTransactionClientPlatforms","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionClientPlatformInformation"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Client Platform Information List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transaction/client-platforms/{id}":{"get":{"tags":["TransactionClientPlatforms"],"summary":"Retrieve the client platform based on id","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionClientPlatformsId"},"operationId":"getPaymentTransactionClientPlatformsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionClientPlatformInformation"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transaction/client-platforms/search":{"get":{"tags":["TransactionClientPlatforms"],"summary":"Search client platforms","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionClientPlatformsSearch"},"operationId":"getPaymentTransactionClientPlatformsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionClientPlatformInformation"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Client Platform Information Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{transactionId}/comments/{id}":{"get":{"tags":["TransactionComments"],"summary":"Retrieve a transaction comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsTransactionIdCommentsId"},"operationId":"getPaymentTransactionsTransactionIdCommentsId","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionComment"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["TransactionComments"],"summary":"Delete a transaction comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deletePaymentTransactionsTransactionIdCommentsId"},"operationId":"deletePaymentTransactionsTransactionIdCommentsId","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["TransactionComments"],"summary":"Update a transaction comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentTransactionsTransactionIdCommentsId"},"operationId":"patchPaymentTransactionsTransactionIdCommentsId","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionComment.Active"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionComment"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{transactionId}/comments":{"get":{"tags":["TransactionComments"],"summary":"List all transaction comments","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsTransactionIdComments"},"operationId":"getPaymentTransactionsTransactionIdComments","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionComment"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Transaction Comment List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["TransactionComments"],"summary":"Create a transaction comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsTransactionIdComments"},"operationId":"postPaymentTransactionsTransactionIdComments","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionComment.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionComment"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{transactionId}/comments/search":{"get":{"tags":["TransactionComments"],"summary":"Search transaction comments","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsTransactionIdCommentsSearch"},"operationId":"getPaymentTransactionsTransactionIdCommentsSearch","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionComment"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Transaction Comment Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{transactionId}/comments/{id}/pin":{"post":{"tags":["TransactionComments"],"summary":"Pin a comment to the top","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsTransactionIdCommentsIdPin"},"operationId":"postPaymentTransactionsTransactionIdCommentsIdPin","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{transactionId}/comments/{id}/unpin":{"post":{"tags":["TransactionComments"],"summary":"Remove the pinned comment from the top","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsTransactionIdCommentsIdUnpin"},"operationId":"postPaymentTransactionsTransactionIdCommentsIdUnpin","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/completions":{"get":{"tags":["TransactionCompletions"],"summary":"List all transaction completions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsCompletions"},"operationId":"getPaymentTransactionsCompletions","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionCompletion"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Completion List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/completions/{id}":{"get":{"tags":["TransactionCompletions"],"summary":"Retrieve a transaction completion","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsCompletionsId"},"operationId":"getPaymentTransactionsCompletionsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCompletion"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/completions/search":{"get":{"tags":["TransactionCompletions"],"summary":"Search transaction completions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsCompletionsSearch"},"operationId":"getPaymentTransactionsCompletionsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionCompletion"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Completion Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices/{invoiceId}/comments/{id}":{"get":{"tags":["TransactionInvoiceComments"],"summary":"Retrieve a transaction invoice comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsInvoicesInvoiceIdCommentsId"},"operationId":"getPaymentTransactionsInvoicesInvoiceIdCommentsId","parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInvoiceComment"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["TransactionInvoiceComments"],"summary":"Delete a transaction comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deletePaymentTransactionsInvoicesInvoiceIdCommentsId"},"operationId":"deletePaymentTransactionsInvoicesInvoiceIdCommentsId","parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["TransactionInvoiceComments"],"summary":"Update a transaction comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentTransactionsInvoicesInvoiceIdCommentsId"},"operationId":"patchPaymentTransactionsInvoicesInvoiceIdCommentsId","parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInvoiceComment.Active"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInvoiceComment"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices/{invoiceId}/comments":{"get":{"tags":["TransactionInvoiceComments"],"summary":"List all transaction invoice comments","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsInvoicesInvoiceIdComments"},"operationId":"getPaymentTransactionsInvoicesInvoiceIdComments","parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionInvoiceComment"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Invoice Comment List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["TransactionInvoiceComments"],"summary":"Create a transaction invoice comment","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsInvoicesInvoiceIdComments"},"operationId":"postPaymentTransactionsInvoicesInvoiceIdComments","parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInvoiceComment.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInvoiceComment"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices/{invoiceId}/comments/search":{"get":{"tags":["TransactionInvoiceComments"],"summary":"Search transaction invoice comments","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsInvoicesInvoiceIdCommentsSearch"},"operationId":"getPaymentTransactionsInvoicesInvoiceIdCommentsSearch","parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionInvoiceComment"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Invoice Comment Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices/{invoiceId}/comments/{id}/pin":{"post":{"tags":["TransactionInvoiceComments"],"summary":"Pin a comment to the top","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsInvoicesInvoiceIdCommentsIdPin"},"operationId":"postPaymentTransactionsInvoicesInvoiceIdCommentsIdPin","parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices/{invoiceId}/comments/{id}/unpin":{"post":{"tags":["TransactionInvoiceComments"],"summary":"Remove the pinned comment from the top","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsInvoicesInvoiceIdCommentsIdUnpin"},"operationId":"postPaymentTransactionsInvoicesInvoiceIdCommentsIdUnpin","parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices":{"get":{"tags":["TransactionInvoices"],"summary":"List all transaction invoices","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsInvoices"},"operationId":"getPaymentTransactionsInvoices","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionInvoice"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Invoice List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices/{id}":{"get":{"tags":["TransactionInvoices"],"summary":"Retrieve a transaction invoice","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsInvoicesId"},"operationId":"getPaymentTransactionsInvoicesId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices/{id}/check-replacement-possible":{"get":{"tags":["TransactionInvoices"],"summary":"Check if a transaction invoice can be replaced","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsInvoicesIdCheckReplacementPossible"},"operationId":"getPaymentTransactionsInvoicesIdCheckReplacementPossible","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices/{id}/document":{"get":{"tags":["TransactionInvoices"],"summary":"Retrieve an invoice document","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsInvoicesIdDocument"},"operationId":"getPaymentTransactionsInvoicesIdDocument","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderedDocument"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices/search":{"get":{"tags":["TransactionInvoices"],"summary":"Search transaction invoices","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsInvoicesSearch"},"operationId":"getPaymentTransactionsInvoicesSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionInvoice"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Invoice Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices/{id}/derecognize":{"post":{"tags":["TransactionInvoices"],"summary":"Derecognize a transaction invoice","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsInvoicesIdDerecognize"},"operationId":"postPaymentTransactionsInvoicesIdDerecognize","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices/{id}/instant-payment-url":{"post":{"tags":["TransactionInvoices"],"summary":"Create an instant invoice payment URL","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsInvoicesIdInstantPaymentUrl"},"operationId":"postPaymentTransactionsInvoicesIdInstantPaymentUrl","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"successUrl","in":"query","schema":{"type":"string"}},{"name":"failureUrl","in":"query","schema":{"type":"string"}},{"name":"ttlInMinutes","in":"query","description":"Optional TTL in minutes relative to now. Allowed range is 1 to 561600 (13 months in minutes). If omitted, 30 minutes is used.","schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices/{id}/mark-paid":{"post":{"tags":["TransactionInvoices"],"summary":"Mark a transaction invoice as paid","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsInvoicesIdMarkPaid"},"operationId":"postPaymentTransactionsInvoicesIdMarkPaid","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/invoices/{id}/replace":{"post":{"tags":["TransactionInvoices"],"summary":"Replace a transaction invoice","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsInvoicesIdReplace"},"operationId":"postPaymentTransactionsInvoicesIdReplace","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInvoiceReplacement"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInvoice"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/line-item-versions":{"get":{"tags":["TransactionLineItemVersions"],"summary":"List all transaction line item versions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsLineItemVersions"},"operationId":"getPaymentTransactionsLineItemVersions","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionLineItemVersion"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Line Item Version List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["TransactionLineItemVersions"],"summary":"Create a transaction line item version","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsLineItemVersions"},"operationId":"postPaymentTransactionsLineItemVersions","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionLineItemVersion.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionLineItemVersion"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/line-item-versions/{id}":{"get":{"tags":["TransactionLineItemVersions"],"summary":"Retrieve a transaction line item version","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsLineItemVersionsId"},"operationId":"getPaymentTransactionsLineItemVersionsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionLineItemVersion"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/line-item-versions/search":{"get":{"tags":["TransactionLineItemVersions"],"summary":"Search transaction line item versions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsLineItemVersionsSearch"},"operationId":"getPaymentTransactionsLineItemVersionsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionLineItemVersion"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Line Item Version Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/by-credentials/{credentials}/one-click-tokens/{id}":{"delete":{"tags":["Transactions"],"summary":"Delete a one-click token by credentials","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deletePaymentTransactionsByCredentialsCredentialsOneClickTokensId"},"operationId":"deletePaymentTransactionsByCredentialsCredentialsOneClickTokensId","parameters":[{"name":"credentials","in":"path","description":"Identifies the transaction and includes the security details required to authorize access to this operation.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions":{"get":{"tags":["Transactions"],"summary":"List all transactions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactions"},"operationId":"getPaymentTransactions","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Transaction"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Transaction List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["Transactions"],"summary":"Create a transaction","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactions"},"operationId":"postPaymentTransactions","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/by-credentials/{credentials}":{"get":{"tags":["Transactions"],"summary":"Retrieve a transaction by credentials","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsByCredentialsCredentials"},"operationId":"getPaymentTransactionsByCredentialsCredentials","parameters":[{"name":"credentials","in":"path","description":"Identifies the transaction and includes the security details required to authorize access to this operation.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/by-credentials/{credentials}/mobile-sdk-url":{"get":{"tags":["Transactions"],"summary":"Retrieve a Mobile SDK URL by credentials","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsByCredentialsCredentialsMobileSdkUrl"},"operationId":"getPaymentTransactionsByCredentialsCredentialsMobileSdkUrl","parameters":[{"name":"credentials","in":"path","description":"The credentials identify the transaction and contain the security details which grant the access to this operation.","required":true,"schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/by-credentials/{credentials}/one-click-tokens":{"get":{"tags":["Transactions"],"summary":"List one-click tokens by credentials","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsByCredentialsCredentialsOneClickTokens"},"operationId":"getPaymentTransactionsByCredentialsCredentialsOneClickTokens","parameters":[{"name":"credentials","in":"path","description":"Identifies the transaction and includes the security details required to authorize access to this operation.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TokenVersion"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Token Version List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/by-credentials/{credentials}/payment-method-configurations":{"get":{"tags":["Transactions"],"summary":"List available payment method configurations by credentials","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsByCredentialsCredentialsPaymentMethodConfigurations"},"operationId":"getPaymentTransactionsByCredentialsCredentialsPaymentMethodConfigurations","parameters":[{"name":"credentials","in":"path","description":"Identifies the transaction and includes the security details required to authorize access to this operation.","required":true,"schema":{"type":"string"}},{"name":"integrationMode","in":"query","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentMethodConfiguration"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Method Configuration List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/export":{"get":{"tags":["Transactions"],"summary":"Export transactions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsExport"},"operationId":"getPaymentTransactionsExport","parameters":[{"name":"fields","in":"query","description":"The fields to be included in the export.","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Default is 2,000.","schema":{"type":"integer","format":"int32","minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":100000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"text/csv":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}},"x-client-request-timeout-in-seconds":60}},"/payment/transactions/{id}":{"get":{"tags":["Transactions"],"summary":"Retrieve a transaction","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsId"},"operationId":"getPaymentTransactionsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["Transactions"],"summary":"Update a transaction","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchPaymentTransactionsId"},"operationId":"patchPaymentTransactionsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction.Pending"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/charge-flow/payment-page-url":{"get":{"tags":["Transactions"],"summary":"Retrieve a charge flow payment page URL","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsIdChargeFlowPaymentPageUrl"},"operationId":"getPaymentTransactionsIdChargeFlowPaymentPageUrl","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/check-token-creation-possible":{"get":{"tags":["Transactions"],"summary":"Check if token can be created","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsIdCheckTokenCreationPossible"},"operationId":"getPaymentTransactionsIdCheckTokenCreationPossible","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/credentials":{"get":{"tags":["Transactions"],"summary":"Retrieve transaction credentials","description":"Generates temporary transaction credentials to delegate access to the REST API for the specified transaction.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsIdCredentials"},"operationId":"getPaymentTransactionsIdCredentials","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/iframe-javascript-url":{"get":{"tags":["Transactions"],"summary":"Retrieve an iFrame JavaScript URL","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsIdIframeJavascriptUrl"},"operationId":"getPaymentTransactionsIdIframeJavascriptUrl","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/invoice-document":{"get":{"tags":["Transactions"],"summary":"Retrieve an invoice document","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsIdInvoiceDocument"},"operationId":"getPaymentTransactionsIdInvoiceDocument","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderedDocument"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/latest-line-item-version":{"get":{"tags":["Transactions"],"summary":"Retrieve the latest line item version","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsIdLatestLineItemVersion"},"operationId":"getPaymentTransactionsIdLatestLineItemVersion","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionLineItemVersion"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/lightbox-javascript-url":{"get":{"tags":["Transactions"],"summary":"Retrieve a Lightbox JavaScript URL","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsIdLightboxJavascriptUrl"},"operationId":"getPaymentTransactionsIdLightboxJavascriptUrl","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/packing-slip-document":{"get":{"tags":["Transactions"],"summary":"Retrieve a packing slip document","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsIdPackingSlipDocument"},"operationId":"getPaymentTransactionsIdPackingSlipDocument","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderedDocument"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/payment-method-configurations":{"get":{"tags":["Transactions"],"summary":"List available payment method configurations","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsIdPaymentMethodConfigurations"},"operationId":"getPaymentTransactionsIdPaymentMethodConfigurations","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"integrationMode","in":"query","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/PaymentMethodConfiguration"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Payment Method Configuration List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/payment-page-url":{"get":{"tags":["Transactions"],"summary":"Retrieve a payment page URL","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsIdPaymentPageUrl"},"operationId":"getPaymentTransactionsIdPaymentPageUrl","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/terminal-receipts":{"get":{"tags":["Transactions"],"summary":"List terminal receipts","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsIdTerminalReceipts"},"operationId":"getPaymentTransactionsIdTerminalReceipts","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"format","in":"query","description":"The format specifies how the receipts will be presented in the response.","required":true,"schema":{"$ref":"#/components/schemas/TerminalReceiptFormat"}},{"name":"width","in":"query","description":"The width defines the dimensions for rendering the document. For PDF format, the width is specified in millimeters, while for text format, it represents the number of characters per line.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/RenderedTerminalReceipt"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Rendered Terminal Receipt List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/search":{"get":{"tags":["Transactions"],"summary":"Search transactions","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsSearch"},"operationId":"getPaymentTransactionsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/Transaction"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Transaction Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/by-credentials/{credentials}/one-click-tokens/{id}/process":{"post":{"tags":["Transactions"],"summary":"Process via one-click token by credentials","description":"Assigns the provided token to the transaction, processes it, and returns a URL for customer redirection to complete the transaction.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsByCredentialsCredentialsOneClickTokensIdProcess"},"operationId":"postPaymentTransactionsByCredentialsCredentialsOneClickTokensIdProcess","parameters":[{"name":"credentials","in":"path","description":"Identifies the transaction and includes the security details required to authorize access to this operation.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/charge-flow/apply":{"post":{"tags":["Transactions"],"summary":"Process a transaction via charge flow","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdChargeFlowApply"},"operationId":"postPaymentTransactionsIdChargeFlowApply","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/charge-flow/cancel":{"post":{"tags":["Transactions"],"summary":"Cancel a charge flow","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdChargeFlowCancel"},"operationId":"postPaymentTransactionsIdChargeFlowCancel","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/charge-flow/update-recipient":{"post":{"tags":["Transactions"],"summary":"Update a charge flow recipient","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdChargeFlowUpdateRecipient"},"operationId":"postPaymentTransactionsIdChargeFlowUpdateRecipient","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"type","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"recipient","in":"query","required":true,"schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/complete-offline":{"post":{"tags":["Transactions"],"summary":"Complete a transaction offline","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdCompleteOffline"},"operationId":"postPaymentTransactionsIdCompleteOffline","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCompletion"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/complete-online":{"post":{"tags":["Transactions"],"summary":"Complete a transaction online","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdCompleteOnline"},"operationId":"postPaymentTransactionsIdCompleteOnline","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCompletion"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/complete-partially-offline":{"post":{"tags":["Transactions"],"summary":"Complete a transaction offline partially","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdCompletePartiallyOffline"},"operationId":"postPaymentTransactionsIdCompletePartiallyOffline","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCompletionDetails"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCompletion"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/complete-partially-online":{"post":{"tags":["Transactions"],"summary":"Complete a transaction online partially","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdCompletePartiallyOnline"},"operationId":"postPaymentTransactionsIdCompletePartiallyOnline","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCompletionDetails"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionCompletion"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/confirm":{"post":{"tags":["Transactions"],"summary":"Confirm a transaction","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdConfirm"},"operationId":"postPaymentTransactionsIdConfirm","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction.Pending"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/process-card-details":{"post":{"tags":["Transactions"],"summary":"Process a card transaction","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdProcessCardDetails"},"operationId":"postPaymentTransactionsIdProcessCardDetails","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticatedCardRequest"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/process-card-details-threed":{"post":{"tags":["Transactions"],"summary":"Process a card transaction with 3-D Secure","description":"Processes the transaction using the provided card details, potentially utilizing 3-D Secure. Returns a URL where the buyer must be redirected to complete the transaction.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdProcessCardDetailsThreed"},"operationId":"postPaymentTransactionsIdProcessCardDetailsThreed","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizedCardRequest"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/process-with-token":{"post":{"tags":["Transactions"],"summary":"Process a transaction via token","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdProcessWithToken"},"operationId":"postPaymentTransactionsIdProcessWithToken","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Charge"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/process-without-interaction":{"post":{"tags":["Transactions"],"summary":"Process a transaction without user-interaction","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdProcessWithoutInteraction"},"operationId":"postPaymentTransactionsIdProcessWithoutInteraction","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/void-offline":{"post":{"tags":["Transactions"],"summary":"Void a transaction offline","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdVoidOffline"},"operationId":"postPaymentTransactionsIdVoidOffline","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionVoid"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/{id}/void-online":{"post":{"tags":["Transactions"],"summary":"Void a transaction online","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postPaymentTransactionsIdVoidOnline"},"operationId":"postPaymentTransactionsIdVoidOnline","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionVoid"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/voids":{"get":{"tags":["TransactionVoids"],"summary":"List all transaction voids","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsVoids"},"operationId":"getPaymentTransactionsVoids","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionVoid"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Transaction Void List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/voids/{id}":{"get":{"tags":["TransactionVoids"],"summary":"Retrieve a transaction void","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsVoidsId"},"operationId":"getPaymentTransactionsVoidsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionVoid"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/payment/transactions/voids/search":{"get":{"tags":["TransactionVoids"],"summary":"Search transaction voids","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getPaymentTransactionsVoidsSearch"},"operationId":"getPaymentTransactionsVoidsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/TransactionVoid"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Transaction Void Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/web-apps/installed":{"get":{"tags":["WebApps"],"summary":"Check whether the web app is installed","description":"Return true if the web app is installed in the provided space.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getWebAppsInstalled"},"operationId":"getWebAppsInstalled","parameters":[{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/web-apps/confirm/{code}":{"post":{"tags":["WebApps"],"summary":"Confirm a web app installation","description":"Confirm the installation of a web app. This has to be done when the user returns to the web app after granting permissions, using the activation code provided in the request.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postWebAppsConfirmCode"},"operationId":"postWebAppsConfirmCode","parameters":[{"name":"code","in":"path","description":"The activation code passed to the web app after permissions were granted.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebAppConfirmationResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/web-apps/uninstall":{"post":{"tags":["WebApps"],"summary":"Uninstall a web app","description":"Uninstall the web app from the provided space.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postWebAppsUninstall"},"operationId":"postWebAppsUninstall","parameters":[{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/webhooks/encryption-keys/{id}":{"get":{"tags":["WebhookEncryptionKeys"],"summary":"Retrieve a webhook encryption key","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getWebhooksEncryptionKeysId"},"operationId":"getWebhooksEncryptionKeysId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/webhooks/listeners/bulk":{"post":{"tags":["WebhookListeners"],"summary":"Create multiple webhook listeners","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postWebhooksListenersBulk"},"operationId":"postWebhooksListenersBulk","parameters":[{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookListener.Create"}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestApiBulkOperationResult"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"413":{"$ref":"#/components/responses/413"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["WebhookListeners"],"summary":"Delete multiple webhook listeners","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteWebhooksListenersBulk"},"operationId":"deleteWebhooksListenersBulk","parameters":[{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestApiBulkOperationResult"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"413":{"$ref":"#/components/responses/413"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["WebhookListeners"],"summary":"Update multiple webhook listeners","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchWebhooksListenersBulk"},"operationId":"patchWebhooksListenersBulk","parameters":[{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookListener.Update"}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestApiBulkOperationResult"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"413":{"$ref":"#/components/responses/413"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/webhooks/listeners/{id}":{"get":{"tags":["WebhookListeners"],"summary":"Retrieve a webhook listener","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getWebhooksListenersId"},"operationId":"getWebhooksListenersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListener"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["WebhookListeners"],"summary":"Delete a webhook listener","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteWebhooksListenersId"},"operationId":"deleteWebhooksListenersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["WebhookListeners"],"summary":"Update a webhook listener","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchWebhooksListenersId"},"operationId":"patchWebhooksListenersId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListener.Update"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListener"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/webhooks/listeners":{"get":{"tags":["WebhookListeners"],"summary":"List all webhook listeners","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getWebhooksListeners"},"operationId":"getWebhooksListeners","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/WebhookListener"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Webhook Listener List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["WebhookListeners"],"summary":"Create a webhook listener","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postWebhooksListeners"},"operationId":"postWebhooksListeners","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListener.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListener"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/webhooks/listeners/search":{"get":{"tags":["WebhookListeners"],"summary":"Search webhook listeners","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getWebhooksListenersSearch"},"operationId":"getWebhooksListenersSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/WebhookListener"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Webhook Listener Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/webhooks/urls/bulk":{"post":{"tags":["WebhookURLs"],"summary":"Create multiple webhook URLs","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postWebhooksUrlsBulk"},"operationId":"postWebhooksUrlsBulk","parameters":[{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookUrl.Create"}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestApiBulkOperationResult"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"413":{"$ref":"#/components/responses/413"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["WebhookURLs"],"summary":"Delete multiple webhook URLs","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteWebhooksUrlsBulk"},"operationId":"deleteWebhooksUrlsBulk","parameters":[{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestApiBulkOperationResult"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"413":{"$ref":"#/components/responses/413"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["WebhookURLs"],"summary":"Update multiple webhook URLs","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchWebhooksUrlsBulk"},"operationId":"patchWebhooksUrlsBulk","parameters":[{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookUrl.Update"}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestApiBulkOperationResult"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"413":{"$ref":"#/components/responses/413"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/webhooks/urls/{id}":{"get":{"tags":["WebhookURLs"],"summary":"Retrieve a webhook URL","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getWebhooksUrlsId"},"operationId":"getWebhooksUrlsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUrl"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"delete":{"tags":["WebhookURLs"],"summary":"Delete a webhook URL","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#deleteWebhooksUrlsId"},"operationId":"deleteWebhooksUrlsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful response."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"patch":{"tags":["WebhookURLs"],"summary":"Update a webhook URL","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#patchWebhooksUrlsId"},"operationId":"patchWebhooksUrlsId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUrl.Update"}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUrl"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/webhooks/urls":{"get":{"tags":["WebhookURLs"],"summary":"List all webhook URLs","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getWebhooksUrls"},"operationId":"getWebhooksUrls","parameters":[{"name":"after","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately after the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"before","in":"query","description":"Set to an object's ID to retrieve the page of objects coming immediately before the named object.","schema":{"type":"integer","format":"int64","minimum":1}},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"order","in":"query","description":"Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.","schema":{"$ref":"#/components/schemas/SortingOrder"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_listresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/WebhookUrl"},"readOnly":true,"title":"Data"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Webhook URL List Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}},"post":{"tags":["WebhookURLs"],"summary":"Create a webhook URL","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#postWebhooksUrls"},"operationId":"postWebhooksUrls","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUrl.Create"}}},"required":true},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUrl"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"409":{"$ref":"#/components/responses/409"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}},"/webhooks/urls/search":{"get":{"tags":["WebhookURLs"],"summary":"Search webhook URLs","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#getWebhooksUrlsSearch"},"operationId":"getWebhooksUrlsSearch","parameters":[{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned, between 1 and 100. Default is 10.","schema":{"type":"integer","format":"int32","maximum":100,"minimum":1}},{"name":"offset","in":"query","description":"A cursor for pagination, specifies the number of objects to skip.","schema":{"type":"integer","format":"int32","maximum":10000}},{"name":"order","in":"query","description":"The fields and order to sort the objects by.","schema":{"type":"string"}},{"name":"query","in":"query","description":"The search query to filter the objects by.","schema":{"type":"string"}},{"name":"space","in":"header","description":"Specifies the ID of the space the operation should be executed in.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_searchresponse"},"properties":{"data":{"type":"array","description":"An array containing the actual response objects.","items":{"$ref":"#/components/schemas/WebhookUrl"},"readOnly":true,"title":"Data"},"offset":{"type":"integer","format":"int32","description":"The number of skipped objects.","readOnly":true,"title":"Offset"},"hasMore":{"type":"boolean","description":"Whether there are more objects available after this set. If false, there are no more objects to retrieve.","readOnly":true,"title":"Has More"},"limit":{"type":"integer","format":"int32","description":"The applied limit on the number of objects returned.","readOnly":true,"title":"Limit"}},"title":"Webhook URL Search Response"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"415":{"$ref":"#/components/responses/415"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"5XX":{"$ref":"#/components/responses/5XX"},"default":{"$ref":"#/components/responses/default"}}}}},"components":{"schemas":{"Abstract.Account.Update":{"type":"object","properties":{"name":{"type":"string","description":"The name used to identify the account.","maxLength":200,"minLength":3,"title":"Name"},"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-type":"ABSTRACT"},"Abstract.ApplicationUser.Update":{"type":"object","properties":{"requestLimit":{"type":"integer","format":"int64","description":"The maximum number of API requests that are accepted every 2 minutes.","title":"Request Limit"},"name":{"type":"string","description":"The name used to identify the application user.","maxLength":256,"title":"Name"},"state":{"$ref":"#/components/schemas/CreationEntityState"}},"title":"Abstract Application User","x-model-type":"ABSTRACT"},"Abstract.Customer.Active":{"type":"object","properties":{"metaData":{"type":"object","additionalProperties":{"type":"string"},"description":"Allow to store additional information about the object.","title":"Meta Data"},"emailAddress":{"type":"string","description":"The customer's email address.","maxLength":254,"title":"Email Address"},"familyName":{"type":"string","description":"The customer's family or last name.","maxLength":100,"title":"Family Name"},"givenName":{"type":"string","description":"The customer's given or first name.","maxLength":100,"title":"Given Name"},"preferredCurrency":{"type":"string","description":"The customer's preferred currency.","title":"Preferred Currency"},"customerId":{"type":"string","description":"The customer's ID in the merchant's system.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","title":"Customer Id"},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language"}},"title":"Abstract Customer","x-model-type":"ABSTRACT"},"Abstract.CustomerAddress.Active":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/CustomerPostalAddress.Create"},"addressType":{"$ref":"#/components/schemas/CustomerAddressType"}},"title":"Abstract Customer Address","x-model-type":"ABSTRACT"},"Abstract.CustomerComment.Active":{"type":"object","properties":{"content":{"type":"string","description":"The comment's actual content.","maxLength":262144,"title":"Content"}},"title":"Abstract Customer Comment","x-model-type":"ABSTRACT"},"Abstract.HumanUser.Update":{"type":"object","properties":{"mobilePhoneNumber":{"type":"string","description":"The user's mobile phone number.","maxLength":30,"title":"Mobile Phone Number"},"twoFactorEnabled":{"type":"boolean","description":"Whether two-factor authentication is enabled for this user.","title":"Two-Factor Authentication"},"emailAddress":{"type":"string","description":"The user's email address.","maxLength":128,"title":"Email Address"},"firstname":{"type":"string","description":"The user's first name.","maxLength":100,"title":"First Name"},"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"},"language":{"type":"string","description":"The user's preferred language.","title":"Language"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"lastname":{"type":"string","description":"The user's last name.","maxLength":100,"title":"Last Name"}},"title":"Abstract Human User","x-model-type":"ABSTRACT"},"Abstract.PaymentAppConnectorDetails":{"type":"object","properties":{},"title":"Abstract Connector Details","x-model-type":"ABSTRACT"},"Abstract.PaymentAppProcessorDetails":{"type":"object","properties":{},"title":"Abstract Processor Details","x-model-type":"ABSTRACT"},"Abstract.PaymentConnectorConfiguration.Update":{"type":"object","properties":{"name":{"type":"string","description":"The name used to identify the connector configuration.","maxLength":100,"title":"Name"},"enabledSpaceViews":{"type":"array","description":"The space views for which the connector configuration is enabled. If empty, it is enabled for all space views.","items":{"type":"integer","format":"int64"},"title":"Enabled Space Views","uniqueItems":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.","items":{"$ref":"#/components/schemas/Condition"},"title":"Conditions"},"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"},"enabledSalesChannels":{"type":"array","description":"The sales channels for which the connector configuration is enabled. If empty, it is enabled for all sales channels.","items":{"$ref":"#/components/schemas/SalesChannel"},"title":"Enabled Sales Channels","uniqueItems":true}},"title":"Abstract Payment Connector Configuration","x-model-type":"ABSTRACT"},"Abstract.PaymentMethodConfiguration.Update":{"type":"object","properties":{"imageResourcePath":{"type":"string","description":"The resource path to a custom image for the payment method, displayed to the customer for visual identification.","title":"Image Resource Path"},"sortOrder":{"type":"integer","format":"int32","description":"When listing payment methods, they can be sorted by this number.","title":"Sort Order"},"name":{"type":"string","description":"The name used to identify the payment method configuration.","maxLength":100,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"A customer-facing custom description for the payment method.","title":"Description"},"oneClickPaymentMode":{"$ref":"#/components/schemas/OneClickPaymentMode"},"title":{"type":"object","additionalProperties":{"type":"string"},"description":"A customer-facing custom title for the payment method.","title":"Title"}},"title":"Abstract Payment Method Configuration . Update","x-model-type":"ABSTRACT"},"Abstract.PaymentProcessorConfiguration.Active":{"type":"object","properties":{"name":{"type":"string","description":"The name used to identify the payment method configuration.","maxLength":100,"title":"Name"},"state":{"$ref":"#/components/schemas/CreationEntityState"}},"title":"Abstract Payment Processor Configuration","x-model-type":"ABSTRACT"},"Abstract.RefundComment.Active":{"type":"object","properties":{"content":{"type":"string","description":"The comment's actual content.","maxLength":262144,"title":"Content"}},"title":"Abstract Comment","x-model-type":"ABSTRACT"},"Abstract.Role.Update":{"type":"object","properties":{"permissions":{"type":"array","description":"The permissions granted to users with this role.","items":{"$ref":"#/components/schemas/Permission"},"title":"Permissions","uniqueItems":true},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The name used to identify the role.","title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional information that describes the role.","title":"Description"},"twoFactorRequired":{"type":"boolean","description":"Whether users with this role are required to use two-factor authentication.","title":"Two-Factor Authentication Required"}},"title":"Abstract Role","x-model-type":"ABSTRACT"},"Abstract.SingleSignOnUser.Update":{"type":"object","properties":{"firstname":{"type":"string","description":"The user's first name.","maxLength":100,"title":"First Name"},"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"},"language":{"type":"string","description":"The user's preferred language.","title":"Language"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"lastname":{"type":"string","description":"The user's last name.","maxLength":100,"title":"Last Name"}},"title":"Abstract Single Sign-On User","x-model-type":"ABSTRACT"},"Abstract.Space.Update":{"type":"object","properties":{"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"},"postalAddress":{"$ref":"#/components/schemas/SpaceAddress.Create"},"name":{"type":"string","description":"The name used to identify the space.","maxLength":200,"minLength":3,"title":"Name"},"technicalContactAddresses":{"type":"array","description":"The email address that will receive messages about technical issues and errors that occur in the space.","items":{"type":"string"},"title":"Technical Contact Addresses","uniqueItems":true},"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"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"primaryCurrency":{"type":"string","description":"The currency that is used to display aggregated amounts in the space.","title":"Primary Currency"}},"title":"Abstract Space","x-model-type":"ABSTRACT"},"Abstract.Token.Update":{"type":"object","properties":{"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"},"customerEmailAddress":{"type":"string","description":"The customer's email address.","maxLength":150,"title":"Customer Email Address"},"tokenReference":{"type":"string","description":"The reference used to identify the payment token (e.g. the customer's ID or email address).","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","title":"Token Reference"},"customerId":{"type":"string","description":"The unique identifier of the customer in the external system.","title":"Customer ID"},"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"},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language"}},"title":"Abstract Token . Update","x-model-type":"ABSTRACT"},"Abstract.Transaction.Pending":{"type":"object","properties":{"customerEmailAddress":{"type":"string","description":"The customer's email address.","maxLength":254,"title":"Customer Email Address"},"shippingMethod":{"type":"string","description":"The name of the shipping method used to ship the products.","maxLength":200,"title":"Shipping Method"},"invoiceMerchantReference":{"type":"string","description":"The merchant's reference used to identify the invoice.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","title":"Invoice Merchant Reference"},"successUrl":{"type":"string","description":"The URL to redirect the customer back to after they successfully authenticated their payment.","maxLength":2000,"minLength":9,"title":"Success Url"},"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"},"language":{"type":"string","description":"The language that is linked to the object.","title":"Language"},"tokenizationMode":{"$ref":"#/components/schemas/TokenizationMode"},"allowedPaymentMethodBrands":{"type":"array","description":"The payment method brands that can be used to authorize the transaction.","items":{"type":"integer","format":"int64"},"title":"Allowed Payment Method Brands"},"completionBehavior":{"$ref":"#/components/schemas/TransactionCompletionBehavior"},"token":{"type":"integer","format":"int64","description":"The payment token that should be used to charge the customer.","title":"Token"},"lineItems":{"type":"array","description":"The line items purchased by the customer.","items":{"$ref":"#/components/schemas/LineItem.Create"},"title":"Line Items"},"metaData":{"type":"object","additionalProperties":{"type":"string"},"description":"Allow to store additional information about the object.","title":"Meta Data"},"customerId":{"type":"string","description":"The unique identifier of the customer in the external system.","title":"Customer ID"},"shippingAddress":{"$ref":"#/components/schemas/Address.Create"},"currency":{"type":"string","description":"The three-letter code (ISO 4217 format) of the transaction's currency.","title":"Currency"},"billingAddress":{"$ref":"#/components/schemas/Address.Create"},"merchantReference":{"type":"string","description":"The merchant's reference used to identify the transaction.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","title":"Merchant Reference"},"allowedPaymentMethodConfigurations":{"type":"array","description":"The payment method configurations that can be used to authorize the transaction.","items":{"type":"integer","format":"int64"},"title":"Allowed Payment Method Configurations"},"failedUrl":{"type":"string","description":"The URL to redirect the customer back to after they canceled or failed to authenticated their payment.","maxLength":2000,"minLength":9,"title":"Failed Url"}},"title":"Abstract Transaction","x-model-type":"ABSTRACT"},"Abstract.TransactionComment.Active":{"type":"object","properties":{"content":{"type":"string","description":"The comment's actual content.","maxLength":262144,"title":"Content"}},"title":"Abstract Comment","x-model-type":"ABSTRACT"},"Abstract.TransactionInvoiceComment.Active":{"type":"object","properties":{"content":{"type":"string","description":"The comment's actual content.","maxLength":262144,"title":"Content"}},"title":"Abstract Comment","x-model-type":"ABSTRACT"},"Abstract.WebhookListener.Update":{"type":"object","properties":{"entityStates":{"type":"array","description":"The entity's target states that are to be monitored.","items":{"type":"string"},"title":"Entity States","uniqueItems":true},"name":{"type":"string","description":"The name used to identify the webhook listener.","maxLength":50,"title":"Name"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"notifyEveryChange":{"type":"boolean","description":"Whether every update of the entity or only state changes are to be monitored.","title":"Notify Every Change"}},"title":"Abstract Webhook Listener","x-model-type":"ABSTRACT"},"Abstract.WebhookUrl.Update":{"type":"object","properties":{"name":{"type":"string","description":"The name used to identify the webhook URL.","maxLength":50,"title":"Name"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"url":{"type":"string","description":"The actual URL where notifications about entity changes are sent to.","maxLength":500,"minLength":9,"title":"Url"}},"title":"Abstract Webhook URL","x-model-type":"ABSTRACT"},"Account":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_account"},"properties":{"activeOrRestrictedActive":{"type":"boolean","description":"Whether this account and all its parent accounts are active or restricted active.","readOnly":true,"title":"Active Or Restricted Active"},"deletedOn":{"type":"string","format":"date-time","description":"The date and time when the account was deleted.","readOnly":true,"title":"Deleted On"},"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.","readOnly":true,"title":"Planned Purge Date"},"active":{"type":"boolean","description":"Whether this account and all its parent accounts are active.","readOnly":true,"title":"Active"},"parentAccount":{"$ref":"#/components/schemas/Account"},"type":{"$ref":"#/components/schemas/AccountType"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the account was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"deletedBy":{"type":"integer","format":"int64","description":"The ID of a user the account was deleted by.","readOnly":true,"title":"Deleted By"},"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.","readOnly":true,"title":"Restricted Active"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the account was created by.","readOnly":true,"title":"Created By"},"scope":{"$ref":"#/components/schemas/Scope"},"name":{"type":"string","description":"The name used to identify the account.","maxLength":200,"minLength":3,"readOnly":true,"title":"Name"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/AccountState"},"subaccountLimit":{"type":"integer","format":"int64","description":"The number of sub-accounts that can be created within this account.","readOnly":true,"title":"Subaccount Limit"}},"title":"Account","x-expandable-fields":["parentAccount","scope"],"x-model-type":"READ"},"Account.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.Account.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_account_create"},"properties":{"scope":{"type":"integer","format":"int64","description":"The scope that the account belongs to.","title":"Scope"},"parentAccount":{"type":"integer","format":"int64","description":"The parent account responsible for administering this account.","title":"Parent Account"}},"required":["scope"],"title":"Account","x-expandable-fields":["parentAccount","scope"],"x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_account_create"},"title":"Account","x-model-type":"CREATE"},"Account.Update":{"allOf":[{"$ref":"#/components/schemas/Abstract.Account.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_account_update"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Account","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_account_update"},"title":"Account","x-model-type":"UPDATE"},"AccountState":{"type":"string","enum":["CREATE","RESTRICTED_ACTIVE","ACTIVE","INACTIVE","DELETING","DELETED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_accountstate"},"title":"Account State","x-model-type":"ENUM"},"AccountType":{"type":"string","enum":["MASTER","REGULAR","SUBACCOUNT"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_accounttype"},"title":"Account Type","x-model-type":"ENUM"},"Address":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_address"},"properties":{"country":{"type":"string","description":"The two-letter country code (ISO 3166 format).","readOnly":true,"title":"Country"},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","maxLength":100,"readOnly":true,"title":"Mobile Phone Number"},"gender":{"$ref":"#/components/schemas/Gender"},"organizationName":{"type":"string","description":"The organization's name.","maxLength":100,"readOnly":true,"title":"Organization Name"},"city":{"type":"string","description":"The city, town or village.","maxLength":100,"readOnly":true,"title":"City"},"commercialRegisterNumber":{"type":"string","description":"The commercial registration number of the organization.","maxLength":100,"readOnly":true,"title":"Commercial Register Number"},"socialSecurityNumber":{"type":"string","description":"The social security number.","maxLength":100,"readOnly":true,"title":"Social Security Number"},"givenName":{"type":"string","description":"The given or first name.","maxLength":100,"readOnly":true,"title":"Given Name"},"postcode":{"type":"string","description":"The postal code, also known as ZIP, postcode, etc.","maxLength":40,"readOnly":true,"title":"Postcode"},"legalOrganizationForm":{"$ref":"#/components/schemas/LegalOrganizationForm"},"salesTaxNumber":{"type":"string","description":"The sales tax number of the organization.","maxLength":100,"readOnly":true,"title":"Sales Tax Number"},"dateOfBirth":{"type":"string","format":"date","description":"The date of birth.","readOnly":true,"title":"Date Of Birth"},"dependentLocality":{"type":"string","description":"The dependent locality which is a sub-division of the state.","maxLength":100,"readOnly":true,"title":"Dependent Locality"},"emailAddress":{"type":"string","description":"The email address.","maxLength":254,"readOnly":true,"title":"Email Address"},"phoneNumber":{"type":"string","description":"The phone number.","maxLength":100,"readOnly":true,"title":"Phone Number"},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","maxLength":100,"readOnly":true,"title":"Sorting Code"},"street":{"type":"string","description":"The street or PO Box.","maxLength":300,"readOnly":true,"title":"Street"},"familyName":{"type":"string","description":"The family or last name.","maxLength":100,"readOnly":true,"title":"Family Name"},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","readOnly":true,"title":"State"},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","maxLength":20,"readOnly":true,"title":"Salutation"}},"title":"Address","x-model-type":"READ"},"Address.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_address_create"},"properties":{"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"},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","maxLength":100,"title":"Mobile Phone Number"},"gender":{"$ref":"#/components/schemas/Gender"},"organizationName":{"type":"string","description":"The organization's name.","maxLength":100,"title":"Organization Name"},"city":{"type":"string","description":"The city, town or village.","maxLength":100,"title":"City"},"commercialRegisterNumber":{"type":"string","description":"The commercial registration number of the organization.","maxLength":100,"title":"Commercial Register Number"},"socialSecurityNumber":{"type":"string","description":"The social security number.","maxLength":100,"title":"Social Security Number"},"givenName":{"type":"string","description":"The given or first name.","maxLength":100,"title":"Given Name"},"postcode":{"type":"string","description":"The postal code, also known as ZIP, postcode, etc.","maxLength":40,"title":"Postcode"},"legalOrganizationForm":{"type":"integer","format":"int64","description":"The legal form of the organization.","title":"Legal Organization Form"},"salesTaxNumber":{"type":"string","description":"The sales tax number of the organization.","maxLength":100,"title":"Sales Tax Number"},"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.","maxLength":100,"title":"Dependent Locality"},"emailAddress":{"type":"string","description":"The email address.","maxLength":254,"title":"Email Address"},"phoneNumber":{"type":"string","description":"The phone number.","maxLength":100,"title":"Phone Number"},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","maxLength":100,"title":"Sorting Code"},"street":{"type":"string","description":"The street or PO Box.","maxLength":300,"title":"Street"},"familyName":{"type":"string","description":"The family or last name.","maxLength":100,"title":"Family Name"},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","title":"State"},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","maxLength":20,"title":"Salutation"}},"title":"Address in Create State","x-model-type":"CREATE"},"ApplicationKeyState":{"type":"string","enum":["GENERATED","ACTIVE","INACTIVE"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_applicationkeystate"},"title":"Application Key State","x-model-type":"ENUM"},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/User"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_applicationuser"},"properties":{"requestLimit":{"type":"integer","format":"int64","description":"The maximum number of API requests that are accepted every 2 minutes.","readOnly":true,"title":"Request Limit"},"scope":{"type":"integer","format":"int64","description":"The scope that the user belongs to.","readOnly":true,"title":"Scope"},"name":{"type":"string","description":"The name used to identify the application user.","maxLength":256,"readOnly":true,"title":"Name"},"primaryAccount":{"type":"integer","format":"int64","description":"The primary account that the user belongs to.","readOnly":true,"title":"Primary Account"}},"title":"Application User","x-model-type":"READ"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_applicationuser"},"title":"Application User","x-model-type":"READ"},"ApplicationUser.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.ApplicationUser.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_applicationuser_create"},"properties":{"primaryAccount":{"type":"integer","format":"int64","description":"The primary account that the user belongs to.","title":"Primary Account"}},"required":["primaryAccount"],"title":"Application User","x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_applicationuser_create"},"title":"Application User","x-model-type":"CREATE"},"ApplicationUser.CreateWithMacKey":{"allOf":[{"$ref":"#/components/schemas/ApplicationUser"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_applicationuser_createwithmackey"},"properties":{"macKey":{"type":"string","description":"The user's authentication key securing requests. Only displayed a single time after the user has been created.","readOnly":true,"title":"Mac Key"}},"title":"Application User","x-model-type":"READ"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_applicationuser_createwithmackey"},"title":"Application User","x-model-type":"READ"},"ApplicationUser.Update":{"allOf":[{"$ref":"#/components/schemas/Abstract.ApplicationUser.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_applicationuser_update"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Application User","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_applicationuser_update"},"title":"Application User","x-model-type":"UPDATE"},"AuthenticatedCardData":{"allOf":[{"$ref":"#/components/schemas/TokenizedCardData"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_authenticatedcarddata"},"properties":{"cardholderAuthentication":{"$ref":"#/components/schemas/CardholderAuthentication"}},"title":"Authenticated Card Data","x-model-type":"READ"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_authenticatedcarddata"},"title":"Authenticated Card Data","x-model-type":"READ"},"AuthenticatedCardData.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_authenticatedcarddata_create"},"properties":{"expiryDate":{"type":"string","description":"The expiry date of the card, indicating its validity period in yyyy-mm format (e.g., 2023-09).","pattern":"(\\d{4})-(11|12|10|0[1-9])","title":"Expiry Date"},"panType":{"$ref":"#/components/schemas/PanType"},"cardHolderName":{"type":"string","description":"The name of the cardholder, as printed on the card, identifying the card owner.","maxLength":100,"title":"Cardholder Name"},"cardVerificationCode":{"type":"string","description":"The security code used to validate the card during transactions.","maxLength":4,"minLength":3,"pattern":"([0-9 ]+)","title":"Card Verification Code (CVC)"},"primaryAccountNumber":{"type":"string","description":"The card's primary account number (PAN), the unique identifier of the card.","maxLength":30,"minLength":10,"pattern":"([0-9 ]+)","title":"Primary Account Number (PAN)"},"recurringIndicator":{"$ref":"#/components/schemas/RecurringIndicator"},"schemeTransactionReference":{"type":"string","description":"A reference specific to the card's transaction within its payment scheme.","maxLength":100,"title":"Scheme Transaction Reference"},"cardholderAuthentication":{"$ref":"#/components/schemas/CardholderAuthentication.Create"},"tokenRequestorId":{"type":"string","description":"The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.","title":"Token Requestor Identifier (TRID)"},"cryptogram":{"$ref":"#/components/schemas/CardCryptogram.Create"}},"required":["primaryAccountNumber"],"title":"Authenticated Card Data . Create","x-model-type":"CREATE"},"AuthenticatedCardRequest":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_authenticatedcardrequest"},"properties":{"cardData":{"$ref":"#/components/schemas/AuthenticatedCardData.Create","readOnly":false},"paymentMethodConfiguration":{"type":"integer","format":"int64","description":"The ID of the payment method configuration to use.","readOnly":false,"title":"Payment Method Configuration"}},"title":"Authenticated Card Request","x-model-type":"UPDATE"},"CardAuthenticationResponse":{"type":"string","enum":["FULLY_AUTHENTICATED","AUTHENTICATION_NOT_REQUIRED","NOT_ENROLLED","ENROLLMENT_ERROR","AUTHENTICATION_ERROR"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_cardauthenticationresponse"},"title":"Card Authentication Response","x-model-type":"ENUM"},"CardAuthenticationVersion":{"type":"string","enum":["V1","V2"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_cardauthenticationversion"},"title":"Card Authentication Version","x-model-type":"ENUM"},"CardCryptogram":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_cardcryptogram"},"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.","readOnly":true,"title":"Electronic Commerce Indicator (ECI)"},"value":{"type":"string","description":"The cryptogram value used for securing card transactions, format varying based on the PAN type.","readOnly":true,"title":"Value"}},"title":"Card Cryptogram","x-model-type":"READ"},"CardCryptogram.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_cardcryptogram_create"},"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"}},"required":["value"],"title":"Card Cryptogram . Create","x-model-type":"CREATE"},"CardholderAuthentication":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_cardholderauthentication"},"properties":{"authenticationIdentifier":{"type":"string","description":"The identifier (e.g., XID or DSTransactionID) assigned by the authentication system for tracking and verification.","readOnly":true,"title":"Authentication Identifier"},"authenticationResponse":{"$ref":"#/components/schemas/CardAuthenticationResponse"},"electronicCommerceIndicator":{"type":"string","description":"The Electronic Commerce Indicator (ECI) represents the authentication level and indicates liability shift during online or card-not-present transactions.","readOnly":true,"title":"Electronic Commerce Indicator (ECI)"},"authenticationValue":{"type":"string","description":"The cryptographic token (CAVV/AAV) generated during the authentication process to validate the cardholder's identity.","readOnly":true,"title":"Authentication Value"},"version":{"$ref":"#/components/schemas/CardAuthenticationVersion"}},"title":"Cardholder Authentication","x-model-type":"READ"},"CardholderAuthentication.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_cardholderauthentication_create"},"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":{"$ref":"#/components/schemas/CardAuthenticationResponse"},"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)"},"authenticationValue":{"type":"string","description":"The cryptographic token (CAVV/AAV) generated during the authentication process to validate the cardholder's identity.","title":"Authentication Value"},"version":{"$ref":"#/components/schemas/CardAuthenticationVersion"}},"required":["authenticationResponse","version"],"title":"Cardholder Authentication . Create","x-model-type":"CREATE"},"Charge":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_charge"},"properties":{"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.","readOnly":true,"title":"Planned Purge Date"},"timeZone":{"type":"string","description":"The time zone that this object is associated with.","readOnly":true,"title":"Time Zone"},"language":{"type":"string","description":"The language that is linked to the object.","readOnly":true,"title":"Language"},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","readOnly":true,"title":"Space View ID"},"type":{"$ref":"#/components/schemas/ChargeType"},"userFailureMessage":{"type":"string","description":"The message that can be displayed to the customer explaining why the charge failed, in the customer's language.","readOnly":true,"title":"User Failure Message"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the charge will expire.","readOnly":true,"title":"Timeout On"},"failureReason":{"$ref":"#/components/schemas/FailureReason"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/ChargeState"},"transaction":{"$ref":"#/components/schemas/Transaction"}},"title":"Charge","x-expandable-fields":["transaction"],"x-model-type":"READ"},"ChargeAttempt":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_chargeattempt"},"properties":{"language":{"type":"string","description":"The language that is linked to the object.","readOnly":true,"title":"Language"},"salesChannel":{"type":"integer","format":"int64","description":"The sales channel through which the charge attempt was made.","readOnly":true,"title":"Sales Channel"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"initializingTokenVersion":{"type":"boolean","description":"Whether a new token version is being initialized.","readOnly":true,"title":"Initializing Token Version"},"tokenVersion":{"$ref":"#/components/schemas/TokenVersion"},"succeededOn":{"type":"string","format":"date-time","description":"The date and time when the charge attempt succeeded.","readOnly":true,"title":"Succeeded On"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/ChargeAttemptState"},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","readOnly":true,"title":"Linked Transaction"},"redirectionUrl":{"type":"string","description":"The URL to redirect the customer to after payment processing.","readOnly":true,"title":"Redirection Url"},"charge":{"$ref":"#/components/schemas/Charge"},"wallet":{"$ref":"#/components/schemas/WalletType"},"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.","readOnly":true,"title":"Planned Purge Date"},"timeZone":{"type":"string","description":"The time zone that this object is associated with.","readOnly":true,"title":"Time Zone"},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","readOnly":true,"title":"Space View ID"},"terminal":{"$ref":"#/components/schemas/PaymentTerminal"},"userFailureMessage":{"type":"string","description":"The message that can be displayed to the customer explaining why the charge attempt failed, in the customer's language.","maxLength":2000,"readOnly":true,"title":"User Failure Message"},"completionBehavior":{"$ref":"#/components/schemas/TransactionCompletionBehavior"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"labels":{"type":"array","description":"The labels providing additional information about the object.","items":{"$ref":"#/components/schemas/Label"},"readOnly":true,"title":"Labels","uniqueItems":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the object will expire.","readOnly":true,"title":"Timeout On"},"environment":{"$ref":"#/components/schemas/ChargeAttemptEnvironment"},"invocation":{"$ref":"#/components/schemas/ConnectorInvocation"},"connectorConfiguration":{"$ref":"#/components/schemas/PaymentConnectorConfiguration"},"nextUpdateOn":{"type":"string","format":"date-time","description":"The date and time when the next update of the object's state is planned.","readOnly":true,"title":"Next Update On"},"failureReason":{"$ref":"#/components/schemas/FailureReason"},"customersPresence":{"$ref":"#/components/schemas/CustomersPresence"},"failedOn":{"type":"string","format":"date-time","description":"The date and time when the charge attempt failed.","readOnly":true,"title":"Failed On"}},"title":"Charge Attempt","x-expandable-fields":["charge","connectorConfiguration","invocation","labels","terminal","tokenVersion"],"x-model-type":"READ"},"ChargeAttemptEnvironment":{"type":"string","enum":["PRODUCTION","TEST"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_chargeattemptenvironment"},"title":"Charge Attempt Environment","x-model-type":"ENUM"},"ChargeAttemptState":{"type":"string","enum":["PROCESSING","FAILED","SUCCESSFUL"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_chargeattemptstate"},"title":"Charge Attempt State","x-model-type":"ENUM"},"ChargeFlow":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_chargeflow"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"name":{"type":"string","description":"The name used to identify the charge flow.","readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"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.","items":{"$ref":"#/components/schemas/Condition"},"readOnly":true,"title":"Conditions"},"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.","readOnly":true,"title":"Priority"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Charge Flow","x-expandable-fields":["conditions"],"x-model-type":"READ"},"ChargeFlowLevel":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_chargeflowlevel"},"properties":{"synchronousCharge":{"$ref":"#/components/schemas/Charge"},"configuration":{"$ref":"#/components/schemas/ChargeFlowLevelConfiguration"},"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.","readOnly":true,"title":"Planned Purge Date"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the charge flow level will expire.","readOnly":true,"title":"Timeout On"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/ChargeFlowLevelState"},"asynchronousCharge":{"$ref":"#/components/schemas/Charge"},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","readOnly":true,"title":"Linked Transaction"},"tokenCharge":{"$ref":"#/components/schemas/Charge"},"transaction":{"$ref":"#/components/schemas/Transaction"}},"title":"Charge Flow Level","x-expandable-fields":["asynchronousCharge","configuration","synchronousCharge","tokenCharge","transaction"],"x-model-type":"READ"},"ChargeFlowLevelConfiguration":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_chargeflowlevelconfiguration"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"period":{"type":"string","description":"The duration specifies how long the level remains active before transitioning to the next one.","readOnly":true,"title":"Period"},"name":{"type":"string","description":"The name used to identify the charge flow level configuration.","maxLength":100,"readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"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.","readOnly":true,"title":"Priority"},"type":{"type":"integer","format":"int64","description":"The type defines the method of delivering the payment link to the customer.","readOnly":true,"title":"Type"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"flow":{"$ref":"#/components/schemas/ChargeFlow"}},"title":"Charge Flow Level Configuration","x-expandable-fields":["flow"],"x-model-type":"READ"},"ChargeFlowLevelConfigurationType":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_chargeflowlevelconfigurationtype"},"properties":{"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized label that describes the action triggered by the configuration type.","readOnly":true,"title":"Label"}},"title":"Charge Flow Level Configuration Type","x-expandable-fields":["description","label","name"],"x-model-type":"READ"},"ChargeFlowLevelPaymentLink":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_chargeflowlevelpaymentlink"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"chargeFlowLevel":{"$ref":"#/components/schemas/ChargeFlowLevel"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"paymentLink":{"type":"string","description":"The URL provided to the customer for entering their payment details and completing the transaction.","readOnly":true,"title":"Payment Link"}},"title":"Charge Flow Level Payment Link","x-expandable-fields":["chargeFlowLevel"],"x-model-type":"READ"},"ChargeFlowLevelState":{"type":"string","enum":["PENDING","FAILED","SUCCESSFUL"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_chargeflowlevelstate"},"title":"Charge Flow Level State","x-model-type":"ENUM"},"ChargeState":{"type":"string","enum":["PENDING","FAILED","SUCCESSFUL"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_chargestate"},"title":"Charge State","x-model-type":"ENUM"},"ChargeType":{"type":"string","enum":["ASYNCHRONOUS","SYNCHRONOUS","TOKEN","TERMINAL"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_chargetype"},"title":"Charge Type","x-model-type":"ENUM"},"CompletionLineItem":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_completionlineitem"},"properties":{"amount":{"type":"number","description":"The total amount of the line item to be captured, including taxes.","readOnly":true,"title":"Amount"},"quantity":{"type":"number","description":"The number of items to be captured.","readOnly":true,"title":"Quantity"},"uniqueId":{"type":"string","description":"The unique identifier of the line item within the set of line items.","maxLength":200,"readOnly":true,"title":"Unique ID"}},"title":"Completion Line Item","x-model-type":"READ"},"CompletionLineItem.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_completionlineitem_create"},"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.","maxLength":200,"title":"Unique ID"}},"required":["amount","quantity","uniqueId"],"title":"Completion Line Item . Create","x-model-type":"CREATE"},"Condition":{"type":"object","description":"A connector condition defines criteria that a transaction must meet for a connector configuration to process the payment.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_condition"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"name":{"type":"string","description":"The name used to identify the condition.","maxLength":100,"readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"conditionType":{"$ref":"#/components/schemas/ConditionType"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Connector Condition","x-expandable-fields":["conditionType"],"x-model-type":"READ"},"ConditionType":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_conditiontype"},"properties":{"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Condition Type","x-expandable-fields":["description","name"],"x-model-type":"READ"},"ConnectorInvocation":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_connectorinvocation"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"timeTookInMilliseconds":{"type":"integer","format":"int64","description":"The duration, in milliseconds, taken to execute the connector invocation.","readOnly":true,"title":"Time Took In Milliseconds"},"stage":{"$ref":"#/components/schemas/ConnectorInvocationStage"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"transaction":{"type":"integer","format":"int64","description":"The transaction that the connector invocation belongs to.","readOnly":true,"title":"Transaction"}},"title":"Connector Invocation","x-model-type":"READ"},"ConnectorInvocationStage":{"type":"string","enum":["PAYMENT_METHOD_LIST","FORM_GENERATION","VALIDATION","AUTHORIZATION"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_connectorinvocationstage"},"title":"Connector Invocation Stage","x-model-type":"ENUM"},"CreationEntityState":{"type":"string","enum":["CREATE","ACTIVE","INACTIVE","DELETING","DELETED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_creationentitystate"},"title":"Creation Entity State","x-model-type":"ENUM"},"Customer":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customer"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"metaData":{"type":"object","additionalProperties":{"type":"string"},"description":"Allow to store additional information about the object.","readOnly":true,"title":"Meta Data"},"emailAddress":{"type":"string","description":"The customer's email address.","maxLength":254,"readOnly":true,"title":"Email Address"},"familyName":{"type":"string","description":"The customer's family or last name.","maxLength":100,"readOnly":true,"title":"Family Name"},"givenName":{"type":"string","description":"The customer's given or first name.","maxLength":100,"readOnly":true,"title":"Given Name"},"preferredCurrency":{"type":"string","description":"The customer's preferred currency.","readOnly":true,"title":"Preferred Currency"},"customerId":{"type":"string","description":"The customer's ID in the merchant's system.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","readOnly":true,"title":"Customer Id"},"language":{"type":"string","description":"The language that is linked to the object.","readOnly":true,"title":"Language"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Customer","x-model-type":"READ"},"Customer.Active":{"allOf":[{"$ref":"#/components/schemas/Abstract.Customer.Active"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customer_active"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Customer","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customer_active"},"title":"Customer","x-model-type":"UPDATE"},"Customer.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.Customer.Active"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customer_create"},"title":"Customer","x-model-type":"CREATE"},"CustomerAddress":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customeraddress"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"address":{"$ref":"#/components/schemas/CustomerPostalAddress"},"addressType":{"$ref":"#/components/schemas/CustomerAddressType"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"customer":{"$ref":"#/components/schemas/Customer"},"defaultAddress":{"type":"boolean","description":"Whether this is the customer's default address.","readOnly":true,"title":"Default Address"}},"title":"Customer Address","x-expandable-fields":["customer"],"x-model-type":"READ"},"CustomerAddress.Active":{"allOf":[{"$ref":"#/components/schemas/Abstract.CustomerAddress.Active"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customeraddress_active"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Customer Address","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customeraddress_active"},"title":"Customer Address","x-model-type":"UPDATE"},"CustomerAddress.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.CustomerAddress.Active"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customeraddress_create"},"properties":{"customer":{"type":"integer","format":"int64","description":"The customer that the object belongs to.","title":"Customer"}},"required":["customer"],"title":"Customer Address","x-expandable-fields":["customer"],"x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customeraddress_create"},"title":"Customer Address","x-model-type":"CREATE"},"CustomerAddressType":{"type":"string","enum":["BILLING","SHIPPING","BOTH"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customeraddresstype"},"title":"Customer Address Type","x-model-type":"ENUM"},"CustomerComment":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customercomment"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"pinned":{"type":"boolean","description":"Whether the comment is pinned to the top.","readOnly":true,"title":"Pinned"},"editedBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was last updated by.","readOnly":true,"title":"Edited By"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was created by.","readOnly":true,"title":"Created By"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"editedOn":{"type":"string","format":"date-time","description":"The date and time when the comment was last updated.","readOnly":true,"title":"Edited On"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"content":{"type":"string","description":"The comment's actual content.","maxLength":262144,"readOnly":true,"title":"Content"},"customer":{"$ref":"#/components/schemas/Customer"}},"title":"Customer Comment","x-expandable-fields":["customer"],"x-model-type":"READ"},"CustomerComment.Active":{"allOf":[{"$ref":"#/components/schemas/Abstract.CustomerComment.Active"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customercomment_active"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Customer Comment","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customercomment_active"},"title":"Customer Comment","x-model-type":"UPDATE"},"CustomerComment.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.CustomerComment.Active"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customercomment_create"},"properties":{"customer":{"type":"integer","format":"int64","description":"The customer that the object belongs to.","title":"Customer"}},"required":["customer"],"title":"Customer Comment","x-expandable-fields":["customer"],"x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customercomment_create"},"title":"Customer Comment","x-model-type":"CREATE"},"CustomerPostalAddress":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customerpostaladdress"},"properties":{"country":{"type":"string","description":"The two-letter country code (ISO 3166 format).","readOnly":true,"title":"Country"},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","maxLength":100,"readOnly":true,"title":"Mobile Phone Number"},"gender":{"$ref":"#/components/schemas/Gender"},"organizationName":{"type":"string","description":"The organization's name.","maxLength":100,"readOnly":true,"title":"Organization Name"},"city":{"type":"string","description":"The city, town or village.","maxLength":100,"readOnly":true,"title":"City"},"commercialRegisterNumber":{"type":"string","description":"The commercial registration number of the organization.","maxLength":100,"readOnly":true,"title":"Commercial Register Number"},"socialSecurityNumber":{"type":"string","description":"The social security number.","maxLength":100,"readOnly":true,"title":"Social Security Number"},"givenName":{"type":"string","description":"The given or first name.","maxLength":100,"readOnly":true,"title":"Given Name"},"postcode":{"type":"string","description":"The postal code, also known as ZIP, postcode, etc.","maxLength":40,"readOnly":true,"title":"Postcode"},"legalOrganizationForm":{"$ref":"#/components/schemas/LegalOrganizationForm"},"salesTaxNumber":{"type":"string","description":"The sales tax number of the organization.","maxLength":100,"readOnly":true,"title":"Sales Tax Number"},"dateOfBirth":{"type":"string","format":"date","description":"The date of birth.","readOnly":true,"title":"Date Of Birth"},"dependentLocality":{"type":"string","description":"The dependent locality which is a sub-division of the state.","maxLength":100,"readOnly":true,"title":"Dependent Locality"},"emailAddress":{"type":"string","description":"The email address.","maxLength":254,"readOnly":true,"title":"Email Address"},"phoneNumber":{"type":"string","description":"The phone number.","maxLength":100,"readOnly":true,"title":"Phone Number"},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","maxLength":100,"readOnly":true,"title":"Sorting Code"},"street":{"type":"string","description":"The street or PO Box.","maxLength":300,"readOnly":true,"title":"Street"},"familyName":{"type":"string","description":"The family or last name.","maxLength":100,"readOnly":true,"title":"Family Name"},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","readOnly":true,"title":"State"},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","maxLength":20,"readOnly":true,"title":"Salutation"}},"title":"Customer Postal Address","x-model-type":"READ"},"CustomerPostalAddress.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customerpostaladdress_create"},"properties":{"country":{"type":"string","description":"The two-letter country code (ISO 3166 format).","title":"Country"},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","maxLength":100,"title":"Mobile Phone Number"},"gender":{"$ref":"#/components/schemas/Gender"},"organizationName":{"type":"string","description":"The organization's name.","maxLength":100,"title":"Organization Name"},"city":{"type":"string","description":"The city, town or village.","maxLength":100,"title":"City"},"commercialRegisterNumber":{"type":"string","description":"The commercial registration number of the organization.","maxLength":100,"title":"Commercial Register Number"},"socialSecurityNumber":{"type":"string","description":"The social security number.","maxLength":100,"title":"Social Security Number"},"givenName":{"type":"string","description":"The given or first name.","maxLength":100,"title":"Given Name"},"postcode":{"type":"string","description":"The postal code, also known as ZIP, postcode, etc.","maxLength":40,"title":"Postcode"},"legalOrganizationForm":{"type":"integer","format":"int64","description":"The legal form of the organization.","title":"Legal Organization Form"},"salesTaxNumber":{"type":"string","description":"The sales tax number of the organization.","maxLength":100,"title":"Sales Tax Number"},"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.","maxLength":100,"title":"Dependent Locality"},"emailAddress":{"type":"string","description":"The email address.","maxLength":254,"title":"Email Address"},"phoneNumber":{"type":"string","description":"The phone number.","maxLength":100,"title":"Phone Number"},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","maxLength":100,"title":"Sorting Code"},"street":{"type":"string","description":"The street or PO Box.","maxLength":300,"title":"Street"},"familyName":{"type":"string","description":"The family or last name.","maxLength":100,"title":"Family Name"},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","title":"State"},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","maxLength":20,"title":"Salutation"}},"title":"Customer Postal Address","x-model-type":"CREATE"},"CustomersPresence":{"type":"string","enum":["NOT_PRESENT","VIRTUAL_PRESENT","PHYSICAL_PRESENT"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_customerspresence"},"title":"Customer's Presence","x-model-type":"ENUM"},"DataCollectionType":{"type":"string","enum":["ONSITE","OFFSITE"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_datacollectiontype"},"title":"Data Collection Type","x-model-type":"ENUM"},"DeliveryIndication":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_deliveryindication"},"properties":{"completion":{"$ref":"#/components/schemas/TransactionCompletion"},"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.","readOnly":true,"title":"Planned Purge Date"},"automaticDecisionReason":{"$ref":"#/components/schemas/DeliveryIndicationDecisionReason"},"automaticallyDecidedOn":{"type":"string","format":"date-time","description":"The date and time when an automatic decision was made.","readOnly":true,"title":"Automatically Decided On"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"manuallyDecidedBy":{"type":"integer","format":"int64","description":"The ID of the user who manually decided the delivery indication's state.","readOnly":true,"title":"Manually Decided By"},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the delivery indication will expire.","readOnly":true,"title":"Timeout On"},"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.","readOnly":true,"title":"Manual Decision Timeout On"},"manuallyDecidedOn":{"type":"string","format":"date-time","description":"The date and time when a manual decision was made.","readOnly":true,"title":"Manually Decided On"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/DeliveryIndicationState"},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","readOnly":true,"title":"Linked Transaction"},"transaction":{"$ref":"#/components/schemas/Transaction"}},"title":"Delivery Indication","x-expandable-fields":["completion","transaction"],"x-model-type":"READ"},"DeliveryIndicationDecisionReason":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_deliveryindicationdecisionreason"},"properties":{"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Delivery Indication Decision Reason","x-expandable-fields":["description","name"],"x-model-type":"READ"},"DeliveryIndicationState":{"type":"string","enum":["PENDING","NOT_SUITABLE","MANUAL_CHECK_REQUIRED","SUITABLE"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_deliveryindicationstate"},"title":"Delivery Indication State","x-model-type":"ENUM"},"DocumentTemplate":{"type":"object","description":"A document template contains the customizations for a particular document template type.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_documenttemplate"},"properties":{"deliveryEnabled":{"type":"boolean","description":"Whether documents of this template should be delivered.","readOnly":true,"title":"Delivery Enabled"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"spaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Space ID"},"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.","readOnly":true,"title":"Default Template"},"name":{"type":"string","description":"The name used to identify the document template.","maxLength":100,"readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"templateResource":{"type":"string","description":"The resource path to a custom template to be used to generate PDF documents.","readOnly":true,"title":"Template Resource"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"type":{"$ref":"#/components/schemas/DocumentTemplateType"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Document Template","x-expandable-fields":["type"],"x-model-type":"READ"},"DocumentTemplateType":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_documenttemplatetype"},"properties":{"feature":{"$ref":"#/components/schemas/Feature"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the document template type.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"title":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized title of the document template type.","readOnly":true,"title":"Title"},"group":{"$ref":"#/components/schemas/DocumentTemplateTypeGroup"}},"title":"Document Template Type","x-expandable-fields":["description","feature","title"],"x-model-type":"READ"},"DocumentTemplateTypeGroup":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_documenttemplatetypegroup"},"properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"title":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized title of the group.","readOnly":true,"title":"Title"}},"title":"Document Template Type Group","x-expandable-fields":["title"],"x-model-type":"READ"},"DunningCase":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_dunningcase"},"properties":{"canceledOn":{"type":"string","format":"date-time","readOnly":true,"title":"Canceled On"},"derecognizedOn":{"type":"string","format":"date-time","readOnly":true,"title":"Derecognized On"},"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.","readOnly":true,"title":"Planned Purge Date"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"initialInvoice":{"$ref":"#/components/schemas/TransactionInvoice"},"succeededOn":{"type":"string","format":"date-time","readOnly":true,"title":"Succeeded On"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/DunningCaseState"},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","readOnly":true,"title":"Linked Transaction"},"failedOn":{"type":"string","format":"date-time","readOnly":true,"title":"Failed On"},"flow":{"$ref":"#/components/schemas/DunningFlow"}},"title":"Dunning Case","x-model-type":"READ"},"DunningCaseState":{"type":"string","enum":["RUNNING","SUSPENDED","CANCELED","DERECOGNIZED","FAILED","SUCCEEDED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_dunningcasestate"},"title":"Dunning Case State","x-model-type":"ENUM"},"DunningCondition":{"type":"object","description":"A dunning condition determines which dunning flow is applied on a dunning case.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_dunningcondition"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"name":{"type":"string","description":"The condition name is used internally to identify the condition. For example the name is used within search fields and hence it should be distinct and descriptive.","maxLength":100,"readOnly":true,"title":"Condition Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"type":{"type":"integer","format":"int64","description":"The selected dunning condition type defines what settings are available to be configured on the condition in the next step.","readOnly":true,"title":"Type"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Dunning Condition","x-model-type":"READ"},"DunningConditionType":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_dunningconditiontype"},"properties":{"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Dunning Condition Type","x-expandable-fields":["description","name"],"x-model-type":"READ"},"DunningFlow":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_dunningflow"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"name":{"type":"string","description":"The dunning flow name is used internally to identify the configuration in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.","readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"conditions":{"type":"array","description":"If a dunning flow meets all selected conditions, the dunning flow will be used to process the dunning case. If the conditions are not met the next dunning flow in line will be chosen according to the priorities.","items":{"type":"integer","format":"int64"},"readOnly":true,"title":"Conditions"},"priority":{"type":"integer","format":"int32","description":"The priority orders the dunning flows. As such the priority determines together with the conditions the dunning flow the selection mechanism for a particular invoice. A change of the priority affects all future selections.","readOnly":true,"title":"Priority"},"type":{"$ref":"#/components/schemas/DunningFlowType"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Dunning Flow","x-model-type":"READ"},"DunningFlowLevel":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_dunningflowlevel"},"properties":{"period":{"type":"string","description":"The duration of the level before switching to the next one.","readOnly":true,"title":"Period"},"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.","readOnly":true,"title":"Planned Purge Date"},"reminderTemplate":{"$ref":"#/components/schemas/DocumentTemplate"},"priority":{"type":"integer","format":"int32","description":"The priority indicates the sort order of the level. A low value indicates that the level is executed before any level with a higher value. Any change to this value affects future level selections. The value has to pe unique per dunning flow.","readOnly":true,"title":"Priority"},"title":{"type":"object","additionalProperties":{"type":"string"},"description":"The title is used to communicate the dunning level to the customer within the reminder.","readOnly":true,"title":"Level Title"},"processor":{"type":"integer","format":"int64","readOnly":true,"title":"Processor"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"documentText":{"type":"object","additionalProperties":{"type":"string"},"description":"This text is put in the reminder document of this dunning flow level.","readOnly":true,"title":"Document Text"},"name":{"type":"string","description":"The dunning flow level name is used internally to identify the dunning flow level. For example the name is used within search fields and hence it should be distinct and descriptive.","maxLength":100,"readOnly":true,"title":"Configuration Name"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"flow":{"$ref":"#/components/schemas/DunningFlow"}},"title":"Dunning Flow Level","x-expandable-fields":["documentText","title"],"x-model-type":"READ"},"DunningFlowLevelProcessor":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_dunningflowlevelprocessor"},"properties":{"feature":{"$ref":"#/components/schemas/Feature"},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Dunning Flow Level Processor","x-expandable-fields":["description","name"],"x-model-type":"READ"},"DunningFlowType":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_dunningflowtype"},"properties":{"specificCountry":{"type":"string","readOnly":true,"title":"Specific Country"},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Dunning Flow Type","x-expandable-fields":["description","name"],"x-model-type":"READ"},"Environment":{"type":"string","enum":["LIVE","PREVIEW"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_environment"},"title":"Environment","x-model-type":"ENUM"},"FailureCategory":{"type":"string","enum":["TEMPORARY_ISSUE","INTERNAL","END_USER","CONFIGURATION","DEVELOPER"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_failurecategory"},"title":"Failure Category","x-model-type":"ENUM"},"FailureReason":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_failurereason"},"properties":{"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"category":{"$ref":"#/components/schemas/FailureCategory"}},"title":"Failure Reason","x-expandable-fields":["description","name"],"x-model-type":"READ"},"Feature":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_feature"},"properties":{"requiredFeatures":{"type":"array","description":"The features that must be enabled for this feature to work properly.","items":{"type":"integer","format":"int64"},"readOnly":true,"title":"Required Features"},"visible":{"type":"boolean","description":"Whether the feature is visible to the user.","readOnly":true,"title":"Visible"},"logoPath":{"type":"string","description":"The path to the feature's logo image.","readOnly":true,"title":"Logo Path"},"sortOrder":{"type":"integer","format":"int32","description":"When listing features, they can be sorted by this number.","readOnly":true,"title":"Sort Order"},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"category":{"$ref":"#/components/schemas/FeatureCategory"},"beta":{"type":"boolean","description":"Whether the feature is in beta stage and there may still be some issues.","readOnly":true,"title":"Beta"}},"title":"Feature","x-expandable-fields":["description","name"],"x-model-type":"READ"},"FeatureCategory":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_featurecategory"},"properties":{"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"orderWeight":{"type":"integer","format":"int32","description":"When listing feature categories, they can be sorted by this number.","readOnly":true,"title":"Order Weight"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Feature Category","x-expandable-fields":["description","name"],"x-model-type":"READ"},"Gender":{"type":"string","enum":["MALE","FEMALE"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_gender"},"title":"Gender","x-model-type":"ENUM"},"HumanUser":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_humanuser"},"properties":{"mobilePhoneNumber":{"type":"string","description":"The user's mobile phone number.","maxLength":30,"readOnly":true,"title":"Mobile Phone Number"},"twoFactorEnabled":{"type":"boolean","description":"Whether two-factor authentication is enabled for this user.","readOnly":true,"title":"Two-Factor Authentication"},"emailAddress":{"type":"string","description":"The user's email address.","maxLength":128,"readOnly":true,"title":"Email Address"},"firstname":{"type":"string","description":"The user's first name.","maxLength":100,"readOnly":true,"title":"First Name"},"emailAddressVerified":{"type":"boolean","description":"Whether the user's email address has been verified.","readOnly":true,"title":"Email Address Verification"},"scope":{"type":"integer","format":"int64","description":"The scope that the user belongs to.","readOnly":true,"title":"Scope"},"timeZone":{"type":"string","description":"The user's time zone. If none is specified, the one provided by the browser will be used.","readOnly":true,"title":"Time Zone"},"language":{"type":"string","description":"The user's preferred language.","readOnly":true,"title":"Language"},"twoFactorType":{"$ref":"#/components/schemas/TwoFactorAuthenticationType"},"mobilePhoneVerified":{"type":"boolean","description":"Whether the user's mobile phone number has been verified.","readOnly":true,"title":"Mobile Phone Number Verification"},"primaryAccount":{"type":"integer","format":"int64","description":"The primary account that the user belongs to.","readOnly":true,"title":"Primary Account"},"lastname":{"type":"string","description":"The user's last name.","maxLength":100,"readOnly":true,"title":"Last Name"}},"title":"Human User","x-expandable-fields":["twoFactorType"],"x-model-type":"READ"},"HumanUser.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.HumanUser.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_humanuser_create"},"properties":{"primaryAccount":{"type":"integer","format":"int64","description":"The primary account that the user belongs to.","title":"Primary Account"}},"title":"Human User","x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_humanuser_create"},"title":"Human User","x-model-type":"CREATE"},"HumanUser.Update":{"allOf":[{"$ref":"#/components/schemas/Abstract.HumanUser.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_humanuser_update"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Human User","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_humanuser_update"},"title":"Human User","x-model-type":"UPDATE"},"Label":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_label"},"properties":{"contentAsString":{"type":"string","description":"The label's content formatted as string.","readOnly":true,"title":"Content As String"},"descriptor":{"$ref":"#/components/schemas/LabelDescriptor"},"content":{"description":"The label's actual content.","readOnly":true,"title":"Content"}},"title":"Label","x-expandable-fields":["descriptor"],"x-model-type":"READ"},"LabelDescriptor":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_labeldescriptor"},"properties":{"features":{"type":"array","description":"The features that this label belongs to.","items":{"$ref":"#/components/schemas/Feature"},"readOnly":true,"title":"Features","uniqueItems":true},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"weight":{"type":"integer","format":"int32","description":"When listing labels, they can be sorted by this number.","readOnly":true,"title":"Weight"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"category":{"$ref":"#/components/schemas/LabelDescriptorCategory"},"type":{"type":"integer","format":"int64","description":"The type of the label's value.","readOnly":true,"title":"Type"},"group":{"$ref":"#/components/schemas/LabelDescriptorGroup"}},"title":"Label Descriptor","x-expandable-fields":["description","features","group","name"],"x-model-type":"READ"},"LabelDescriptorCategory":{"type":"string","enum":["HUMAN","APPLICATION"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_labeldescriptorcategory"},"title":"Label Descriptor Category","x-model-type":"ENUM"},"LabelDescriptorGroup":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_labeldescriptorgroup"},"properties":{"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"weight":{"type":"integer","format":"int32","description":"When listing label groups, they can be sorted by this number.","readOnly":true,"title":"Weight"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Label Descriptor Group","x-expandable-fields":["description","name"],"x-model-type":"READ"},"LabelDescriptorType":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_labeldescriptortype"},"properties":{"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Label Descriptor Type","x-expandable-fields":["description","name"],"x-model-type":"READ"},"LegalOrganizationForm":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_legalorganizationform"},"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).","readOnly":true,"title":"Country"},"shortcut":{"type":"array","description":"The localized shortcuts of the legal organization form.","items":{"$ref":"#/components/schemas/LocalizedString"},"readOnly":true,"title":"Shortcut","uniqueItems":true},"englishDescription":{"type":"string","description":"The English name of the legal organization form.","readOnly":true,"title":"English Description"},"description":{"type":"array","description":"The localized descriptions of the legal organization form.","items":{"$ref":"#/components/schemas/LocalizedString"},"readOnly":true,"title":"Description","uniqueItems":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Legal Organization Form","x-model-type":"READ"},"LineItem":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_lineitem"},"properties":{"taxAmountPerUnit":{"type":"number","description":"The calculated tax amount per unit.","readOnly":true,"title":"Tax Amount Per Unit"},"undiscountedAmountExcludingTax":{"type":"number","description":"The line item price with discounts not applied, excluding taxes.","readOnly":true,"title":"Undiscounted Amount Excluding Tax"},"quantity":{"type":"number","description":"The number of items that were purchased.","readOnly":true,"title":"Quantity"},"undiscountedUnitPriceIncludingTax":{"type":"number","description":"The calculated price per unit with discounts not applied, including taxes.","readOnly":true,"title":"Undiscounted Unit Price Including Tax"},"amountExcludingTax":{"type":"number","description":"The line item price with discounts applied, excluding taxes.","readOnly":true,"title":"Amount Excluding Tax"},"undiscountedAmountIncludingTax":{"type":"number","description":"The line item price with discounts not applied, including taxes.","readOnly":true,"title":"Undiscounted Amount Including Tax"},"taxes":{"type":"array","description":"A set of tax lines, each of which specifies a tax applied to the item.","items":{"$ref":"#/components/schemas/Tax"},"readOnly":true,"title":"Taxes","uniqueItems":true},"type":{"$ref":"#/components/schemas/LineItemType"},"unitPriceIncludingTax":{"type":"number","description":"The calculated price per unit with discounts applied, including taxes.","readOnly":true,"title":"Unit Price Including Tax"},"discountExcludingTax":{"type":"number","description":"The discount allocated to the item, excluding taxes.","readOnly":true,"title":"Discount Excluding Tax"},"shippingRequired":{"type":"boolean","description":"Whether the item required shipping.","readOnly":true,"title":"Shipping Required"},"unitPriceExcludingTax":{"type":"number","description":"The calculated price per unit with discounts applied, excluding taxes.","readOnly":true,"title":"Unit Price Excluding Tax"},"name":{"type":"string","description":"The name of the product, ideally in the customer's language.","maxLength":150,"minLength":1,"readOnly":true,"title":"Name"},"attributes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/LineItemAttribute"},"description":"A map of custom information for the item.","readOnly":true,"title":"Attributes"},"undiscountedUnitPriceExcludingTax":{"type":"number","description":"The calculated price per unit with discounts not applied, excluding taxes.","readOnly":true,"title":"Undiscounted Unit Price Excluding Tax"},"amountIncludingTax":{"type":"number","description":"The line item price with discounts applied, including taxes.","readOnly":true,"title":"Amount Including Tax"},"discountIncludingTax":{"type":"number","description":"The discount allocated to the item, including taxes.","readOnly":true,"title":"Discount Including Tax"},"sku":{"type":"string","description":"The SKU (stock-keeping unit) of the product.","maxLength":200,"readOnly":true,"title":"SKU"},"taxAmount":{"type":"number","description":"The sum of all taxes applied to the item.","readOnly":true,"title":"Tax Amount"},"aggregatedTaxRate":{"type":"number","description":"The total tax rate applied to the item, calculated from the rates of all tax lines.","readOnly":true,"title":"Aggregated Tax Rate"},"uniqueId":{"type":"string","description":"The unique identifier of the line item within the set of line items.","maxLength":200,"readOnly":true,"title":"Unique ID"}},"title":"Line Item","x-model-type":"READ"},"LineItem.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_lineitem_create"},"properties":{"shippingRequired":{"type":"boolean","description":"Whether the item required shipping.","title":"Shipping Required"},"quantity":{"type":"number","description":"The number of items that were purchased.","title":"Quantity"},"name":{"type":"string","description":"The name of the product, ideally in the customer's language.","maxLength":150,"minLength":1,"title":"Name"},"taxes":{"type":"array","description":"A set of tax lines, each of which specifies a tax applied to the item.","items":{"$ref":"#/components/schemas/Tax.Create"},"title":"Taxes","uniqueItems":true},"attributes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/LineItemAttribute.Create"},"description":"A map of custom information for the item.","title":"Attributes"},"amountIncludingTax":{"type":"number","description":"The line item price with discounts applied, including taxes.","title":"Amount Including Tax"},"discountIncludingTax":{"type":"number","description":"The discount allocated to the item, including taxes.","title":"Discount Including Tax"},"sku":{"type":"string","description":"The SKU (stock-keeping unit) of the product.","maxLength":200,"title":"SKU"},"type":{"$ref":"#/components/schemas/LineItemType"},"uniqueId":{"type":"string","description":"The unique identifier of the line item within the set of line items.","maxLength":200,"title":"Unique ID"}},"required":["amountIncludingTax","name","quantity","type","uniqueId"],"title":"Line Item","x-model-type":"CREATE"},"LineItemAttribute":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_lineitemattribute"},"properties":{"label":{"type":"string","description":"The label describing the line item attribute.","maxLength":512,"readOnly":true,"title":"Label"},"value":{"type":"string","description":"The value of the line item attribute.","maxLength":512,"readOnly":true,"title":"Value"}},"title":"Line Item Attribute","x-model-type":"READ"},"LineItemAttribute.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_lineitemattribute_create"},"properties":{"label":{"type":"string","description":"The label describing the line item attribute.","maxLength":512,"title":"Label"},"value":{"type":"string","description":"The value of the line item attribute.","maxLength":512,"title":"Value"}},"required":["label","value"],"title":"Line Item Attribute . Create","x-model-type":"CREATE"},"LineItemReduction":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_lineitemreduction"},"properties":{"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.","readOnly":true,"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.","readOnly":true,"title":"Unit Price Reduction"},"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.","maxLength":200,"readOnly":true,"title":"Unique ID"}},"title":"Line Item Reduction","x-model-type":"READ"},"LineItemReduction.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_lineitemreduction_create"},"properties":{"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"},"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.","maxLength":200,"title":"Unique ID"}},"required":["lineItemUniqueId","quantityReduction","unitPriceReduction"],"title":"Line Item Reduction . Create","x-model-type":"CREATE"},"LineItemType":{"type":"string","enum":["SHIPPING","DISCOUNT","FEE","PRODUCT","TIP"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_lineitemtype"},"title":"Line Item Type","x-model-type":"ENUM"},"LocalizedString":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_localizedstring"},"properties":{"string":{"type":"string","description":"The localized term.","readOnly":true,"title":"String"},"language":{"type":"string","description":"The term's language.","readOnly":true,"title":"Language"}},"title":"Localized String","x-model-type":"READ"},"ManualTask":{"type":"object","description":"A manual task requires the manual intervention of a human.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_manualtask"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"contextEntityId":{"type":"integer","format":"int64","description":"The ID of the entity the manual task is linked to.","readOnly":true,"title":"Context Entity ID"},"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.","readOnly":true,"title":"Planned Purge Date"},"expiresOn":{"type":"string","format":"date-time","description":"The date and time until when the manual task has to be handled.","readOnly":true,"title":"Expires On"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/ManualTaskState"},"type":{"type":"integer","format":"int64","description":"The manual task's type.","readOnly":true,"title":"Type"},"actions":{"type":"array","description":"The actions that can be triggered to handle the manual task.","items":{"$ref":"#/components/schemas/ManualTaskAction"},"readOnly":true,"title":"Actions"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"}},"title":"Manual Task","x-expandable-fields":["actions"],"x-model-type":"READ"},"ManualTaskAction":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_manualtaskaction"},"properties":{"taskType":{"type":"integer","format":"int64","description":"The type of manual tasks this action belongs to.","readOnly":true,"title":"Task Type"},"style":{"$ref":"#/components/schemas/ManualTaskActionStyle"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"label":{"type":"object","additionalProperties":{"type":"string"},"description":"The action's label.","readOnly":true,"title":"Label"}},"title":"Manual Task Action","x-expandable-fields":["label"],"x-model-type":"READ"},"ManualTaskActionStyle":{"type":"string","enum":["DEFAULT","PRIMARY","DANGER"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_manualtaskactionstyle"},"title":"Manual Task Action Style","x-model-type":"ENUM"},"ManualTaskState":{"type":"string","enum":["OPEN","DONE","EXPIRED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_manualtaskstate"},"title":"Manual Task State","x-model-type":"ENUM"},"ManualTaskType":{"type":"object","description":"The manual task type indicates what kind of manual task is required to be executed by the human.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_manualtasktype"},"properties":{"features":{"type":"array","description":"The features that this type belongs to.","items":{"$ref":"#/components/schemas/Feature"},"readOnly":true,"title":"Features","uniqueItems":true},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Manual Task Type","x-expandable-fields":["description","features","name"],"x-model-type":"READ"},"OneClickPaymentMode":{"type":"string","enum":["DISABLED","ALLOW","FORCE"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_oneclickpaymentmode"},"title":"One Click Payment Mode","x-model-type":"ENUM"},"PanType":{"type":"string","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"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_pantype"},"title":"Pan Type","x-model-type":"ENUM"},"PaymentAppChargeAttemptTargetState":{"type":"string","description":"The target state indicates the state that should be set on the charge attempt.","enum":["SUCCESSFUL","FAILED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappchargeattempttargetstate"},"title":"Charge Attempt Target State","x-model-type":"ENUM"},"PaymentAppChargeAttemptUpdate":{"type":"object","description":"A request to update the state of a charge attempt. The charge attempt must be associated with a processor created by the invoking payment web app.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappchargeattemptupdate"},"properties":{"reference":{"type":"string","description":"A unique identifier for the charge attempt within the systems of the external service provider. This field is mandatory when the target state is set to 'SUCCESSFUL'.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","readOnly":false,"title":"Reference"},"targetState":{"$ref":"#/components/schemas/PaymentAppChargeAttemptTargetState","readOnly":false},"failureReason":{"type":"integer","format":"int64","description":"The reason for the charge attempt's failure. This field is mandatory when the target state is set to 'FAILED'.","readOnly":false,"title":"Failure Reason"},"endUserFailureMessage":{"type":"string","description":"A message explaining to the buyer why the payment failed. The message must be localized in the buyer's language, as specified in the payment page invocation URL.","maxLength":2000,"readOnly":false,"title":"End User Failure Message"}},"title":"Charge Attempt Update","x-model-type":"UPDATE"},"PaymentAppCompletionConfiguration":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappcompletionconfiguration"},"properties":{"multipleCompletionsSupported":{"type":"boolean","description":"Whether the payment connector can process multiple completions for a single transaction.","readOnly":true,"title":"Multiple Completions Supported"},"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.","readOnly":true,"title":"Maximum Completion Delay (in days)"},"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.","readOnly":true,"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.","readOnly":true,"title":"Completion Timeout (in minutes)"},"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.","readOnly":true,"title":"Void Endpoint"}},"title":"Completion Configuration","x-model-type":"READ"},"PaymentAppCompletionConfiguration.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappcompletionconfiguration_create"},"properties":{"multipleCompletionsSupported":{"type":"boolean","description":"Whether the payment connector can process multiple completions for a single transaction.","title":"Multiple Completions Supported"},"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)"},"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)"},"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"}},"title":"Completion Configuration","x-model-type":"UPDATE"},"PaymentAppCompletionTargetState":{"type":"string","description":"The target state indicates the state that should be set on the completion.","enum":["SUCCESSFUL","FAILED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappcompletiontargetstate"},"title":"Completion Target State","x-model-type":"ENUM"},"PaymentAppCompletionUpdate":{"type":"object","description":"A request to update the state of a completion. The completion must be associated with a processor created by the invoking payment web app.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappcompletionupdate"},"properties":{"reference":{"type":"string","description":"A unique identifier for the completion within the systems of the external service provider. This field is mandatory when the target state is set to 'SUCCESSFUL'.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","readOnly":false,"title":"Reference"},"targetState":{"$ref":"#/components/schemas/PaymentAppCompletionTargetState","readOnly":false},"failureReason":{"type":"integer","format":"int64","description":"The reason for the completion's failure. This field is mandatory when the target state is set to 'FAILED'.","readOnly":false,"title":"Failure Reason"}},"title":"Completion Update","x-model-type":"UPDATE"},"PaymentAppConnector":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappconnector"},"properties":{"paymentPageEndpoint":{"type":"string","description":"The URL where the user is redirected to process a payment. This endpoint is provided by the external service provider.","readOnly":true,"title":"Payment Page Endpoint"},"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.","maxLength":40,"readOnly":true,"title":"External ID"},"updatedOn":{"type":"string","format":"date-time","description":"The date and time when the connector was last updated.","readOnly":true,"title":"Updated On"},"completionConfiguration":{"$ref":"#/components/schemas/PaymentAppCompletionConfiguration"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the connector was created.","readOnly":true,"title":"Created On"},"processor":{"$ref":"#/components/schemas/PaymentAppProcessor"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"connectorConfiguration":{"$ref":"#/components/schemas/PaymentConnectorConfiguration"},"authorizationTimeout":{"type":"string","description":"The duration within which the authorization process for a payment should complete.","readOnly":true,"title":"Authorization Timeout"},"name":{"type":"string","description":"The name used to identify the connector.","maxLength":100,"readOnly":true,"title":"Name"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/PaymentAppConnectorState"},"refundConfiguration":{"$ref":"#/components/schemas/PaymentAppRefundConfiguration"}},"title":"Connector","x-expandable-fields":["connectorConfiguration","processor"],"x-model-type":"READ"},"PaymentAppConnectorDetails":{"allOf":[{"$ref":"#/components/schemas/Abstract.PaymentAppConnectorDetails"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappconnectordetails"},"title":"Connector Details","x-model-type":"UPDATE"},"PaymentAppConnectorDetails.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.PaymentAppConnectorDetails"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappconnectordetails_create"},"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.","maxLength":40,"minLength":1,"pattern":"[\t\\x20-\\x7e]*","readOnly":false,"title":"External ID"}},"title":"Connector Details","x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappconnectordetails_create"},"title":"Connector Details","x-model-type":"CREATE"},"PaymentAppConnectorState":{"type":"string","enum":["ACTIVE","DELETED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappconnectorstate"},"title":"Connector State","x-model-type":"ENUM"},"PaymentAppProcessor":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappprocessor"},"properties":{"documentationUrl":{"type":"string","description":"A URL pointing to the documentation that explains how to configure and use the processor.","readOnly":true,"title":"Documentation URL"},"configuredEnvironment":{"$ref":"#/components/schemas/ChargeAttemptEnvironment"},"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.","maxLength":40,"readOnly":true,"title":"External ID"},"svgIcon":{"type":"string","description":"An SVG icon representing the processor, displayed to the user in the interface.","maxLength":10000,"readOnly":true,"title":"SVG Icon"},"updatedOn":{"type":"string","format":"date-time","description":"The date and time when the processor was last updated.","readOnly":true,"title":"Updated On"},"usableInProduction":{"type":"boolean","description":"Whether the processor is fully prepared and available for handling transactions in a production environment.","readOnly":true,"title":"Usable In Production"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the processor was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"processorConfiguration":{"$ref":"#/components/schemas/PaymentProcessorConfiguration"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"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.","readOnly":true,"title":"Usable In Production Since"},"name":{"type":"string","description":"The name used to identify the processor.","maxLength":100,"readOnly":true,"title":"Name"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"installationId":{"type":"integer","format":"int64","description":"The installation ID identifies the Web App installation.","readOnly":true,"title":"Installation ID"},"productionModeUrl":{"type":"string","description":"A URL pointing to the site where merchants can set up production mode for the processor.","readOnly":true,"title":"Configure Production Mode URL"},"state":{"$ref":"#/components/schemas/PaymentAppProcessorState"}},"title":"Processor","x-expandable-fields":["processorConfiguration"],"x-model-type":"READ"},"PaymentAppProcessorDetails":{"allOf":[{"$ref":"#/components/schemas/Abstract.PaymentAppProcessorDetails"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappprocessordetails"},"title":"Processor Details","x-model-type":"UPDATE"},"PaymentAppProcessorDetails.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.PaymentAppProcessorDetails"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappprocessordetails_create"},"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.","maxLength":40,"minLength":1,"pattern":"[\t\\x20-\\x7e]*","readOnly":false,"title":"External ID"}},"title":"Processor Details","x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappprocessordetails_create"},"title":"Processor Details","x-model-type":"CREATE"},"PaymentAppProcessorState":{"type":"string","enum":["ACTIVE","DELETED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappprocessorstate"},"title":"Processor State","x-model-type":"ENUM"},"PaymentAppRefundConfiguration":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentapprefundconfiguration"},"properties":{"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.","readOnly":true,"title":"Refund Timeout (in minutes)"},"multipleRefundsSupported":{"type":"boolean","description":"Whether the payment connector can process multiple refunds for a single transaction.","readOnly":true,"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.","readOnly":true,"title":"Refund Endpoint"}},"title":"Refund Configuration","x-model-type":"READ"},"PaymentAppRefundConfiguration.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentapprefundconfiguration_create"},"properties":{"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)"},"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"}},"title":"Refund Configuration","x-model-type":"UPDATE"},"PaymentAppRefundTargetState":{"type":"string","description":"The target state indicates the state that should be set on the refund.","enum":["SUCCESSFUL","FAILED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentapprefundtargetstate"},"title":"Refund Target State","x-model-type":"ENUM"},"PaymentAppRefundUpdate":{"type":"object","description":"A request to update the state of a refund. The refund must be associated with a processor created by the invoking payment web app.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentapprefundupdate"},"properties":{"reference":{"type":"string","description":"A unique identifier for the refund within the systems of the external service provider. This field is mandatory when the target state is set to 'SUCCESSFUL'.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","readOnly":false,"title":"Reference"},"targetState":{"$ref":"#/components/schemas/PaymentAppRefundTargetState","readOnly":false},"failureReason":{"type":"integer","format":"int64","description":"The reason for the refund's failure. This field is mandatory when the target state is set to 'FAILED'.","readOnly":false,"title":"Failure Reason"}},"title":"Refund Update","x-model-type":"UPDATE"},"PaymentAppVoidTargetState":{"type":"string","description":"The target state indicates the state that should be set on the void.","enum":["SUCCESSFUL","FAILED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappvoidtargetstate"},"title":"Void Target State","x-model-type":"ENUM"},"PaymentAppVoidUpdate":{"type":"object","description":"A request to update the state of a void. The void must be associated with a processor created by the invoking payment web app.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentappvoidupdate"},"properties":{"reference":{"type":"string","description":"A unique identifier for the void within the systems of the external service provider. This field is mandatory when the target state is set to 'SUCCESSFUL'.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","readOnly":false,"title":"Reference"},"targetState":{"$ref":"#/components/schemas/PaymentAppVoidTargetState","readOnly":false},"failureReason":{"type":"integer","format":"int64","description":"The reason for the void's failure. This field is mandatory when the target state is set to 'FAILED'.","readOnly":false,"title":"Failure Reason"}},"title":"Void Update","x-model-type":"UPDATE"},"PaymentConnector":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentconnector"},"properties":{"supportedFeatures":{"type":"array","description":"The features that are supported by the connector.","items":{"$ref":"#/components/schemas/PaymentConnectorFeature"},"readOnly":true,"title":"Supported Features","uniqueItems":true},"supportedCustomersPresences":{"type":"array","description":"The types of customer's presence that are supported by the connector.","items":{"$ref":"#/components/schemas/CustomersPresence"},"readOnly":true,"title":"Supported Customers Presences","uniqueItems":true},"dataCollectionType":{"$ref":"#/components/schemas/DataCollectionType"},"deprecated":{"type":"boolean","description":"Whether the object was deprecated.","readOnly":true,"title":"Deprecated"},"primaryRiskTaker":{"$ref":"#/components/schemas/PaymentPrimaryRiskTaker"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"paymentMethodBrand":{"$ref":"#/components/schemas/PaymentMethodBrand"},"processor":{"$ref":"#/components/schemas/PaymentProcessor"},"deprecationReason":{"type":"object","additionalProperties":{"type":"string"},"description":"The deprecation reason describes why the object was deprecated.","readOnly":true,"title":"Deprecation Reason"},"supportedCurrencies":{"type":"array","description":"The currencies that are supported by the connector.","items":{"type":"string"},"readOnly":true,"title":"Supported Currencies","uniqueItems":true},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Payment Connector","x-expandable-fields":["description","name","paymentMethod","paymentMethodBrand","processor","supportedCurrencies","supportedFeatures"],"x-model-type":"READ"},"PaymentConnectorConfiguration":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentconnectorconfiguration"},"properties":{"paymentMethodConfiguration":{"$ref":"#/components/schemas/PaymentMethodConfiguration"},"imagePath":{"type":"string","description":"The URL to the connector's image.","readOnly":true,"title":"Image Path"},"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.","readOnly":true,"title":"Planned Purge Date"},"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.","readOnly":true,"title":"Priority"},"enabledSalesChannels":{"type":"array","description":"The sales channels for which the connector configuration is enabled. If empty, it is enabled for all sales channels.","items":{"$ref":"#/components/schemas/SalesChannel"},"readOnly":true,"title":"Enabled Sales Channels","uniqueItems":true},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"processorConfiguration":{"$ref":"#/components/schemas/PaymentProcessorConfiguration"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"connector":{"$ref":"#/components/schemas/PaymentConnector"},"name":{"type":"string","description":"The name used to identify the connector configuration.","maxLength":100,"readOnly":true,"title":"Name"},"enabledSpaceViews":{"type":"array","description":"The space views for which the connector configuration is enabled. If empty, it is enabled for all space views.","items":{"type":"integer","format":"int64"},"readOnly":true,"title":"Enabled Space Views","uniqueItems":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"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.","readOnly":true,"title":"Applicable For Transaction Processing"},"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.","items":{"$ref":"#/components/schemas/Condition"},"readOnly":true,"title":"Conditions"}},"title":"Payment Connector Configuration","x-expandable-fields":["conditions","connector","enabledSalesChannels","paymentMethodConfiguration","processorConfiguration"],"x-model-type":"READ"},"PaymentConnectorConfiguration.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.PaymentConnectorConfiguration.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentconnectorconfiguration_create"},"properties":{"paymentMethodConfiguration":{"type":"integer","format":"int64","description":"The payment method configuration that the connector configuration belongs to.","title":"Payment Method Configuration"},"connector":{"type":"integer","format":"int64","description":"The connector that the configuration is for.","title":"Connector"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"processorConfiguration":{"type":"integer","format":"int64","description":"The processor configuration that the connector configuration belongs to.","title":"Processor Configuration"}},"required":["connector","paymentMethodConfiguration","processorConfiguration","state"],"title":"Payment Connector Configuration","x-expandable-fields":["connector","paymentMethodConfiguration","processorConfiguration"],"x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentconnectorconfiguration_create"},"title":"Payment Connector Configuration","x-model-type":"CREATE"},"PaymentConnectorConfiguration.Update":{"allOf":[{"$ref":"#/components/schemas/Abstract.PaymentConnectorConfiguration.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentconnectorconfiguration_update"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Payment Connector Configuration","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentconnectorconfiguration_update"},"title":"Payment Connector Configuration","x-model-type":"UPDATE"},"PaymentConnectorFeature":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentconnectorfeature"},"properties":{"displayName":{"type":"string","description":"The localized name of the feature.","readOnly":true,"title":"Display Name"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Payment Connector Feature","x-model-type":"READ"},"PaymentContract":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentcontract"},"properties":{"contractType":{"$ref":"#/components/schemas/PaymentContractType"},"terminatedBy":{"type":"integer","format":"int64","description":"The ID of the user the contract was terminated by.","readOnly":true,"title":"Terminated By"},"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.","readOnly":true,"title":"External ID"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"terminatedOn":{"type":"string","format":"date-time","description":"The date and time when the contract was terminated.","readOnly":true,"title":"Terminated On"},"activatedOn":{"type":"string","format":"date-time","description":"The date and time when the contract was activated.","readOnly":true,"title":"Activated On"},"startTerminatingOn":{"type":"string","format":"date-time","description":"The date and time when the termination process of the contract was started.","readOnly":true,"title":"Start Terminating On"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the contract was created by.","readOnly":true,"title":"Created By"},"contractIdentifier":{"type":"string","description":"The identifier of the contract.","readOnly":true,"title":"Contract Identifier"},"rejectedOn":{"type":"string","format":"date-time","description":"The date and time when the contract was rejected.","readOnly":true,"title":"Rejected On"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/PaymentContractState"},"rejectionReason":{"$ref":"#/components/schemas/FailureReason"},"account":{"type":"integer","format":"int64","description":"This account that the contract belongs to.","readOnly":true,"title":"Account"}},"title":"Contract","x-expandable-fields":["contractType"],"x-model-type":"READ"},"PaymentContractState":{"type":"string","enum":["PENDING","ACTIVE","TERMINATING","TERMINATED","REJECTED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentcontractstate"},"title":"Payment Contract State","x-model-type":"ENUM"},"PaymentContractType":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentcontracttype"},"properties":{"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Contract Type","x-expandable-fields":["description","name"],"x-model-type":"READ"},"PaymentInformationHash":{"type":"object","description":"A payment information hash is generated from user input, ensuring consistent and collision-free results for identical inputs.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentinformationhash"},"properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"type":{"$ref":"#/components/schemas/PaymentInformationHashType"},"value":{"type":"string","description":"The hash value generated based on the specified type.","readOnly":true,"title":"Value"}},"title":"Payment Information Hash","x-model-type":"READ"},"PaymentInformationHashType":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentinformationhashtype"},"properties":{"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The name that describes the hash type.","readOnly":true,"title":"Name"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Payment Information Hash Type","x-expandable-fields":["name"],"x-model-type":"READ"},"PaymentMethod":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentmethod"},"properties":{"supportedCurrencies":{"type":"array","description":"The currencies that the payment method supports.","items":{"type":"string"},"readOnly":true,"title":"Supported Currencies","uniqueItems":true},"dataCollectionTypes":{"type":"array","description":"The data collection types that payment method supports.","items":{"$ref":"#/components/schemas/DataCollectionType"},"readOnly":true,"title":"Data Collection Types","uniqueItems":true},"imagePath":{"type":"string","description":"The path to the payment method's image.","readOnly":true,"title":"Image Path"},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"merchantDescription":{"type":"object","additionalProperties":{"type":"string"},"description":"A merchant-focused, localized description of the payment method, providing its purpose and details.","readOnly":true,"title":"Merchant Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Payment Method","x-expandable-fields":["description","merchantDescription","name","supportedCurrencies"],"x-model-type":"READ"},"PaymentMethodBrand":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentmethodbrand"},"properties":{"grayImagePath":{"type":"string","description":"The path to the payment method brand's grayscale image.","readOnly":true,"title":"Gray Image Path"},"imagePath":{"type":"string","description":"The path to the payment method brand's image.","readOnly":true,"title":"Image Path"},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"paymentMethod":{"type":"integer","format":"int64","description":"The payment method that the brand belongs to.","readOnly":true,"title":"Payment Method"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Payment Method Brand","x-expandable-fields":["description","name"],"x-model-type":"READ"},"PaymentMethodConfiguration":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentmethodconfiguration"},"properties":{"dataCollectionType":{"$ref":"#/components/schemas/DataCollectionType"},"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.","readOnly":true,"title":"Planned Purge Date"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"A customer-facing custom description for the payment method.","readOnly":true,"title":"Description"},"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.","readOnly":true,"title":"Resolved Image URL"},"oneClickPaymentMode":{"$ref":"#/components/schemas/OneClickPaymentMode"},"title":{"type":"object","additionalProperties":{"type":"string"},"description":"A customer-facing custom title for the payment method.","readOnly":true,"title":"Title"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"spaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","minimum":1,"readOnly":true,"title":"Space ID"},"imageResourcePath":{"type":"string","description":"The resource path to a custom image for the payment method, displayed to the customer for visual identification.","readOnly":true,"title":"Image Resource Path"},"sortOrder":{"type":"integer","format":"int32","description":"When listing payment methods, they can be sorted by this number.","readOnly":true,"title":"Sort Order"},"name":{"type":"string","description":"The name used to identify the payment method configuration.","maxLength":100,"readOnly":true,"title":"Name"},"resolvedDescription":{"type":"object","additionalProperties":{"type":"string"},"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.","readOnly":true,"title":"Resolved Description"},"resolvedTitle":{"type":"object","additionalProperties":{"type":"string"},"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.","readOnly":true,"title":"Resolved Title"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"}},"title":"Payment Method Configuration","x-expandable-fields":["description","paymentMethod","resolvedDescription","resolvedTitle","title"],"x-model-type":"READ"},"PaymentMethodConfiguration.Active":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodConfiguration.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentmethodconfiguration_active"},"properties":{"state":{"$ref":"#/components/schemas/CreationEntityState"}},"title":"Payment Method Configuration . Active","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentmethodconfiguration_active"},"title":"Payment Method Configuration . Active","x-model-type":"UPDATE"},"PaymentMethodConfiguration.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.PaymentMethodConfiguration.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentmethodconfiguration_create"},"properties":{"dataCollectionType":{"$ref":"#/components/schemas/DataCollectionType"},"paymentMethod":{"type":"integer","format":"int64","description":"The payment method that the configuration is for.","title":"Payment Method"},"state":{"$ref":"#/components/schemas/CreationEntityState"}},"required":["state","dataCollectionType","paymentMethod"],"title":"Payment Method Configuration . Create","x-expandable-fields":["paymentMethod"],"x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentmethodconfiguration_create"},"title":"Payment Method Configuration . Create","x-model-type":"CREATE"},"PaymentMethodConfiguration.Update":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentmethodconfiguration_update"},"properties":{"imageResourcePath":{"type":"string","description":"The resource path to a custom image for the payment method, displayed to the customer for visual identification.","title":"Image Resource Path"},"sortOrder":{"type":"integer","format":"int32","description":"When listing payment methods, they can be sorted by this number.","title":"Sort Order"},"name":{"type":"string","description":"The name used to identify the payment method configuration.","maxLength":100,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"A customer-facing custom description for the payment method.","title":"Description"},"oneClickPaymentMode":{"$ref":"#/components/schemas/OneClickPaymentMode"},"title":{"type":"object","additionalProperties":{"type":"string"},"description":"A customer-facing custom title for the payment method.","title":"Title"},"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Payment Method Configuration . Update","x-expandable-fields":["description","title"],"x-model-type":"UPDATE"},"PaymentPrimaryRiskTaker":{"type":"string","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"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentprimaryrisktaker"},"title":"Primary Risk Taker","x-model-type":"ENUM"},"PaymentProcessor":{"type":"object","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.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentprocessor"},"properties":{"companyName":{"type":"object","additionalProperties":{"type":"string"},"description":"The name of the company to which the processor belongs.","readOnly":true,"title":"Company Name"},"headquartersLocation":{"type":"object","additionalProperties":{"type":"string"},"description":"Where the processor's headquarters are located.","readOnly":true,"title":"Headquarters Location"},"logoPath":{"type":"string","description":"The path to the logo image of the processor.","readOnly":true,"title":"Logo Path"},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"productName":{"type":"object","additionalProperties":{"type":"string"},"description":"The name of the processor's product.","readOnly":true,"title":"Product Name"}},"title":"Payment Processor","x-expandable-fields":["companyName","description","headquartersLocation","name","productName"],"x-model-type":"READ"},"PaymentProcessorConfiguration":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentprocessorconfiguration"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"applicationManaged":{"type":"boolean","description":"Whether the processor configuration is managed by the application and therefore cannot be changed.","readOnly":true,"title":"Application-Managed"},"contractId":{"type":"integer","format":"int64","description":"The ID of the payment contract the processor configuration is linked to.","readOnly":true,"title":"Payment Contract ID"},"name":{"type":"string","description":"The name used to identify the payment method configuration.","maxLength":100,"readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"processor":{"$ref":"#/components/schemas/PaymentProcessor"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Payment Processor Configuration","x-expandable-fields":["processor"],"x-model-type":"READ"},"PaymentProcessorConfiguration.Active":{"allOf":[{"$ref":"#/components/schemas/Abstract.PaymentProcessorConfiguration.Active"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentprocessorconfiguration_active"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Payment Processor Configuration","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentprocessorconfiguration_active"},"title":"Payment Processor Configuration","x-model-type":"UPDATE"},"PaymentProcessorConfiguration.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.PaymentProcessorConfiguration.Active"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentprocessorconfiguration_create"},"properties":{"processor":{"type":"integer","format":"int64","description":"The payment processor that the configuration is for.","title":"Processor"}},"required":["processor"],"title":"Payment Processor Configuration","x-expandable-fields":["processor"],"x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentprocessorconfiguration_create"},"title":"Payment Processor Configuration","x-model-type":"CREATE"},"PaymentTerminal":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentterminal"},"properties":{"identifier":{"type":"string","description":"The unique identifier of the terminal, that is displayed on the device.","readOnly":true,"title":"Identifier"},"deactivatedOn":{"type":"string","format":"date-time","readOnly":true,"title":"Deactivated On"},"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.","readOnly":true,"title":"Planned Purge Date"},"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.","readOnly":true,"title":"External ID"},"type":{"$ref":"#/components/schemas/PaymentTerminalType"},"deviceName":{"type":"string","description":"The name of the device that is currently linked to the payment terminal.","readOnly":true,"title":"Device Name"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"deviceSerialNumber":{"type":"string","description":"The serial number of the device that is currently linked to the payment terminal.","readOnly":true,"title":"Device Serial Number"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"configurationVersion":{"$ref":"#/components/schemas/PaymentTerminalConfigurationVersion"},"locationVersion":{"$ref":"#/components/schemas/PaymentTerminalLocationVersion"},"activatedOn":{"type":"string","format":"date-time","readOnly":true,"title":"Activated On"},"decommissionedOn":{"type":"string","format":"date-time","readOnly":true,"title":"Decommissioned On"},"defaultCurrency":{"type":"string","description":"The default currency of the terminal.","readOnly":true,"title":"Default Currency"},"name":{"type":"string","description":"The name used to identify the payment terminal.","maxLength":100,"readOnly":true,"title":"Name"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/PaymentTerminalState"}},"title":"Terminal","x-expandable-fields":["configurationVersion","locationVersion"],"x-model-type":"READ"},"PaymentTerminalAddress":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentterminaladdress"},"properties":{"country":{"type":"string","description":"The two-letter country code (ISO 3166 format).","readOnly":true,"title":"Country"},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","maxLength":100,"readOnly":true,"title":"Mobile Phone Number"},"organizationName":{"type":"string","description":"The organization's name.","readOnly":true,"title":"Organization Name"},"city":{"type":"string","description":"The city, town or village.","readOnly":true,"title":"City"},"givenName":{"type":"string","description":"The given or first name.","readOnly":true,"title":"Given Name"},"postcode":{"type":"string","description":"The postal code, also known as ZIP, postcode, etc.","maxLength":12,"readOnly":true,"title":"Postcode"},"dependentLocality":{"type":"string","description":"The dependent locality which is a sub-division of the state.","maxLength":100,"readOnly":true,"title":"Dependent Locality"},"emailAddress":{"type":"string","description":"The email address.","maxLength":80,"readOnly":true,"title":"Email Address"},"phoneNumber":{"type":"string","description":"The phone number.","maxLength":20,"readOnly":true,"title":"Phone Number"},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","maxLength":100,"readOnly":true,"title":"Sorting Code"},"street":{"type":"string","description":"The street or PO Box.","readOnly":true,"title":"Street"},"familyName":{"type":"string","description":"The family or last name.","readOnly":true,"title":"Family Name"},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","readOnly":true,"title":"State"},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","maxLength":20,"readOnly":true,"title":"Salutation"}},"title":"Terminal Address","x-model-type":"READ"},"PaymentTerminalConfiguration":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentterminalconfiguration"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"name":{"type":"string","description":"The name used to identify the payment terminal configuration.","maxLength":100,"readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/PaymentTerminalConfigurationState"},"type":{"$ref":"#/components/schemas/PaymentTerminalType"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Terminal Configuration","x-model-type":"READ"},"PaymentTerminalConfigurationState":{"type":"string","enum":["CREATE","ACTIVE","DELETING","DELETED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentterminalconfigurationstate"},"title":"Payment Terminal Configuration State","x-model-type":"ENUM"},"PaymentTerminalConfigurationVersion":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentterminalconfigurationversion"},"properties":{"maintenanceWindowStart":{"type":"string","description":"The start time of the terminal's maintenance window.","readOnly":true,"title":"Maintenance Window Start"},"configuration":{"$ref":"#/components/schemas/PaymentTerminalConfiguration"},"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.","readOnly":true,"title":"Planned Purge Date"},"timeZone":{"type":"string","description":"The time zone of the payment terminal used to determine the maintenance window.","readOnly":true,"title":"Time Zone"},"versionAppliedImmediately":{"type":"boolean","description":"Whether payment terminals are immediately updated to this configuration version. If not, it will be applied during the maintenance window.","readOnly":true,"title":"Version Applied Immediately"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"connectorConfigurations":{"type":"array","description":"The payment connector configurations that are available on the payment terminal.","items":{"type":"integer","format":"int64"},"readOnly":true,"title":"Connector Configurations"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the payment terminal configuration version was created by.","readOnly":true,"title":"Created By"},"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.","readOnly":true,"title":"Default Currency"},"maintenanceWindowDuration":{"type":"string","description":"The permitted duration of the terminal's maintenance window.","readOnly":true,"title":"Maintenance Window Duration"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/PaymentTerminalConfigurationVersionState"}},"title":"Terminal Configuration Version","x-expandable-fields":["configuration"],"x-model-type":"READ"},"PaymentTerminalConfigurationVersionState":{"type":"string","enum":["PENDING","SCHEDULING","ACTIVE","DELETING","DELETED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentterminalconfigurationversionstate"},"title":"Payment Terminal Configuration Version State","x-model-type":"ENUM"},"PaymentTerminalLocation":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentterminallocation"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"productionMerchantId":{"type":"string","maxLength":15,"minLength":15,"pattern":"([0-9a-zA-Z])+","readOnly":true,"title":"Production Merchant Id"},"name":{"type":"string","description":"The name used to identify the payment terminal location.","maxLength":100,"readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"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.","readOnly":true,"title":"External ID"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/PaymentTerminalLocationState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Terminal Location","x-model-type":"READ"},"PaymentTerminalLocationState":{"type":"string","enum":["CREATE","ACTIVE","DELETING","DELETED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentterminallocationstate"},"title":"Payment Terminal Location State","x-model-type":"ENUM"},"PaymentTerminalLocationVersion":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentterminallocationversion"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"address":{"$ref":"#/components/schemas/PaymentTerminalAddress"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the payment terminal location version was created by.","readOnly":true,"title":"Created By"},"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.","readOnly":true,"title":"Planned Purge Date"},"contactAddress":{"$ref":"#/components/schemas/PaymentTerminalAddress"},"location":{"$ref":"#/components/schemas/PaymentTerminalLocation"},"versionAppliedImmediately":{"type":"boolean","description":"Whether payment terminals are immediately updated to this configuration version. If not, it will be applied during the maintenance window.","readOnly":true,"title":"Version Applied Immediately"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/PaymentTerminalLocationVersionState"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Terminal Location Version","x-expandable-fields":["address","contactAddress","location"],"x-model-type":"READ"},"PaymentTerminalLocationVersionState":{"type":"string","enum":["PENDING","SCHEDULING","ACTIVE","DELETING","DELETED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentterminallocationversionstate"},"title":"Payment Terminal Location Version State","x-model-type":"ENUM"},"PaymentTerminalReceiptType":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentterminalreceipttype"},"properties":{"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Terminal Receipt Type","x-expandable-fields":["description","name"],"x-model-type":"READ"},"PaymentTerminalState":{"type":"string","enum":["CREATE","PREPARING","ACTIVE","INACTIVE","DECOMMISSIONING","DECOMMISSIONED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentterminalstate"},"title":"Terminal State","x-model-type":"ENUM"},"PaymentTerminalType":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_paymentterminaltype"},"properties":{"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Terminal Type","x-expandable-fields":["description","name"],"x-model-type":"READ"},"Permission":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_permission"},"properties":{"parent":{"type":"integer","format":"int64","description":"The group that this permission belongs to.","readOnly":true,"title":"Parent"},"feature":{"$ref":"#/components/schemas/Feature"},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"pathToRoot":{"type":"array","description":"All parents of this permission up to the root of the permission tree.","items":{"type":"integer","format":"int64"},"readOnly":true,"title":"Path To Root"},"webAppEnabled":{"type":"boolean","readOnly":true,"title":"Web App Enabled"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"leaf":{"type":"boolean","description":"Whether this is a leaf in the tree of permissions, and not a group.","readOnly":true,"title":"Leaf"},"title":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Title"},"group":{"type":"boolean","description":"Whether this is a permission group.","readOnly":true,"title":"Group"},"twoFactorRequired":{"type":"boolean","description":"Whether users with this permission are required to enable two-factor authentication.","readOnly":true,"title":"Two Factor Required"}},"title":"Permission","x-expandable-fields":["description","feature","name","title"],"x-model-type":"READ"},"RecurringIndicator":{"type":"string","enum":["REGULAR_TRANSACTION","INITIAL_RECURRING_TRANSACTION","MERCHANT_INITIATED_RECURRING_TRANSACTION","CUSTOMER_INITIATED_RECURRING_TRANSACTION"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_recurringindicator"},"title":"Recurring Indicator","x-model-type":"ENUM"},"Refund":{"type":"object","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.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_refund"},"properties":{"totalSettledAmount":{"type":"number","description":"The total amount settled for the refund, factoring in reductions, taxes, and any additional applied fees.","readOnly":true,"title":"Total Settled Amount"},"reductions":{"type":"array","description":"The reductions applied on the original transaction items, detailing specific adjustments associated with the refund.","items":{"$ref":"#/components/schemas/LineItemReduction"},"readOnly":true,"title":"Reductions"},"baseLineItems":{"type":"array","description":"The original base line items from the transaction prior to the refund, serving as a reference for the refunded amounts.","items":{"$ref":"#/components/schemas/LineItem"},"readOnly":true,"title":"Base Line Items"},"processingOn":{"type":"string","format":"date-time","description":"The date and time when the processing of the refund was started.","readOnly":true,"title":"Processing On"},"taxes":{"type":"array","description":"The tax breakdown applied to the refund amount, helping with tax calculations or reporting.","items":{"$ref":"#/components/schemas/Tax"},"readOnly":true,"title":"Taxes","uniqueItems":true},"language":{"type":"string","description":"The language that is linked to the object.","readOnly":true,"title":"Language"},"type":{"$ref":"#/components/schemas/RefundType"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"lineItems":{"type":"array","description":"The line items included in the refund, representing the reductions.","items":{"$ref":"#/components/schemas/LineItem"},"readOnly":true,"title":"Line Items"},"metaData":{"type":"object","additionalProperties":{"type":"string"},"description":"Allow to store additional information about the object.","readOnly":true,"title":"Meta Data"},"succeededOn":{"type":"string","format":"date-time","description":"The date and time when the refund succeeded.","readOnly":true,"title":"Succeeded On"},"reducedLineItems":{"type":"array","description":"The line items from the original transaction, adjusted to reflect any reductions applied during the refund process.","items":{"$ref":"#/components/schemas/LineItem"},"readOnly":true,"title":"Reduced Line Items"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/RefundState"},"merchantReference":{"type":"string","description":"The merchant's reference used to identify the refund.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","readOnly":true,"title":"Merchant Reference"},"completion":{"type":"integer","format":"int64","description":"The transaction completion that the refund belongs to.","readOnly":true,"title":"Completion"},"amount":{"type":"number","description":"The total monetary amount of the refund, representing the exact credit issued to the customer.","readOnly":true,"title":"Amount"},"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.","readOnly":true,"title":"Planned Purge Date"},"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.","maxLength":100,"minLength":1,"pattern":"[\t\\x20-\\x7e]*","readOnly":true,"title":"External ID"},"timeZone":{"type":"string","description":"The time zone that this object is associated with.","readOnly":true,"title":"Time Zone"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"labels":{"type":"array","description":"The labels providing additional information about the object.","items":{"$ref":"#/components/schemas/Label"},"readOnly":true,"title":"Labels","uniqueItems":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the object will expire.","readOnly":true,"title":"Timeout On"},"environment":{"$ref":"#/components/schemas/Environment"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the refund was created by.","readOnly":true,"title":"Created By"},"nextUpdateOn":{"type":"string","format":"date-time","description":"The date and time when the next update of the object's state is planned.","readOnly":true,"title":"Next Update On"},"updatedInvoice":{"type":"integer","format":"int64","description":"An updated invoice reflecting adjustments made by the refund.","readOnly":true,"title":"Updated Invoice"},"failureReason":{"$ref":"#/components/schemas/FailureReason"},"totalAppliedFees":{"type":"number","description":"The sum of fees applied to the refund transaction, such as processing or service charges.","readOnly":true,"title":"Total Applied Fees"},"failedOn":{"type":"string","format":"date-time","description":"The date and time when the refund failed.","readOnly":true,"title":"Failed On"},"transaction":{"$ref":"#/components/schemas/Transaction"},"processorReference":{"type":"string","description":"The reference ID provided by the payment processor, used to trace the refund through the external payment system.","maxLength":150,"readOnly":true,"title":"Processor Reference"}},"title":"Refund","x-expandable-fields":["baseLineItems","labels","lineItems","reducedLineItems","reductions","taxes","transaction"],"x-model-type":"READ"},"Refund.Create":{"type":"object","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.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_refund_create"},"properties":{"completion":{"type":"integer","format":"int64","description":"The transaction completion that the refund belongs to.","title":"Completion"},"metaData":{"type":"object","additionalProperties":{"type":"string"},"description":"Allow to store additional information about the object.","title":"Meta Data"},"amount":{"type":"number","description":"The total monetary amount of the refund, representing the exact credit issued to the customer.","title":"Amount"},"reductions":{"type":"array","description":"The reductions applied on the original transaction items, detailing specific adjustments associated with the refund.","items":{"$ref":"#/components/schemas/LineItemReduction.Create"},"title":"Reductions"},"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.","maxLength":100,"minLength":1,"pattern":"[\t\\x20-\\x7e]*","title":"External ID"},"type":{"$ref":"#/components/schemas/RefundType"},"merchantReference":{"type":"string","description":"The merchant's reference used to identify the refund.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","title":"Merchant Reference"},"transaction":{"type":"integer","format":"int64","description":"The transaction that the refund belongs to.","title":"Transaction"}},"required":["externalId","type"],"title":"Refund Create","x-expandable-fields":["reductions","transaction"],"x-model-type":"CREATE"},"RefundComment":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_refundcomment"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"pinned":{"type":"boolean","description":"Whether the comment is pinned to the top.","readOnly":true,"title":"Pinned"},"editedBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was last updated by.","readOnly":true,"title":"Edited By"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was created by.","readOnly":true,"title":"Created By"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"editedOn":{"type":"string","format":"date-time","description":"The date and time when the comment was last updated.","readOnly":true,"title":"Edited On"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"content":{"type":"string","description":"The comment's actual content.","maxLength":262144,"readOnly":true,"title":"Content"},"refund":{"$ref":"#/components/schemas/Refund"}},"title":"Refund Comment","x-expandable-fields":["refund"],"x-model-type":"READ"},"RefundComment.Active":{"allOf":[{"$ref":"#/components/schemas/Abstract.RefundComment.Active"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_refundcomment_active"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Comment","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_refundcomment_active"},"title":"Comment","x-model-type":"UPDATE"},"RefundComment.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.RefundComment.Active"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_refundcomment_create"},"properties":{"refund":{"type":"integer","format":"int64","description":"The refund that the comment belongs to.","title":"Refund"}},"required":["refund"],"title":"Comment","x-expandable-fields":["refund"],"x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_refundcomment_create"},"title":"Comment","x-model-type":"CREATE"},"RefundState":{"type":"string","enum":["CREATE","SCHEDULED","PENDING","MANUAL_CHECK","FAILED","SUCCESSFUL"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_refundstate"},"title":"Refund State","x-model-type":"ENUM"},"RefundType":{"type":"string","enum":["MERCHANT_INITIATED_ONLINE","MERCHANT_INITIATED_OFFLINE","CUSTOMER_INITIATED_AUTOMATIC","CUSTOMER_INITIATED_MANUAL"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_refundtype"},"title":"Refund Type","x-model-type":"ENUM"},"RenderedDocument":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_rendereddocument"},"properties":{"documentTemplateType":{"type":"integer","format":"int64","description":"The document's template type","readOnly":true,"title":"Document Template Type"},"data":{"type":"string","format":"byte","description":"The binary data of the document","readOnly":true,"title":"Data"},"mimeType":{"type":"string","description":"The document's content type","readOnly":true,"title":"Mime Type"},"title":{"type":"string","description":"The title of the rendered document","readOnly":true,"title":"Title"}},"title":"Rendered Document","x-model-type":"READ"},"RenderedTerminalReceipt":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_renderedterminalreceipt"},"properties":{"printed":{"type":"boolean","description":"Whether the terminal's configuration mandates printing and the device has receipt printing capabilities.","readOnly":true,"title":"Printed"},"data":{"type":"string","format":"byte","description":"The receipt document data in binary format, presented as a Base64-encoded string.","readOnly":true,"title":"Data"},"receiptType":{"$ref":"#/components/schemas/PaymentTerminalReceiptType"},"mimeType":{"type":"string","description":"The MIME type specifies the format of the receipt document and is determined by the requested format.","readOnly":true,"title":"MIME Type"}},"title":"Rendered Terminal Receipt","x-model-type":"READ"},"RestAddressFormat":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_restaddressformat"},"properties":{"postCodeExamples":{"type":"array","description":"A list of sample post codes.","items":{"type":"string"},"readOnly":true,"title":"Post Code Examples"},"requiredFields":{"type":"array","description":"The fields that are required in the address format.","items":{"$ref":"#/components/schemas/RestAddressFormatField"},"readOnly":true,"title":"Required Fields","uniqueItems":true},"usedFields":{"type":"array","description":"The fields that are used in the address format.","items":{"$ref":"#/components/schemas/RestAddressFormatField"},"readOnly":true,"title":"Used Fields","uniqueItems":true},"postCodeRegex":{"type":"string","description":"The regular expression to validate post codes.","readOnly":true,"title":"Post Code Regex"}},"title":"Address Format","x-model-type":"READ"},"RestAddressFormatField":{"type":"string","enum":["GIVEN_NAME","FAMILY_NAME","ORGANIZATION_NAME","STREET","DEPENDENT_LOCALITY","CITY","POSTAL_STATE","POST_CODE","SORTING_CODE","COUNTRY"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_restaddressformatfield"},"title":"Address Format Field","x-model-type":"ENUM"},"RestApiBulkOperationResult":{"type":"object","description":"Represents the result of a single operation in a bulk request.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_restapibulkoperationresult"},"properties":{"link":{"type":"string","description":"The API path to call to get the processed object.","readOnly":true,"title":"Link"},"id":{"type":"integer","format":"int64","description":"The ID of the processed object.","readOnly":true,"title":"Id"},"error":{"$ref":"#/components/schemas/RestApiErrorResponse"},"statusCode":{"type":"integer","format":"int32","description":"The resulting HTTP status code of the single operation.","readOnly":true,"title":"Status Code"}},"title":"Bulk Operation Result","x-model-type":"READ"},"RestApiErrorResponse":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_restapierrorresponse"},"properties":{"date":{"type":"string","format":"date-time","description":"The date and time when the error occurred.","readOnly":true,"title":"Date"},"code":{"type":"string","description":"A brief explanation of the error that can be used to programmatically handle it.","readOnly":true,"title":"Code"},"id":{"type":"string","description":"The unique identifier of the error.","readOnly":true,"title":"Id"},"message":{"type":"string","description":"A human-readable message providing more details about the error.","readOnly":true,"title":"Message"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"A map of errors where the key represents the error identifier (such as field name or error context) and the value contains the detailed error message.","readOnly":true,"title":"Errors"}},"title":"Error Response","x-model-type":"READ"},"RestApplicationUserMacKey":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_restapplicationusermackey"},"properties":{"creationTime":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Creation Time"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/ApplicationKeyState"}},"title":"Application User Mac Key","x-model-type":"READ"},"RestApplicationUserMacKey.Created":{"allOf":[{"$ref":"#/components/schemas/RestApplicationUserMacKey"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_restapplicationusermackey_created"},"properties":{"key":{"type":"string","description":"The actual key to authenticate API requests.","readOnly":true,"title":"Key"}},"title":"Application User Mac Key","x-model-type":"READ"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_restapplicationusermackey_created"},"title":"Application User Mac Key","x-model-type":"READ"},"RestCountry":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_restcountry"},"properties":{"isoCode2":{"type":"string","description":"The country's two-letter code (ISO 3166-1 alpha-2 format).","readOnly":true,"title":"Two-letter Code"},"addressFormat":{"$ref":"#/components/schemas/RestAddressFormat"},"isoCode3":{"type":"string","description":"The country's three-letter code (ISO 3166-1 alpha-3 format).","readOnly":true,"title":"Three-letter Code"},"stateCodes":{"type":"array","description":"The codes of all regions (e.g. states, provinces) of the country (ISO 3166-2 format).","items":{"type":"string"},"readOnly":true,"title":"State Codes","uniqueItems":true},"name":{"type":"string","description":"The name of the country.","readOnly":true,"title":"Name"},"numericCode":{"type":"string","description":"The country's three-digit code (ISO 3166-1 numeric format).","readOnly":true,"title":"Numeric Code"}},"title":"Country","x-expandable-fields":["addressFormat","stateCodes"],"x-model-type":"READ"},"RestCountryState":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_restcountrystate"},"properties":{"code":{"type":"string","description":"The state's code used within addresses.","readOnly":true,"title":"Code"},"countryCode":{"type":"string","description":"The two-letter code of the state's country (ISO 3166-1 alpha-2 format).","readOnly":true,"title":"Country Code"},"name":{"type":"string","description":"The name of the state.","readOnly":true,"title":"Name"},"id":{"type":"string","description":"The state's code in ISO 3166-2 format.","readOnly":true,"title":"Id"}},"title":"State","x-model-type":"READ"},"RestCurrency":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_restcurrency"},"properties":{"name":{"type":"string","description":"The name of the currency.","readOnly":true,"title":"Name"},"fractionDigits":{"type":"integer","format":"int32","description":"The currency's number of decimals. When calculating amounts in this currency, the fraction digits determine the accuracy.","readOnly":true,"title":"Fraction Digits"},"currencyCode":{"type":"string","description":"The currency's three-letter code (ISO 4217 format).","readOnly":true,"title":"Currency Code"},"numericCode":{"type":"integer","format":"int32","description":"The currency's three-digit code (ISO 4217 format).","readOnly":true,"title":"Numeric Code"}},"title":"Currency","x-model-type":"READ"},"RestCustomerEmailAddress":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_restcustomeremailaddress"},"properties":{"emailAddress":{"type":"string","description":"An email address associated with a customer.","readOnly":true,"title":"Email Address"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"}},"title":"Customer Email Address","x-model-type":"READ"},"RestLanguage":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_restlanguage"},"properties":{"primaryOfGroup":{"type":"boolean","description":"Whether this is the primary language in a group of languages.","readOnly":true,"title":"Primary Of Group"},"countryCode":{"type":"string","description":"The two-letter code of the language's region (ISO 3166-1 alpha-2 format).","readOnly":true,"title":"Country Code"},"iso2Code":{"type":"string","description":"The language's two-letter code (ISO 639-1 format).","readOnly":true,"title":"Two-letter Code"},"name":{"type":"string","description":"The name of the language.","readOnly":true,"title":"Name"},"ietfCode":{"type":"string","description":"The language's IETF tag consisting of the two-letter ISO code and region e.g. en-US, de-CH.","readOnly":true,"title":"IETF Code"},"iso3Code":{"type":"string","description":"The language's three-letter code (ISO 639-2/T format).","readOnly":true,"title":"Three-letter Code"},"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.","readOnly":true,"title":"Plural Expression"}},"title":"Language","x-expandable-fields":["pluralExpression"],"x-model-type":"READ"},"Role":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_role"},"properties":{"permissions":{"type":"array","description":"The permissions granted to users with this role.","items":{"$ref":"#/components/schemas/Permission"},"readOnly":true,"title":"Permissions","uniqueItems":true},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The name used to identify the role.","readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional information that describes the role.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/RoleState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"account":{"$ref":"#/components/schemas/Account"},"twoFactorRequired":{"type":"boolean","description":"Whether users with this role are required to use two-factor authentication.","readOnly":true,"title":"Two-Factor Authentication Required"}},"title":"Role","x-expandable-fields":["account","description","name","permissions"],"x-model-type":"READ"},"Role.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.Role.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_role_create"},"properties":{"account":{"type":"integer","format":"int64","description":"The account the role belongs to. The role can only be assigned within this account.","title":"Account"}},"required":["account"],"title":"Role","x-expandable-fields":["account"],"x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_role_create"},"title":"Role","x-model-type":"CREATE"},"Role.Update":{"allOf":[{"$ref":"#/components/schemas/Abstract.Role.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_role_update"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Role","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_role_update"},"title":"Role","x-model-type":"UPDATE"},"RoleState":{"type":"string","enum":["CREATE","ACTIVE","DELETING","DELETED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_rolestate"},"title":"Role State","x-model-type":"ENUM"},"SalesChannel":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_saleschannel"},"properties":{"sortOrder":{"type":"integer","format":"int32","description":"When listing sales channels, they can be sorted by this number.","readOnly":true,"title":"Sort Order"},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Sales Channel","x-expandable-fields":["description","name"],"x-model-type":"READ"},"Scope":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_scope"},"properties":{"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.","readOnly":true,"title":"Planned Purge Date"},"sslActive":{"type":"boolean","description":"Whether the scope supports SSL.","readOnly":true,"title":"SSL Active"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"machineName":{"type":"string","description":"The name identifying the scope in e.g. URLs.","maxLength":50,"pattern":"([A-Z][A-Za-z0-9]+)(_([A-Z][A-Za-z0-9]+))*","readOnly":true,"title":"Machine Name"},"url":{"type":"string","description":"The URL where the scope can be accessed.","readOnly":true,"title":"Url"},"features":{"type":"array","description":"The list of features that are active in the scope.","items":{"$ref":"#/components/schemas/Feature"},"readOnly":true,"title":"Features","uniqueItems":true},"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.","items":{"type":"string"},"readOnly":true,"title":"Themes"},"port":{"type":"integer","format":"int32","description":"The port where the scope can be accessed.","minimum":1,"readOnly":true,"title":"Port"},"preprodDomainName":{"type":"string","description":"The preprod domain name that belongs to the scope.","maxLength":100,"readOnly":true,"title":"Preprod Domain Name"},"domainName":{"type":"string","description":"The domain name that belongs to the scope.","maxLength":100,"readOnly":true,"title":"Domain Name"},"name":{"type":"string","description":"The name used to identify the scope.","maxLength":50,"readOnly":true,"title":"Name"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"sandboxDomainName":{"type":"string","description":"The sandbox domain name that belongs to the scope.","maxLength":100,"readOnly":true,"title":"Sandbox Domain Name"}},"title":"Scope","x-expandable-fields":["features"],"x-model-type":"READ"},"ScopeSingleSignOnProvider":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_scopesinglesignonprovider"},"properties":{"signInUrl":{"type":"string","description":"The URL where the user will be redirected to sign in.","readOnly":true,"title":"Sign-in URL"},"scope":{"$ref":"#/components/schemas/Scope"},"name":{"type":"string","description":"The name used to identify the provider.","maxLength":100,"readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Single Sign-On Provider","x-model-type":"READ"},"SingleSignOnUser":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_singlesignonuser"},"properties":{"firstname":{"type":"string","description":"The user's first name.","maxLength":100,"readOnly":true,"title":"First Name"},"provider":{"type":"integer","format":"int64","description":"The single sign-on provider that this user belongs to.","readOnly":true,"title":"Provider"},"scope":{"type":"integer","format":"int64","description":"The scope that the user belongs to.","readOnly":true,"title":"Scope"},"timeZone":{"type":"string","description":"The user's time zone. If none is specified, the one provided by the browser will be used.","readOnly":true,"title":"Time Zone"},"language":{"type":"string","description":"The user's preferred language.","readOnly":true,"title":"Language"},"primaryAccount":{"type":"integer","format":"int64","description":"The primary account that the user belongs to.","readOnly":true,"title":"Primary Account"},"lastname":{"type":"string","description":"The user's last name.","maxLength":100,"readOnly":true,"title":"Last Name"}},"title":"Single Sign-On User","x-model-type":"READ"},"SingleSignOnUser.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.SingleSignOnUser.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_singlesignonuser_create"},"properties":{"provider":{"type":"integer","format":"int64","description":"The single sign-on provider that this user belongs to.","title":"Provider"},"primaryAccount":{"type":"integer","format":"int64","description":"The primary account that the user belongs to.","title":"Primary Account"}},"required":["provider"],"title":"Single Sign-On User","x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_singlesignonuser_create"},"title":"Single Sign-On User","x-model-type":"CREATE"},"SingleSignOnUser.Update":{"allOf":[{"$ref":"#/components/schemas/Abstract.SingleSignOnUser.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_singlesignonuser_update"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Single Sign-On User","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_singlesignonuser_update"},"title":"Single Sign-On User","x-model-type":"UPDATE"},"SortingOrder":{"type":"string","enum":["ASC","DESC"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_sortingorder"},"title":"Sorting Order","x-model-type":"ENUM"},"Space":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_space"},"properties":{"activeOrRestrictedActive":{"type":"boolean","description":"Whether this space and all its parent accounts are active or restricted active.","readOnly":true,"title":"Active Or Restricted Active"},"deletedOn":{"type":"string","format":"date-time","description":"The date and time when the space was deleted.","readOnly":true,"title":"Deleted On"},"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.","readOnly":true,"title":"Planned Purge Date"},"active":{"type":"boolean","description":"Whether this space and all its parent accounts are active.","readOnly":true,"title":"Active"},"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.","readOnly":true,"title":"Time Zone"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the space was created.","readOnly":true,"title":"Created On"},"primaryCurrency":{"type":"string","description":"The currency that is used to display aggregated amounts in the space.","readOnly":true,"title":"Primary Currency"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"deletedBy":{"type":"integer","format":"int64","description":"The ID of the user the space was deleted by.","readOnly":true,"title":"Deleted By"},"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.","readOnly":true,"title":"Request Limit"},"database":{"$ref":"#/components/schemas/TenantDatabase"},"postalAddress":{"$ref":"#/components/schemas/SpaceAddress"},"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.","readOnly":true,"title":"Restricted Active"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the space was created by.","readOnly":true,"title":"Created By"},"name":{"type":"string","description":"The name used to identify the space.","maxLength":200,"minLength":3,"readOnly":true,"title":"Name"},"technicalContactAddresses":{"type":"array","description":"The email address that will receive messages about technical issues and errors that occur in the space.","items":{"type":"string"},"readOnly":true,"title":"Technical Contact Addresses","uniqueItems":true},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"account":{"$ref":"#/components/schemas/Account"}},"title":"Space","x-expandable-fields":["account","database","postalAddress"],"x-model-type":"READ"},"Space.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.Space.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_space_create"},"properties":{"database":{"type":"integer","format":"int64","description":"The database the space is connected to and that holds the space's data.","title":"Database"},"account":{"type":"integer","format":"int64","description":"The account that the space belongs to.","title":"Account"}},"required":["account"],"title":"Space","x-expandable-fields":["account","database"],"x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_space_create"},"title":"Space","x-model-type":"CREATE"},"Space.Update":{"allOf":[{"$ref":"#/components/schemas/Abstract.Space.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_space_update"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Space","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_space_update"},"title":"Space","x-model-type":"UPDATE"},"SpaceAddress":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_spaceaddress"},"properties":{"country":{"type":"string","description":"The two-letter country code (ISO 3166 format).","readOnly":true,"title":"Country"},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","maxLength":100,"readOnly":true,"title":"Mobile Phone Number"},"organizationName":{"type":"string","description":"The organization's name.","maxLength":100,"readOnly":true,"title":"Organization Name"},"city":{"type":"string","description":"The city, town or village.","readOnly":true,"title":"City"},"givenName":{"type":"string","description":"The given or first name.","maxLength":100,"readOnly":true,"title":"Given Name"},"postcode":{"type":"string","description":"The postal code, also known as ZIP, postcode, etc.","readOnly":true,"title":"Postcode"},"salesTaxNumber":{"type":"string","description":"The sales tax number of the organization.","maxLength":100,"readOnly":true,"title":"Sales Tax Number"},"dependentLocality":{"type":"string","description":"The dependent locality which is a sub-division of the state.","maxLength":100,"readOnly":true,"title":"Dependent Locality"},"emailAddress":{"type":"string","description":"The email address used for communication with clients.","readOnly":true,"title":"Email Address"},"phoneNumber":{"type":"string","description":"The phone number.","maxLength":100,"readOnly":true,"title":"Phone Number"},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","maxLength":100,"readOnly":true,"title":"Sorting Code"},"street":{"type":"string","description":"The street or PO Box.","readOnly":true,"title":"Street"},"familyName":{"type":"string","description":"The family or last name.","maxLength":100,"readOnly":true,"title":"Family Name"},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","readOnly":true,"title":"State"},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","maxLength":20,"readOnly":true,"title":"Salutation"}},"title":"Space Address","x-model-type":"READ"},"SpaceAddress.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_spaceaddress_create"},"properties":{"country":{"type":"string","description":"The two-letter country code (ISO 3166 format).","title":"Country"},"mobilePhoneNumber":{"type":"string","description":"The phone number of a mobile phone.","maxLength":100,"title":"Mobile Phone Number"},"organizationName":{"type":"string","description":"The organization's name.","maxLength":100,"title":"Organization Name"},"city":{"type":"string","description":"The city, town or village.","title":"City"},"givenName":{"type":"string","description":"The given or first name.","maxLength":100,"title":"Given Name"},"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.","maxLength":100,"title":"Sales Tax Number"},"dependentLocality":{"type":"string","description":"The dependent locality which is a sub-division of the state.","maxLength":100,"title":"Dependent Locality"},"emailAddress":{"type":"string","description":"The email address used for communication with clients.","title":"Email Address"},"phoneNumber":{"type":"string","description":"The phone number.","maxLength":100,"title":"Phone Number"},"sortingCode":{"type":"string","description":"The sorting code identifying the post office where the PO Box is located.","maxLength":100,"title":"Sorting Code"},"street":{"type":"string","description":"The street or PO Box.","title":"Street"},"familyName":{"type":"string","description":"The family or last name.","maxLength":100,"title":"Family Name"},"postalState":{"type":"string","description":"The name of the region, typically a state, county, province or prefecture.","title":"State"},"salutation":{"type":"string","description":"The salutation e.g. Mrs, Mr, Dr.","maxLength":20,"title":"Salutation"}},"title":"Space Address","x-model-type":"CREATE"},"SpaceView":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_spaceview"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"name":{"type":"string","description":"The name used to identify the space view.","maxLength":200,"minLength":3,"readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"space":{"$ref":"#/components/schemas/Space"}},"title":"Space View","x-model-type":"READ"},"StaticValue":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_staticvalue"},"properties":{"features":{"type":"array","description":"The features that this static value belongs to.","items":{"type":"integer","format":"int64"},"readOnly":true,"title":"Features"},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Static Value","x-expandable-fields":["description","name"],"x-model-type":"READ"},"Tax":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_tax"},"properties":{"rate":{"type":"number","description":"The tax rate to be applied.","maximum":100,"readOnly":true,"title":"Rate"},"title":{"type":"string","description":"The name of the tax.","maxLength":40,"minLength":2,"readOnly":true,"title":"Title"}},"title":"Tax","x-model-type":"READ"},"Tax.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_tax_create"},"properties":{"rate":{"type":"number","description":"The tax rate to be applied.","maximum":100,"title":"Rate"},"title":{"type":"string","description":"The name of the tax.","maxLength":40,"minLength":2,"title":"Title"}},"required":["rate","title"],"title":"Tax (in creation)","x-model-type":"CREATE"},"TenantDatabase":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_tenantdatabase"},"properties":{"name":{"type":"string","description":"The name used to identify the database.","maxLength":200,"readOnly":true,"title":"Name"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Database","x-model-type":"READ"},"TerminalReceiptFormat":{"type":"string","enum":["PDF","TXT"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_terminalreceiptformat"},"title":"Terminal Receipt Format","x-model-type":"ENUM"},"Token":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_token"},"properties":{"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.","readOnly":true,"title":"Enabled For One-Click Payment"},"customerEmailAddress":{"type":"string","description":"The customer's email address.","maxLength":150,"readOnly":true,"title":"Customer Email Address"},"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.","readOnly":true,"title":"Planned Purge Date"},"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.","readOnly":true,"title":"External ID"},"timeZone":{"type":"string","description":"The customer's time zone, which affects how dates and times are formatted when communicating with the customer.","readOnly":true,"title":"Time Zone"},"language":{"type":"string","description":"The language that is linked to the object.","readOnly":true,"title":"Language"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"tokenReference":{"type":"string","description":"The reference used to identify the payment token (e.g. the customer's ID or email address).","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","readOnly":true,"title":"Token Reference"},"customerId":{"type":"string","description":"The unique identifier of the customer in the external system.","readOnly":true,"title":"Customer ID"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"}},"title":"Token","x-model-type":"READ"},"Token.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.Token.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_token_create"},"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":{"$ref":"#/components/schemas/CreationEntityState"}},"required":["externalId"],"title":"Token . Create","x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_token_create"},"title":"Token . Create","x-model-type":"CREATE"},"Token.Update":{"allOf":[{"$ref":"#/components/schemas/Abstract.Token.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_token_update"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Token . Update","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_token_update"},"title":"Token . Update","x-model-type":"UPDATE"},"TokenVersion":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_tokenversion"},"properties":{"paymentInformationHashes":{"type":"array","description":"The hashed payment information that the token version represents.","items":{"$ref":"#/components/schemas/PaymentInformationHash"},"readOnly":true,"title":"Payment Information Hashes","uniqueItems":true},"language":{"type":"string","description":"The language that is linked to the object.","readOnly":true,"title":"Language"},"type":{"$ref":"#/components/schemas/TokenVersionType"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"retryIn":{"type":"string","description":"Retry interval when the strategy advises retrying later.","readOnly":true,"title":"Retry In"},"paymentConnectorConfiguration":{"$ref":"#/components/schemas/PaymentConnectorConfiguration"},"obsoletedOn":{"type":"string","format":"date-time","description":"The date and time when the token version was marked obsolete.","readOnly":true,"title":"Obsoleted On"},"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.","readOnly":true,"title":"Expires On"},"iconUrl":{"type":"string","description":"The URL to the token's icon displayed to the customer.","readOnly":true,"title":"Icon Url"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/TokenVersionState"},"processorToken":{"type":"string","description":"The token name as specified by the processor.","maxLength":150,"readOnly":true,"title":"Processor Token"},"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.","readOnly":true,"title":"Planned Purge Date"},"paymentMethodBrand":{"$ref":"#/components/schemas/PaymentMethodBrand"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"lastRetriedOn":{"type":"string","format":"date-time","description":"The date and time when the system last attempted a retry for this token version.","readOnly":true,"title":"Last Retried On"},"labels":{"type":"array","description":"The labels providing additional information about the object.","items":{"$ref":"#/components/schemas/Label"},"readOnly":true,"title":"Labels","uniqueItems":true},"token":{"$ref":"#/components/schemas/Token"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"environment":{"$ref":"#/components/schemas/ChargeAttemptEnvironment"},"activatedOn":{"type":"string","format":"date-time","description":"The date and time when the token version was activated.","readOnly":true,"title":"Activated On"},"name":{"type":"string","description":"The name used to identify the token.","maxLength":150,"readOnly":true,"title":"Name"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"shippingAddress":{"$ref":"#/components/schemas/Address"},"billingAddress":{"$ref":"#/components/schemas/Address"},"retryStrategy":{"$ref":"#/components/schemas/TokenVersionRetryStrategy"}},"title":"Token Version","x-expandable-fields":["billingAddress","labels","paymentConnectorConfiguration","paymentMethod","paymentMethodBrand","shippingAddress","token","type"],"x-model-type":"READ"},"TokenVersionRetryStrategy":{"type":"string","enum":["NO_RETRY","RETRY_LATER","REFRESH_TOKEN"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_tokenversionretrystrategy"},"title":"Token Version Retry Strategy","x-model-type":"ENUM"},"TokenVersionState":{"type":"string","enum":["UNINITIALIZED","ACTIVE","OBSOLETE"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_tokenversionstate"},"title":"Token Version State","x-model-type":"ENUM"},"TokenVersionType":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_tokenversiontype"},"properties":{"feature":{"$ref":"#/components/schemas/Feature"},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Token Version Type","x-expandable-fields":["description","name"],"x-model-type":"READ"},"TokenizationMode":{"type":"string","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"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_tokenizationmode"},"title":"Tokenization Mode","x-model-type":"ENUM"},"TokenizedCardData":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_tokenizedcarddata"},"properties":{"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.","readOnly":true,"title":"Initial Recurring Transaction"},"recurringIndicator":{"$ref":"#/components/schemas/RecurringIndicator"},"tokenRequestorId":{"type":"string","description":"The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.","readOnly":true,"title":"Token Requestor Identifier (TRID)"},"cryptogram":{"$ref":"#/components/schemas/CardCryptogram"}},"title":"Tokenized Card Data","x-model-type":"READ"},"TokenizedCardData.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_tokenizedcarddata_create"},"properties":{"expiryDate":{"type":"string","description":"The expiry date of the card, indicating its validity period in yyyy-mm format (e.g., 2023-09).","pattern":"(\\d{4})-(11|12|10|0[1-9])","title":"Expiry Date"},"panType":{"$ref":"#/components/schemas/PanType"},"cardHolderName":{"type":"string","description":"The name of the cardholder, as printed on the card, identifying the card owner.","maxLength":100,"title":"Cardholder Name"},"cardVerificationCode":{"type":"string","description":"The security code used to validate the card during transactions.","maxLength":4,"minLength":3,"pattern":"([0-9 ]+)","title":"Card Verification Code (CVC)"},"primaryAccountNumber":{"type":"string","description":"The card's primary account number (PAN), the unique identifier of the card.","maxLength":30,"minLength":10,"pattern":"([0-9 ]+)","title":"Primary Account Number (PAN)"},"recurringIndicator":{"$ref":"#/components/schemas/RecurringIndicator"},"schemeTransactionReference":{"type":"string","description":"A reference specific to the card's transaction within its payment scheme.","maxLength":100,"title":"Scheme Transaction Reference"},"tokenRequestorId":{"type":"string","description":"The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.","title":"Token Requestor Identifier (TRID)"},"cryptogram":{"$ref":"#/components/schemas/CardCryptogram.Create"}},"required":["primaryAccountNumber"],"title":"Tokenized Card Data . Create","x-model-type":"CREATE"},"TokenizedCardRequest":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_tokenizedcardrequest"},"properties":{"cardData":{"$ref":"#/components/schemas/TokenizedCardData.Create","readOnly":false},"paymentMethodConfiguration":{"type":"integer","format":"int64","description":"The ID of the payment method configuration to use.","readOnly":false,"title":"Payment Method Configuration"}},"title":"Tokenized Card Request","x-model-type":"UPDATE"},"Transaction":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transaction"},"properties":{"parent":{"$ref":"#/components/schemas/Transaction"},"totalSettledAmount":{"type":"number","description":"The total amount that was settled, in the transaction's currency.","readOnly":true,"title":"Total Settled Amount"},"deviceSessionIdentifier":{"type":"string","description":"Allows to link the transaction to the data collected from the customer's device.","maxLength":40,"minLength":10,"pattern":"([a-zA-Z0-9_-])*","readOnly":true,"title":"Device Session Identifier"},"processingOn":{"type":"string","format":"date-time","description":"The date and time when the processing of the transaction was started.","readOnly":true,"title":"Processing On"},"invoiceMerchantReference":{"type":"string","description":"The merchant's reference used to identify the invoice.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","readOnly":true,"title":"Invoice Merchant Reference"},"language":{"type":"string","description":"The language that is linked to the object.","readOnly":true,"title":"Language"},"confirmedOn":{"type":"string","format":"date-time","description":"The date and time when the transaction was created.","readOnly":true,"title":"Confirmed On"},"lineItems":{"type":"array","description":"The line items purchased by the customer.","items":{"$ref":"#/components/schemas/LineItem"},"readOnly":true,"title":"Line Items"},"acceptLanguageHeader":{"type":"string","description":"The 'Accept Language' header of the customer's web browser.","readOnly":true,"title":"Accept Language Header"},"javaEnabled":{"type":"boolean","description":"Whether Java is enabled on the customer's web browser.","readOnly":true,"title":"Java Enabled"},"confirmedBy":{"type":"integer","format":"int64","description":"The ID of the user the transaction was confirmed by.","readOnly":true,"title":"Confirmed By"},"paymentConnectorConfiguration":{"$ref":"#/components/schemas/PaymentConnectorConfiguration"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/TransactionState"},"windowWidth":{"type":"string","description":"The window width of the customer's web browser.","readOnly":true,"title":"Window Width"},"allowedPaymentMethodConfigurations":{"type":"array","description":"The payment method configurations that can be used to authorize the transaction.","items":{"type":"integer","format":"int64"},"readOnly":true,"title":"Allowed Payment Method Configurations"},"group":{"$ref":"#/components/schemas/TransactionGroup"},"chargeRetryEnabled":{"type":"boolean","description":"Whether the customer can make further payment attempts if the first one has failed. Default is true.","readOnly":true,"title":"Charge Retry Enabled"},"acceptHeader":{"type":"string","description":"The 'Accept' header of the customer's web browser.","readOnly":true,"title":"Accept Header"},"userAgentHeader":{"type":"string","description":"The 'User Agent' header of the customer's web browser.","readOnly":true,"title":"User Agent Header"},"shippingMethod":{"type":"string","description":"The name of the shipping method used to ship the products.","maxLength":200,"readOnly":true,"title":"Shipping Method"},"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.","readOnly":true,"title":"Planned Purge Date"},"successUrl":{"type":"string","description":"The URL to redirect the customer back to after they successfully authenticated their payment.","maxLength":2000,"minLength":9,"readOnly":true,"title":"Success Url"},"timeZone":{"type":"string","description":"The customer's time zone, which affects how dates and times are formatted when communicating with the customer.","readOnly":true,"title":"Time Zone"},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","readOnly":true,"title":"Space View ID"},"userFailureMessage":{"type":"string","description":"The message that can be displayed to the customer explaining why the transaction failed, in the customer's language.","readOnly":true,"title":"User Failure Message"},"completionBehavior":{"$ref":"#/components/schemas/TransactionCompletionBehavior"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"internetProtocolAddressCountry":{"type":"string","description":"The country determined from the IP address of the customer's device.","readOnly":true,"title":"Internet Protocol Address Country"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"deliveryDecisionMadeOn":{"type":"string","format":"date-time","description":"This date and time when the decision was made as to whether the order should be shipped.","readOnly":true,"title":"Delivery Decision Made On"},"authorizationEnvironment":{"$ref":"#/components/schemas/ChargeAttemptEnvironment"},"autoConfirmationEnabled":{"type":"boolean","description":"Whether the transaction can be confirmed automatically or whether this must be done explicitly via the API. Default is true.","readOnly":true,"title":"Auto Confirmation Enabled"},"failureReason":{"$ref":"#/components/schemas/FailureReason"},"totalAppliedFees":{"type":"number","description":"The total of all fees charged, in the transaction's currency.","readOnly":true,"title":"Total Applied Fees"},"customersPresence":{"$ref":"#/components/schemas/CustomersPresence"},"failedOn":{"type":"string","format":"date-time","description":"The date and time when the transaction failed.","readOnly":true,"title":"Failed On"},"refundedAmount":{"type":"number","description":"The total amount that was refunded, in the transaction's currency.","readOnly":true,"title":"Refunded Amount"},"authorizationAmount":{"type":"number","description":"The sum of all line item prices including taxes in the transaction's currency.","readOnly":true,"title":"Authorization Amount"},"screenWidth":{"type":"string","description":"The screen width of the customer's web browser.","readOnly":true,"title":"Screen Width"},"environmentSelectionStrategy":{"$ref":"#/components/schemas/TransactionEnvironmentSelectionStrategy"},"customerEmailAddress":{"type":"string","description":"The customer's email address.","maxLength":254,"readOnly":true,"title":"Customer Email Address"},"windowHeight":{"type":"string","description":"The window height of the customer's web browser.","readOnly":true,"title":"Window Height"},"tokenizationMode":{"$ref":"#/components/schemas/TokenizationMode"},"authorizationTimeoutOn":{"type":"string","format":"date-time","description":"The date and time when the transaction must be authorized, otherwise it will canceled.","readOnly":true,"title":"Authorization Timeout On"},"allowedPaymentMethodBrands":{"type":"array","description":"The payment method brands that can be used to authorize the transaction.","items":{"type":"integer","format":"int64"},"readOnly":true,"title":"Allowed Payment Method Brands"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"metaData":{"type":"object","additionalProperties":{"type":"string"},"description":"Allow to store additional information about the object.","readOnly":true,"title":"Meta Data"},"emailsDisabled":{"type":"boolean","description":"Whether email sending is deactivated for the transaction. Default is false.","readOnly":true,"title":"Emails Disabled"},"userInterfaceType":{"$ref":"#/components/schemas/TransactionUserInterfaceType"},"customerId":{"type":"string","description":"The unique identifier of the customer in the external system.","readOnly":true,"title":"Customer ID"},"currency":{"type":"string","description":"The three-letter code (ISO 4217 format) of the transaction's currency.","readOnly":true,"title":"Currency"},"merchantReference":{"type":"string","description":"The merchant's reference used to identify the transaction.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","readOnly":true,"title":"Merchant Reference"},"authorizationSalesChannel":{"type":"integer","format":"int64","description":"The sales channel through which the transaction was placed.","readOnly":true,"title":"Sales Channel"},"yearsToKeep":{"type":"integer","format":"int32","description":"The number of years the transaction is kept after its authorization.","readOnly":true,"title":"Years To Keep"},"completedAmount":{"type":"number","description":"The total amount that was completed, in the transaction's currency.","readOnly":true,"title":"Completed Amount"},"screenHeight":{"type":"string","description":"The screen height of the customer's web browser.","readOnly":true,"title":"Screen Height"},"internetProtocolAddress":{"type":"string","description":"The IP address of the customer's device.","readOnly":true,"title":"Internet Protocol (IP) Address"},"terminal":{"$ref":"#/components/schemas/PaymentTerminal"},"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.","readOnly":true,"title":"End Of Life"},"token":{"$ref":"#/components/schemas/Token"},"environment":{"$ref":"#/components/schemas/Environment"},"screenColorDepth":{"type":"string","description":"The screen color depth of the customer's web browser.","readOnly":true,"title":"Screen Color Depth"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the transaction was created by.","readOnly":true,"title":"Created By"},"completedOn":{"type":"string","format":"date-time","description":"The date and time when the transaction was completed.","readOnly":true,"title":"Completed On"},"completionTimeoutOn":{"type":"string","format":"date-time","description":"The date and time when the transaction is completed automatically.","readOnly":true,"title":"Completion Timeout On"},"shippingAddress":{"$ref":"#/components/schemas/Address"},"billingAddress":{"$ref":"#/components/schemas/Address"},"authorizedOn":{"type":"string","format":"date-time","description":"The date and time when the transaction was authorized.","readOnly":true,"title":"Authorized On"},"failedUrl":{"type":"string","description":"The URL to redirect the customer back to after they canceled or failed to authenticated their payment.","maxLength":2000,"minLength":9,"readOnly":true,"title":"Failed Url"}},"title":"Transaction","x-expandable-fields":["billingAddress","group","lineItems","parent","paymentConnectorConfiguration","shippingAddress","terminal","token"],"x-model-type":"READ"},"Transaction.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.Transaction.Pending"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transaction_create"},"properties":{"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"},"lineItems":{"type":"array","description":"The line items purchased by the customer.","items":{"$ref":"#/components/schemas/LineItem.Create"},"title":"Line Items"},"emailsDisabled":{"type":"boolean","description":"Whether email sending is deactivated for the transaction. Default is false.","title":"Emails Disabled"},"environment":{"$ref":"#/components/schemas/Environment"},"environmentSelectionStrategy":{"$ref":"#/components/schemas/TransactionEnvironmentSelectionStrategy"},"deviceSessionIdentifier":{"type":"string","description":"Allows to link the transaction to the data collected from the customer's device.","maxLength":40,"minLength":10,"pattern":"([a-zA-Z0-9_-])*","title":"Device Session Identifier"},"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"},"shippingAddress":{"$ref":"#/components/schemas/Address.Create"},"billingAddress":{"$ref":"#/components/schemas/Address.Create"},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","title":"Space View ID"},"customersPresence":{"$ref":"#/components/schemas/CustomersPresence"},"token":{"type":"integer","format":"int64","description":"The payment token that should be used to charge the customer.","title":"Token"}},"required":["lineItems"],"title":"Transaction","x-expandable-fields":["billingAddress","lineItems","shippingAddress","token"],"x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transaction_create"},"title":"Transaction","x-model-type":"CREATE"},"Transaction.Pending":{"allOf":[{"$ref":"#/components/schemas/Abstract.Transaction.Pending"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transaction_pending"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Transaction","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transaction_pending"},"title":"Transaction","x-model-type":"UPDATE"},"TransactionClientPlatformInformation":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactionclientplatforminformation"},"properties":{"spaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Space ID"},"integrationType":{"type":"string","description":"The type of integration that was used to collect the payment information.","readOnly":true,"title":"Integration Type"},"osVersion":{"type":"string","description":"The version of the operating system that was used to collect the payment information.","readOnly":true,"title":"Os Version"},"platformType":{"type":"string","description":"The type of platform that was used to collect the payment information, e.g. Android or iOS.","readOnly":true,"title":"Platform Type"},"sdkVersion":{"type":"string","description":"The type of the SDK that was used to collect the payment information.","readOnly":true,"title":"Sdk Version"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"transaction":{"type":"integer","format":"int64","description":"The transaction that is associated with the client platform information.","readOnly":true,"title":"Transaction"}},"title":"Client Platform Information","x-model-type":"READ"},"TransactionComment":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioncomment"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"pinned":{"type":"boolean","description":"Whether the comment is pinned to the top.","readOnly":true,"title":"Pinned"},"editedBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was last updated by.","readOnly":true,"title":"Edited By"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was created by.","readOnly":true,"title":"Created By"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"editedOn":{"type":"string","format":"date-time","description":"The date and time when the comment was last updated.","readOnly":true,"title":"Edited On"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"content":{"type":"string","description":"The comment's actual content.","maxLength":262144,"readOnly":true,"title":"Content"},"transaction":{"$ref":"#/components/schemas/Transaction"}},"title":"Transaction Comment","x-expandable-fields":["transaction"],"x-model-type":"READ"},"TransactionComment.Active":{"allOf":[{"$ref":"#/components/schemas/Abstract.TransactionComment.Active"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioncomment_active"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Comment","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioncomment_active"},"title":"Comment","x-model-type":"UPDATE"},"TransactionComment.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.TransactionComment.Active"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioncomment_create"},"properties":{"transaction":{"type":"integer","format":"int64","description":"The transaction that the comment belongs to.","title":"Transaction"}},"required":["transaction"],"title":"Comment","x-expandable-fields":["transaction"],"x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioncomment_create"},"title":"Comment","x-model-type":"CREATE"},"TransactionCompletion":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioncompletion"},"properties":{"lineItemVersion":{"$ref":"#/components/schemas/TransactionLineItemVersion"},"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.","maxLength":80,"pattern":"[a-zA-Z0-9\\s.,_?+/-]*","readOnly":true,"title":"Statement Descriptor"},"baseLineItems":{"type":"array","description":"The original line items from the transaction that serve as the baseline for this completion.","items":{"$ref":"#/components/schemas/LineItem"},"readOnly":true,"title":"Base Line Items"},"processingOn":{"type":"string","format":"date-time","description":"The date and time when the processing of the transaction completion was started.","readOnly":true,"title":"Processing On"},"invoiceMerchantReference":{"type":"string","description":"The merchant's reference used to identify the invoice.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","readOnly":true,"title":"Invoice Merchant Reference"},"language":{"type":"string","description":"The language that is linked to the object.","readOnly":true,"title":"Language"},"remainingLineItems":{"type":"array","description":"The line items yet to be captured in the transaction.","items":{"$ref":"#/components/schemas/LineItem"},"readOnly":true,"title":"Remaining Line Items"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"lineItems":{"type":"array","description":"The line items captured in this transaction completion.","items":{"$ref":"#/components/schemas/LineItem"},"readOnly":true,"title":"Line Items"},"mode":{"$ref":"#/components/schemas/TransactionCompletionMode"},"metaData":{"type":"object","additionalProperties":{"type":"string"},"description":"Allow to store additional information about the object.","readOnly":true,"title":"Meta Data"},"succeededOn":{"type":"string","format":"date-time","description":"The date and time when the transaction completion succeeded.","readOnly":true,"title":"Succeeded On"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/TransactionCompletionState"},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","readOnly":true,"title":"Linked Transaction"},"paymentInformation":{"type":"string","description":"Payment-specific details related to this transaction completion such as payment instructions or references needed for processing.","readOnly":true,"title":"Payment Information"},"amount":{"type":"number","description":"The total amount to be captured in this completion, including taxes.","readOnly":true,"title":"Amount"},"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.","readOnly":true,"title":"Last Completion"},"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.","readOnly":true,"title":"Planned Purge Date"},"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.","maxLength":100,"minLength":1,"pattern":"[\t\\x20-\\x7e]*","readOnly":true,"title":"External ID"},"timeZone":{"type":"string","description":"The time zone that this object is associated with.","readOnly":true,"title":"Time Zone"},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","readOnly":true,"title":"Space View ID"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"labels":{"type":"array","description":"The labels providing additional information about the object.","items":{"$ref":"#/components/schemas/Label"},"readOnly":true,"title":"Labels","uniqueItems":true},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the object will expire.","readOnly":true,"title":"Timeout On"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the transaction completion was created by.","readOnly":true,"title":"Created By"},"nextUpdateOn":{"type":"string","format":"date-time","description":"The date and time when the next update of the object's state is planned.","readOnly":true,"title":"Next Update On"},"failureReason":{"$ref":"#/components/schemas/FailureReason"},"taxAmount":{"type":"number","description":"The portion of the captured amount that corresponds to taxes.","readOnly":true,"title":"Tax Amount"},"failedOn":{"type":"string","format":"date-time","description":"The date and time when the transaction completion failed.","readOnly":true,"title":"Failed On"},"processorReference":{"type":"string","description":"The reference ID provided by the payment processor, used to trace the completion through the external payment system.","readOnly":true,"title":"Processor Reference"}},"title":"Completion","x-expandable-fields":["baseLineItems","labels","lineItemVersion","lineItems","remainingLineItems"],"x-model-type":"READ"},"TransactionCompletionBehavior":{"type":"string","enum":["COMPLETE_IMMEDIATELY","COMPLETE_DEFERRED","USE_CONFIGURATION"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioncompletionbehavior"},"title":"Transaction Completion Behavior","x-model-type":"ENUM"},"TransactionCompletionDetails":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioncompletiondetails"},"properties":{"lineItems":{"type":"array","description":"The line items to be captured in the transaction completion.","items":{"$ref":"#/components/schemas/CompletionLineItem.Create"},"readOnly":false,"title":"Line Items"},"metaData":{"type":"object","additionalProperties":{"type":"string"},"description":"Allow to store additional information about the object.","readOnly":false,"title":"Meta Data"},"lastCompletion":{"type":"boolean","description":"Whether this is the final completion for the transaction, meaning no further completions can occur, and the transaction will move to its completed state upon success.","readOnly":false,"title":"Last Completion"},"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.","maxLength":80,"pattern":"[a-zA-Z0-9\\s.,_?+/-]*","readOnly":false,"title":"Statement Descriptor"},"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.","maxLength":100,"minLength":1,"pattern":"[\t\\x20-\\x7e]*","readOnly":false,"title":"External ID"},"invoiceMerchantReference":{"type":"string","description":"The merchant's reference used to identify the invoice.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","readOnly":false,"title":"Invoice Merchant Reference"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":false,"title":"ID"}},"title":"Completion Details","x-model-type":"CREATE"},"TransactionCompletionMode":{"type":"string","enum":["DIRECT","ONLINE","OFFLINE"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioncompletionmode"},"title":"Transaction Completion Mode","x-model-type":"ENUM"},"TransactionCompletionState":{"type":"string","enum":["CREATE","SCHEDULED","PENDING","FAILED","SUCCESSFUL"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioncompletionstate"},"title":"Transaction Completion State","x-model-type":"ENUM"},"TransactionEnvironmentSelectionStrategy":{"type":"string","enum":["FORCE_TEST_ENVIRONMENT","FORCE_PRODUCTION_ENVIRONMENT","USE_CONFIGURATION"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactionenvironmentselectionstrategy"},"title":"Transaction Environment Selection Strategy","x-model-type":"ENUM"},"TransactionGroup":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactiongroup"},"properties":{"beginDate":{"type":"string","format":"date-time","description":"The date and time when the initial transaction in the group was created.","readOnly":true,"title":"Begin Date"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"endDate":{"type":"string","format":"date-time","description":"The date and time when the final transaction in the group was last updated.","readOnly":true,"title":"End Date"},"customerId":{"type":"string","description":"The unique identifier of the customer in the external system.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","readOnly":true,"title":"Customer ID"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/TransactionGroupState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Transaction Group","x-model-type":"READ"},"TransactionGroupState":{"type":"string","enum":["PENDING","FAILED","SUCCESSFUL"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactiongroupstate"},"title":"Transaction Group State","x-model-type":"ENUM"},"TransactionInvoice":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioninvoice"},"properties":{"completion":{"$ref":"#/components/schemas/TransactionCompletion"},"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.","readOnly":true,"title":"Derecognized On"},"amount":{"type":"number","description":"The total sum of all line items on the invoice, including taxes.","readOnly":true,"title":"Amount"},"dueOn":{"type":"string","format":"date-time","description":"The due date for payment of the invoice.","readOnly":true,"title":"Due On"},"outstandingAmount":{"type":"number","description":"The remaining amount the buyer owes to the merchant. A negative value indicates the invoice has been overpaid.","readOnly":true,"title":"Outstanding Amount"},"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.","readOnly":true,"title":"Planned Purge Date"},"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.","maxLength":100,"minLength":1,"pattern":"[\t\\x20-\\x7e]*","readOnly":true,"title":"External ID"},"timeZone":{"type":"string","description":"The time zone that this object is associated with.","readOnly":true,"title":"Time Zone"},"language":{"type":"string","description":"The language that is linked to the object.","readOnly":true,"title":"Language"},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","readOnly":true,"title":"Space View ID"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"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.","readOnly":true,"title":"Paid On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"lineItems":{"type":"array","description":"The invoiced line items that will appear on the invoice document.","items":{"$ref":"#/components/schemas/LineItem"},"readOnly":true,"title":"Line Items"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"environment":{"$ref":"#/components/schemas/Environment"},"derecognizedBy":{"type":"integer","format":"int64","description":"The ID of the user the invoice was derecognized by.","readOnly":true,"title":"Derecognized By"},"billingAddress":{"$ref":"#/components/schemas/Address"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/TransactionInvoiceState"},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","readOnly":true,"title":"Linked Transaction"},"taxAmount":{"type":"number","description":"The portion of the invoiced amount that corresponds to taxes.","readOnly":true,"title":"Tax Amount"},"merchantReference":{"type":"string","description":"The merchant's reference used to identify the invoice.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","readOnly":true,"title":"Merchant Reference"}},"title":"Invoice","x-expandable-fields":["billingAddress","completion","lineItems"],"x-model-type":"READ"},"TransactionInvoiceComment":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioninvoicecomment"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"pinned":{"type":"boolean","description":"Whether the comment is pinned to the top.","readOnly":true,"title":"Pinned"},"editedBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was last updated by.","readOnly":true,"title":"Edited By"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the comment was created by.","readOnly":true,"title":"Created By"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"editedOn":{"type":"string","format":"date-time","description":"The date and time when the comment was last updated.","readOnly":true,"title":"Edited On"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"transactionInvoice":{"$ref":"#/components/schemas/TransactionInvoice"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"content":{"type":"string","description":"The comment's actual content.","maxLength":262144,"readOnly":true,"title":"Content"}},"title":"Invoice Comment","x-expandable-fields":["transactionInvoice"],"x-model-type":"READ"},"TransactionInvoiceComment.Active":{"allOf":[{"$ref":"#/components/schemas/Abstract.TransactionInvoiceComment.Active"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioninvoicecomment_active"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Comment","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioninvoicecomment_active"},"title":"Comment","x-model-type":"UPDATE"},"TransactionInvoiceComment.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.TransactionInvoiceComment.Active"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioninvoicecomment_create"},"properties":{"transactionInvoice":{"type":"integer","format":"int64","description":"The transaction invoice that the comment belongs to.","title":"Transaction Invoice"}},"required":["transactionInvoice"],"title":"Comment","x-expandable-fields":["transactionInvoice"],"x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioninvoicecomment_create"},"title":"Comment","x-model-type":"CREATE"},"TransactionInvoiceReplacement":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioninvoicereplacement"},"properties":{"lineItems":{"type":"array","description":"The invoiced line items that will appear on the invoice document.","items":{"$ref":"#/components/schemas/LineItem.Create"},"title":"Line Items"},"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.","maxLength":100,"minLength":1,"pattern":"[\t\\x20-\\x7e]*","title":"External ID"},"billingAddress":{"$ref":"#/components/schemas/Address.Create"},"sentToCustomer":{"type":"boolean","description":"Whether the invoice will be sent to the customer via email.","title":"Sent To Customer"},"merchantReference":{"type":"string","description":"The merchant's reference used to identify the invoice.","maxLength":100,"pattern":"[\t\\x20-\\x7e]*","title":"Merchant Reference"}},"required":["externalId","lineItems"],"title":"Invoice Replacement","x-model-type":"CREATE"},"TransactionInvoiceState":{"type":"string","enum":["CREATE","OPEN","OVERDUE","CANCELED","PAID","DERECOGNIZED","NOT_APPLICABLE"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactioninvoicestate"},"title":"Transaction Invoice State","x-model-type":"ENUM"},"TransactionLineItemVersion":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactionlineitemversion"},"properties":{"amount":{"type":"number","description":"The total amount of the updated line items, including taxes.","readOnly":true,"title":"Amount"},"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.","readOnly":true,"title":"Planned Purge Date"},"processingOn":{"type":"string","format":"date-time","description":"The date and time when the processing of the line item version was started.","readOnly":true,"title":"Processing 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.","readOnly":true,"title":"External ID"},"language":{"type":"string","description":"The language that is linked to the object.","readOnly":true,"title":"Language"},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","readOnly":true,"title":"Space View ID"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"labels":{"type":"array","description":"The labels providing additional information about the object.","items":{"$ref":"#/components/schemas/Label"},"readOnly":true,"title":"Labels","uniqueItems":true},"lineItems":{"type":"array","description":"The line items that replace the original line items in the transaction.","items":{"$ref":"#/components/schemas/LineItem"},"readOnly":true,"title":"Line Items"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time by when the line item version is expected to be processed.","readOnly":true,"title":"Timeout On"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the line item version was created by.","readOnly":true,"title":"Created By"},"nextUpdateOn":{"type":"string","format":"date-time","description":"The date and time when the next update of the line item version's state is planned.","readOnly":true,"title":"Next Update On"},"failureReason":{"$ref":"#/components/schemas/FailureReason"},"succeededOn":{"type":"string","format":"date-time","description":"The date and time when the line item version was processed successfully.","readOnly":true,"title":"Succeeded On"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/TransactionLineItemVersionState"},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","readOnly":true,"title":"Linked Transaction"},"taxAmount":{"type":"number","description":"The portion of the total amount that corresponds to taxes.","readOnly":true,"title":"Tax Amount"},"failedOn":{"type":"string","format":"date-time","description":"The date and time when the processing of the line item version failed.","readOnly":true,"title":"Failed On"},"transaction":{"$ref":"#/components/schemas/Transaction"}},"title":"Line Item Version","x-expandable-fields":["labels","lineItems","transaction"],"x-model-type":"READ"},"TransactionLineItemVersion.Create":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactionlineitemversion_create"},"properties":{"lineItems":{"type":"array","description":"The line items that replace the original line items in the transaction.","items":{"$ref":"#/components/schemas/LineItem.Create"},"title":"Line Items"},"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"},"transaction":{"type":"integer","format":"int64","description":"The transaction that the line item version belongs to.","title":"Transaction"}},"required":["externalId","lineItems","transaction"],"title":"Line Item Version","x-expandable-fields":["lineItems","transaction"],"x-model-type":"CREATE"},"TransactionLineItemVersionState":{"type":"string","enum":["CREATE","SCHEDULED","PENDING","SUCCESSFUL","FAILED"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactionlineitemversionstate"},"title":"Transaction Line Item Version State","x-model-type":"ENUM"},"TransactionState":{"type":"string","enum":["CREATE","PENDING","CONFIRMED","PROCESSING","FAILED","AUTHORIZED","VOIDED","COMPLETED","FULFILL","DECLINE"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactionstate"},"title":"Transaction State","x-model-type":"ENUM"},"TransactionUserInterfaceType":{"type":"string","enum":["IFRAME","LIGHTBOX","PAYMENT_PAGE","MOBILE_SDK","TERMINAL","CLOUD_TILL_INTERFACE","EXPRESS_CHECKOUT"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactionuserinterfacetype"},"title":"Transaction User Interface Type","x-model-type":"ENUM"},"TransactionVoid":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactionvoid"},"properties":{"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.","readOnly":true,"title":"Planned Purge Date"},"language":{"type":"string","description":"The language that is linked to the object.","readOnly":true,"title":"Language"},"spaceViewId":{"type":"integer","format":"int64","description":"The ID of the space view this object is linked to.","readOnly":true,"title":"Space View ID"},"createdOn":{"type":"string","format":"date-time","description":"The date and time when the object was created.","readOnly":true,"title":"Created On"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"labels":{"type":"array","description":"The labels providing additional information about the object.","items":{"$ref":"#/components/schemas/Label"},"readOnly":true,"title":"Labels","uniqueItems":true},"mode":{"$ref":"#/components/schemas/TransactionVoidMode"},"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"timeoutOn":{"type":"string","format":"date-time","description":"The date and time when the object will expire.","readOnly":true,"title":"Timeout On"},"createdBy":{"type":"integer","format":"int64","description":"The ID of the user the transaction void was created by.","readOnly":true,"title":"Created By"},"nextUpdateOn":{"type":"string","format":"date-time","description":"The date and time when the next update of the object's state is planned.","readOnly":true,"title":"Next Update On"},"failureReason":{"$ref":"#/components/schemas/FailureReason"},"succeededOn":{"type":"string","format":"date-time","description":"The date and time when the transaction void succeeded.","readOnly":true,"title":"Succeeded On"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/TransactionVoidState"},"linkedTransaction":{"type":"integer","format":"int64","description":"The payment transaction this object is linked to.","readOnly":true,"title":"Linked Transaction"},"failedOn":{"type":"string","format":"date-time","description":"The date and time when the transaction void failed.","readOnly":true,"title":"Failed On"},"transaction":{"$ref":"#/components/schemas/Transaction"},"processorReference":{"type":"string","description":"The reference ID provided by the payment processor, used to trace the void through the external payment system.","readOnly":true,"title":"Processor Reference"}},"title":"Transaction Void","x-expandable-fields":["labels","transaction"],"x-model-type":"READ"},"TransactionVoidMode":{"type":"string","enum":["ONLINE","OFFLINE"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactionvoidmode"},"title":"Transaction Void Mode","x-model-type":"ENUM"},"TransactionVoidState":{"type":"string","enum":["CREATE","PENDING","FAILED","SUCCESSFUL"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_transactionvoidstate"},"title":"Transaction Void State","x-model-type":"ENUM"},"TwoFactorAuthenticationType":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_twofactorauthenticationtype"},"properties":{"feature":{"type":"integer","format":"int64","description":"The feature that this type belongs to.","readOnly":true,"title":"Feature"},"icon":{"type":"string","description":"The identifier of the icon representing this type.","readOnly":true,"title":"Icon"},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Two Factor Authentication Type","x-expandable-fields":["description","name"],"x-model-type":"READ"},"User":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_user"},"properties":{"scope":{"type":"integer","format":"int64","description":"The scope that the user belongs to.","readOnly":true,"title":"Scope"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"userType":{"$ref":"#/components/schemas/UserType"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"User","x-model-type":"READ"},"UserAccountRole":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_useraccountrole"},"properties":{"role":{"type":"integer","format":"int64","description":"The role that is assigned to the user.","readOnly":true,"title":"Role"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"appliesOnSubAccount":{"type":"boolean","description":"Whether the role is assigned to the user in subaccounts only.","readOnly":true,"title":"Applies On Sub Account"},"user":{"type":"integer","format":"int64","description":"The user whose role this defines.","readOnly":true,"title":"User"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"account":{"type":"integer","format":"int64","description":"The account in which the role is assigned to the user.","readOnly":true,"title":"Account"}},"title":"User Account Role","x-model-type":"READ"},"UserSpaceRole":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_userspacerole"},"properties":{"role":{"type":"integer","format":"int64","description":"The role that is assigned to the user.","readOnly":true,"title":"Role"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"user":{"type":"integer","format":"int64","description":"The user whose role this defines.","readOnly":true,"title":"User"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"space":{"type":"integer","format":"int64","description":"The space in which the role is assigned to the user.","readOnly":true,"title":"Space"}},"title":"User Space Role","x-model-type":"READ"},"UserType":{"type":"string","enum":["HUMAN_USER","SINGLE_SIGNON_USER","APPLICATION_USER","ANONYMOUS_USER","SERVER_USER"],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_usertype"},"title":"User Type","x-model-type":"ENUM"},"WalletType":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_wallettype"},"properties":{"requiredFeatures":{"type":"array","items":{"$ref":"#/components/schemas/Feature"},"readOnly":true,"title":"Required Features","uniqueItems":true},"feature":{"$ref":"#/components/schemas/Feature"},"sortOrder":{"type":"integer","format":"int32","readOnly":true,"title":"Sort Order"},"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized name of the object.","readOnly":true,"title":"Name"},"description":{"type":"object","additionalProperties":{"type":"string"},"description":"The localized description of the object.","readOnly":true,"title":"Description"},"navigationPath":{"type":"string","readOnly":true,"title":"Navigation Path"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"}},"title":"Wallet Type","x-expandable-fields":["description","name"],"x-model-type":"READ"},"WebAppConfirmationResponse":{"type":"object","description":"The confirmation response provides details about the installation of the web app.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_webappconfirmationresponse"},"properties":{"access_token":{"type":"string","description":"The access code granting permissions to the web service API according to the OAuth standard.","readOnly":true,"title":"Access _ token"},"scope":{"type":"string","description":"The list of the permissions granted to the web app within the space.","readOnly":true,"title":"Scope"},"state":{"type":"string","description":"The state parameter that was provided in the authorization request.","readOnly":true,"title":"State"},"token_type":{"type":"string","description":"The type of the access token that determines the authentication mechanism to use for accessing the web service API.","readOnly":true,"title":"Token _ type"},"space":{"$ref":"#/components/schemas/Space"}},"title":"Web App Confirmation Response","x-expandable-fields":["space"],"x-model-type":"READ"},"WebhookIdentity":{"type":"object","description":"The webhook identity represents a set of keys that will be used to sign the webhook messages.","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_webhookidentity"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"name":{"type":"string","description":"The name used to identify the webhook identity.","maxLength":50,"readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"}},"title":"Webhook Identity","x-model-type":"READ"},"WebhookListener":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_webhooklistener"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"entityStates":{"type":"array","description":"The entity's target states that are to be monitored.","items":{"type":"string"},"readOnly":true,"title":"Entity States","uniqueItems":true},"identity":{"$ref":"#/components/schemas/WebhookIdentity"},"name":{"type":"string","description":"The name used to identify the webhook listener.","maxLength":50,"readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"notifyEveryChange":{"type":"boolean","description":"Whether every update of the entity or only state changes are to be monitored.","readOnly":true,"title":"Notify Every Change"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"enablePayloadSignatureAndState":{"type":"boolean","description":"Whether signature header and 'state' property are enabled in webhook payload.","readOnly":true,"title":"Enable Payload Signature And State"},"entity":{"type":"integer","format":"int64","description":"The entity that is to be monitored.","readOnly":true,"title":"Entity"},"url":{"$ref":"#/components/schemas/WebhookUrl"}},"title":"Webhook Listener","x-model-type":"READ"},"WebhookListener.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.WebhookListener.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_webhooklistener_create"},"properties":{"identity":{"type":"integer","format":"int64","description":"The identity used to sign messages.","title":"Identity"},"entity":{"type":"integer","format":"int64","description":"The entity that is to be monitored.","title":"Entity"},"url":{"type":"integer","format":"int64","description":"The URL where notifications about entity changes are sent to.","title":"Url"}},"required":["entity","url"],"title":"Webhook Listener","x-model-type":"CREATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_webhooklistener_create"},"title":"Webhook Listener","x-model-type":"CREATE"},"WebhookListener.Update":{"allOf":[{"$ref":"#/components/schemas/Abstract.WebhookListener.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_webhooklistener_update"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Webhook Listener","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_webhooklistener_update"},"title":"Webhook Listener","x-model-type":"UPDATE"},"WebhookListenerEntity":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_webhooklistenerentity"},"properties":{"name":{"type":"object","additionalProperties":{"type":"string"},"description":"The name used to identify the webhook listener entity.","readOnly":true,"title":"Name"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"technicalName":{"type":"string","description":"The name used to programmatically identify the webhook listener entity.","readOnly":true,"title":"Technical Name"}},"title":"Webhook Listener Entity","x-expandable-fields":["name"],"x-model-type":"READ"},"WebhookUrl":{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_webhookurl"},"properties":{"linkedSpaceId":{"type":"integer","format":"int64","description":"The ID of the space this object belongs to.","readOnly":true,"title":"Linked Space ID"},"applicationManaged":{"type":"boolean","description":"Whether the webhook URL is managed by the application, and therefore cannot be changed via the user interface.","readOnly":true,"title":"Application Managed"},"name":{"type":"string","description":"The name used to identify the webhook URL.","maxLength":50,"readOnly":true,"title":"Name"},"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.","readOnly":true,"title":"Planned Purge Date"},"id":{"type":"integer","format":"int64","description":"A unique identifier for the object.","readOnly":true,"title":"ID"},"state":{"$ref":"#/components/schemas/CreationEntityState"},"version":{"type":"integer","format":"int32","description":"The version is used for optimistic locking and incremented whenever the object is updated.","readOnly":true,"title":"Version"},"url":{"type":"string","description":"The actual URL where notifications about entity changes are sent to.","maxLength":500,"minLength":9,"readOnly":true,"title":"Url"}},"title":"Webhook URL","x-model-type":"READ"},"WebhookUrl.Create":{"allOf":[{"$ref":"#/components/schemas/Abstract.WebhookUrl.Update"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_webhookurl_create"},"title":"Webhook URL","x-model-type":"CREATE"},"WebhookUrl.Update":{"allOf":[{"$ref":"#/components/schemas/Abstract.WebhookUrl.Update"},{"type":"object","externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_webhookurl_update"},"properties":{"version":{"type":"integer","format":"int32","description":"The version number indicates the version of the entity. The version is incremented whenever the entity is changed.","title":"Version"}},"required":["version"],"title":"Webhook URL","x-model-type":"UPDATE"}],"externalDocs":{"url":"https://shopportal.secupay.com/doc/api/web-service#_webhookurl_update"},"title":"Webhook URL","x-model-type":"UPDATE"}},"responses":{"400":{"description":"The request was not accepted often due to missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApiErrorResponse"}}}},"401":{"description":"The necessary authentication credentials are missing or incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApiErrorResponse"}}}},"403":{"description":"The application user is missing the required permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApiErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApiErrorResponse"}}}},"406":{"description":"The requested response format is not supported.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApiErrorResponse"}}}},"409":{"description":"The request conflicts with another request often because of to optimistic locking.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApiErrorResponse"}}}},"413":{"description":"Too many operations in a bulk request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApiErrorResponse"}}}},"415":{"description":"The request provides unsupported or invalid data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApiErrorResponse"}}}},"422":{"description":"The request is well-formed but contains semantic errors. Check the response body for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApiErrorResponse"}}}},"429":{"description":"Too many requests hit the API too quickly.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApiErrorResponse"}}}},"5XX":{"description":"An internal error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApiErrorResponse"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApiErrorResponse"}}}}},"parameters":{},"securitySchemes":{"cookieAuth":{"type":"apiKey","name":"session","in":"cookie"},"macAuth":{"type":"apiKey","name":"x-mac-value","in":"header"},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}}}