{"id":22778,"date":"2024-05-16T10:57:43","date_gmt":"2024-05-16T10:57:43","guid":{"rendered":"https:\/\/www.qly.docs.pay.sibs.com\/onboarding-api\/terminal\/"},"modified":"2025-01-23T16:23:08","modified_gmt":"2025-01-23T16:23:08","slug":"terminal","status":"publish","type":"page","link":"https:\/\/www.qly.docs.pay.sibs.com\/pl\/sibs-gateway-dokumentacja\/onboarding-api\/terminal\/","title":{"rendered":"Terminal"},"content":{"rendered":"<!-- wp:themify-builder\/canvas \/-->\n<p>Na tej stronie znajduj\u0105 si\u0119 informacje o interfejsach API umo\u017cliwiaj\u0105cych tworzenie i usuwanie terminala.<\/p>\n\n<h3 class=\"wp-block-heading\">Create terminal<\/h3>\n\n<p>To be able to make other shop and terminal operations, please check below the available environment endpoints:<\/p>\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Environment<\/strong><\/th><th>URL<\/th><th><strong>Operation Method &amp; Endpoint<\/strong><\/th><th><strong>Operation Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td>PROD<\/td><td>api.sibsgateway.com<\/td><td><mark style=\"background-color:#e9e9f5\" class=\"has-inline-color\">POST<\/mark>\u00a0\/sibs\/onboarding\/v1\/sponsored-merchant\/{merchant-id}\/shop\/{shop-id}\/terminal<\/td><td>Create a Merchant Establishment Terminal resource<\/td><\/tr><tr><td>CER<\/td><td>stargate-cer.qly.site1.sibs.pt<\/td><td><mark style=\"background-color:#e9e9f5\" class=\"has-inline-color\">POST<\/mark>\u00a0\/sibs\/onboarding\/v1\/sponsored-merchant\/{merchant-id}\/shop\/{shop-id}\/terminal<\/td><td>Create a Merchant Establishment Terminal resource<\/td><\/tr><tr><td>Sandbox<\/td><td>sandbox.sibsgateway.com<\/td><td><mark style=\"background-color:#e9e9f5\" class=\"has-inline-color\">POST<\/mark>\u00a0\/sibs\/onboarding\/v1\/sponsored-merchant\/{merchant-id}\/shop\/{shop-id}\/terminal<\/td><td>Create a Merchant Establishment Terminal resource<\/td><\/tr><\/tbody><\/table><\/figure>\n\n<p>You need to perform a\u00a0<mark style=\"background-color:#e9e9f5\" class=\"has-inline-color\">POST<\/mark>\u00a0request with the following data:<\/p>\n\n<h6 class=\"wp-block-heading\">Parameters<\/h6>\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Parameter<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Condition<\/strong><\/th><th><strong>Required<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td>Typ zawarto\u015bci<\/td><td>String<\/td><td>Obowi\u0105zkowy<\/td><td>Nag\u0142owek<\/td><td>application\/json<\/td><\/tr><tr><td>Merchant-ID<\/td><td>String<\/td><td>Obowi\u0105zkowy<\/td><td>\u015acie\u017cka<\/td><td>ID of the Merchant<\/td><\/tr><tr><td>Shop-ID<\/td><td>String<\/td><td>Obowi\u0105zkowy<\/td><td>\u015acie\u017cka<\/td><td>ID of the Establishment<\/td><\/tr><tr><td>X-Request-ID<\/td><td>String<\/td><td>Obowi\u0105zkowy<\/td><td>Nag\u0142owek<\/td><td>ID of the request, unique to the call, as determined by the initiating party<\/td><\/tr><tr><td>x-ibm-client-id<\/td><td>String<\/td><td>Obowi\u0105zkowy<\/td><td>Nag\u0142owek<\/td><td>Token that identifies a client organization. It is provided during onboarding process and must be used in every call<\/td><\/tr><\/tbody><\/table><\/figure>\n\n<p>After the request, the API will respond with one of the two status codes:<\/p>\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Status Code<\/strong><\/th><th><strong>Message<\/strong><\/th><th><strong>TransactionStatus<\/strong><\/th><\/tr><\/thead><tbody><tr><td>000<\/td><td>Sukces<\/td><td>\u201cACT\u201d (Accepted Technical Validation)<\/td><\/tr><tr><td>999<\/td><td>Unexpected Error<\/td><td>\u201cRJT\u201d (Rejected)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n<style type=\"text\/css\">\n\t#message-box-block_9a6df5e0e9bf270c56d35f12c3af1cdf {\n\t\t\/* Add styles that use ACF values here *\/\n\t}\n<\/style>\n\n<div id=\"message-box-block_9a6df5e0e9bf270c56d35f12c3af1cdf\" class=\"block-message-box\">\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t<div class='row info' style=\"display: flex;\">\n\t\t\t  <div class='col' style=\"width: 10%; display: flex; align-items: center; justify-content: center;\">\n\t\t\t\t\t<img decoding=\"async\" src=\"https:\/\/www.qly.docs.pay.sibs.com\/wp-content\/themes\/themify-ultra-child\/images\/msg_info.svg\" alt=\"Info\">\n\t\t\t  <\/div>\n\t\t\t  <div class='col2'>\n\t\t\t\t<p ><p>For more information related to the error messages, please refer to the page\u00a0<strong>Onboarding API<\/strong>\u00a0&gt;\u00a0<strong>Merchant<\/strong>, section\u00a0<a href=\"https:\/\/www.qly.docs.pay.sibs.com\/pl\/sibs-gateway-dokumentacja\/onboarding-api\/sprzedawca\/#error-handling\"><strong>Error handling<\/strong><\/a>.<\/p>\n<\/p>\n\t\t\t  <\/div>\n\t\t\t<\/div>\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\t<\/div>\n<h3 class=\"wp-block-heading\">Cancel terminal<\/h3>\n\n<p>To cancel an existing terminal, you can execute a\u00a0<mark style=\"background-color:#e9e9f5\" class=\"has-inline-color\">DELETE<\/mark>\u00a0operation. For this action, utilize the following endpoints:<\/p>\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Environment<\/strong><\/th><th><strong>URL<\/strong><\/th><th><strong>Operation Method &amp; Endpoint<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td>PROD<\/td><td>api.sibsgateway.com<\/td><td><mark style=\"background-color:#e9e9f5\" class=\"has-inline-color\">DELETE<\/mark>\u00a0\/sibs\/onboarding\/v1\/sponsored-merchant\/{merchant-id}\/shop\/{shop-id}\/teminal<\/td><td>Delete a Terminal resource<\/td><\/tr><tr><td>CER<\/td><td>stargate-cer.qly.site1.sibs.pt<\/td><td><mark class=\"has-inline-color\" style=\"background-color: #e9e9f5;\">DELETE<\/mark>&#13;\n\/sibs\/onboarding\/v1\/sponsored-merchant\/{merchant-id}\/shop\/{shop-id}\/teminal<\/td><td>Delete a Terminal resource<\/td><\/tr><tr><td>Sandbox<\/td><td>sandbox.sibsgateway.com<\/td><td><mark style=\"background-color:#e9e9f5\" class=\"has-inline-color\">DELETE<\/mark>\u00a0\/sibs\/onboarding\/v1\/sponsored-merchant\/{merchant-id}\/shop\/{shop-id}\/teminal<\/td><td>Delete a Terminal resource<\/td><\/tr><\/tbody><\/table><\/figure>\n\n<p>You need to perform a\u00a0<mark style=\"background-color:#e9e9f5\" class=\"has-inline-color\">CANCEL<\/mark>\u00a0request with the following data:<\/p>\n\n<h6 class=\"wp-block-heading\"><strong>Header and Path Parameters<\/strong><\/h6>\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Parametr<\/th><th>Typ<\/th><th>Stan<\/th><th>Required<\/th><th>Opis<\/th><\/tr><\/thead><tbody><tr><td>Typ zawarto\u015bci<\/td><td>String<\/td><td>Obowi\u0105zkowy<\/td><td>Nag\u0142owek<\/td><td>application\/json<\/td><\/tr><tr><td>Merchant-ID<\/td><td>String<\/td><td>Obowi\u0105zkowy<\/td><td>\u015acie\u017cka<\/td><td>ID of the Merchant (required in the path)<\/td><\/tr><tr><td>Shop-ID<\/td><td>String<\/td><td>Obowi\u0105zkowy<\/td><td>\u015acie\u017cka<\/td><td>ID of the Establishment (required in the path)<\/td><\/tr><tr><td>Terminal-id<\/td><td>String<\/td><td>Obowi\u0105zkowy<\/td><td>\u015acie\u017cka<\/td><td>ID of the Terminal (required in the path)<\/td><\/tr><tr><td>X-Request-ID<\/td><td>String<\/td><td>Obowi\u0105zkowy<\/td><td>Nag\u0142owek<\/td><td>ID of the request, unique to the call, as determined by the initiating party<\/td><\/tr><tr><td>x-ibm-client-id<\/td><td>String<\/td><td>Obowi\u0105zkowy<\/td><td>Nag\u0142owek<\/td><td>Token that identifies a client organization. It is provided during onboarding process and must be used in every call<\/td><\/tr><\/tbody><\/table><\/figure>\n\n<p>After the request, the API will respond with one of the two status codes:<\/p>\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Status Code<\/strong><\/th><th><strong>Message<\/strong><\/th><th><strong>TransactionStatus<\/strong><\/th><\/tr><\/thead><tbody><tr><td>000<\/td><td>Sukces<\/td><td>\u201cACT\u201d (Accepted Technical Validation)<\/td><\/tr><tr><td>999<\/td><td>Unexpected Error<\/td><td>\u201cRJT\u201d (Rejected)<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"<p>Na tej stronie znajduj\u0105 si\u0119 informacje o interfejsach API umo\u017cliwiaj\u0105cych tworzenie i usuwanie terminala. Create terminal To be able to make other shop and terminal operations, please check below the available environment endpoints: Environment URL Operation Method &amp; Endpoint Operation Description PROD api.sibsgateway.com POST\u00a0\/sibs\/onboarding\/v1\/sponsored-merchant\/{merchant-id}\/shop\/{shop-id}\/terminal Create a Merchant Establishment Terminal resource CER stargate-cer.qly.site1.sibs.pt POST\u00a0\/sibs\/onboarding\/v1\/sponsored-merchant\/{merchant-id}\/shop\/{shop-id}\/terminal Create a [&hellip;]<\/p>\n","protected":false},"author":3,"featured_media":0,"parent":10461,"menu_order":3,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_eb_attr":"","footnotes":""},"class_list":["post-22778","page","type-page","status-publish","hentry","has-post-title","has-post-date","has-post-category","has-post-tag","has-post-comment","has-post-author",""],"acf":[],"builder_content":"","_links":{"self":[{"href":"https:\/\/www.qly.docs.pay.sibs.com\/pl\/wp-json\/wp\/v2\/pages\/22778","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.qly.docs.pay.sibs.com\/pl\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.qly.docs.pay.sibs.com\/pl\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.qly.docs.pay.sibs.com\/pl\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/www.qly.docs.pay.sibs.com\/pl\/wp-json\/wp\/v2\/comments?post=22778"}],"version-history":[{"count":1,"href":"https:\/\/www.qly.docs.pay.sibs.com\/pl\/wp-json\/wp\/v2\/pages\/22778\/revisions"}],"predecessor-version":[{"id":22779,"href":"https:\/\/www.qly.docs.pay.sibs.com\/pl\/wp-json\/wp\/v2\/pages\/22778\/revisions\/22779"}],"up":[{"embeddable":true,"href":"https:\/\/www.qly.docs.pay.sibs.com\/pl\/wp-json\/wp\/v2\/pages\/10461"}],"wp:attachment":[{"href":"https:\/\/www.qly.docs.pay.sibs.com\/pl\/wp-json\/wp\/v2\/media?parent=22778"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}