API Active Payment Terminal — Functional Documentation

Overview

This API lists the active payment terminals owned by the merchant, including the characteristics of each payment terminal.

FieldDetail
Version1.0.3
ProtocolHTTPS / REST
FormatJSON
AuthenticationBearer Token

Environments

EnvironmentBase URL
Development (HG)https://api-hg.getnet.com.br/sap/equipment/v1
QA (HTI)https://api-homologacao.getnet.com.br/sap/equipment/v1

Authentication

All requests must include a Bearer token in the Authorization header:
text
Authorization: Bearer <token>

Endpoints

List Active Payment Terminals

Returns a list of all active payment terminals associated with the specified merchant, including the characteristics of each terminal.

FieldValue
MethodGET
Path/payment-terminals/{merchant_id}

Path Parameters

NameLocationTypeRequiredDescription
merchant_idpathstringYesMerchant ID.

Request Example

text
600;">GET /sap/equipment/v1/payment-terminals/10000 HTTP/1.1 Host: api-hg.getnet.com.br Authorization: Bearer <token>

Responses

200 — Success

Returns the merchant data and the list of active payment terminals.

text
{ "merchant_id": "10000", "equipments": { "item": [ { "payment_terminal_sku": "302890", "payment_terminal_serial_number": "903191104705571440", "capture_method_code": "10", "capture_method_des": "POS", "communication_method_code": "000000004", "communication_method_des": "WI FI", "activation_datetime": "2010-03-29T13:57:42Z", "payment_terminal_brand": "INGENICO", "payment_terminal_model": "MOVE 5000 ESSENTIAL", "commercial_mode": "ALUGUEL", "warranty_available": true } ] } }
EquipListResponse Fields
FieldTypeDescription
merchant_idstringMerchant ID
equipmentsobjectObject containing the terminal item list
EquipmentItem Fields (each entry in equipments.item[])
FieldTypeMax LengthDescriptionPossible Values / Example
payment_terminal_skustring18Terminal SKU"302890"
payment_terminal_serial_numberstring18Terminal serial number"903191104705571440"
capture_method_codestring18Capture method code"10", "13", "40"
capture_method_desstring20Capture method descriptionPOS, VERMELHINHA, PIN PAD
communication_method_codestring9Communication method code"000000005", "000000008", "000000035"
communication_method_desstring50Communication method descriptionGPRS MOVEL, TEF, POS DIGITAL, WI FI
activation_datetimestring (date-time)—Terminal activation date and time2010-03-29T13:57:42Z
payment_terminal_brandstring50Terminal brandINGENICO
payment_terminal_modelstring50Terminal modelMOVE 5000 ESSENTIAL
commercial_modestring10Commercial modeALUGUEL, VENDA, TAXA_AD
warranty_availableboolean—Indicates whether the sold terminal is under warrantytrue / false

403 — Forbidden

Returned when access to the requested resource is forbidden.

text
{ "error": { "code": "403", "message": "403 - Forbidden", "logID": "<log-identifier>" } }
FieldTypeDescription
error.codestringStatus code
error.messagestringError message
error.logIDstringLog identifier for tracing

500 — Internal Server Error

Returned when an internal error occurs during request processing.

text
{ "Status": "Erro no processamento da requisicao" }
FieldTypeDescription
StatusstringServer request processing status

Business Rules

  1. Only terminals with active status are returned by the API.
  2. The commercial_mode field is restricted to the enumerated values: ALUGUEL, VENDA, or TAXA_AD.
  3. The warranty_available field is only applicable to terminals with the VENDA commercial mode.

On this page

API Active Payment Terminal — Functional Documentation