This page provides information about the APIs for creating and deleting a terminal.

Create terminal

To be able to make other shop and terminal operations, please check below the available environment endpoints:

Environment	URL	Operation Method & Endpoint	Operation Description
PROD	api.sibsgateway.com	POST /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 /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/terminal	Create a Merchant Establishment Terminal resource
Sandbox	sandbox.sibsgateway.com	POST /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/terminal	Create a Merchant Establishment Terminal resource

You need to perform a POST request with the following data:

Parameters

Parameter	Type	Condition	Required	Description
Content-type	String	Mandatory	Header	application/json
Merchant-ID	String	Mandatory	Path	ID of the Merchant
Shop-ID	String	Mandatory	Path	ID of the Establishment
X-Request-ID	String	Mandatory	Header	ID of the request, unique to the call, as determined by the initiating party
x-ibm-client-id	String	Mandatory	Header	Token that identifies a client organization. It is provided during onboarding process and must be used in every call

After the request, the API will respond with one of the two status codes:

Status Code	Message	TransactionStatus
000	Success	“ACT” (Accepted Technical Validation)
999	Unexpected Error	“RJT” (Rejected)

Cancel terminal

To cancel an existing terminal, you can execute a DELETE operation. For this action, utilize the following endpoints:

Environment	URL	Operation Method & Endpoint	Description
PROD	api.sibsgateway.com	DELETE /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/teminal	Delete a Terminal resource
CER	stargate-cer.qly.site1.sibs.pt	DELETE /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/teminal	Delete a Terminal resource
Sandbox	sandbox.sibsgateway.com	DELETE /sibs/onboarding/v1/sponsored-merchant/{merchant-id}/shop/{shop-id}/teminal	Delete a Terminal resource

You need to perform a CANCEL request with the following data:

Header and Path Parameters

Parameter	Type	Condition	Required	Description
Content-type	String	Mandatory	Header	application/json
Merchant-ID	String	Mandatory	Path	ID of the Merchant (required in the path)
Shop-ID	String	Mandatory	Path	ID of the Establishment (required in the path)
Terminal-id	String	Mandatory	Path	ID of the Terminal (required in the path)
X-Request-ID	String	Mandatory	Header	ID of the request, unique to the call, as determined by the initiating party
x-ibm-client-id	String	Mandatory	Header	Token that identifies a client organization. It is provided during onboarding process and must be used in every call

After the request, the API will respond with one of the two status codes:

Status Code	Message	TransactionStatus
000	Success	“ACT” (Accepted Technical Validation)
999	Unexpected Error	“RJT” (Rejected)