Documentation

Payment Terminals

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

Payment Terminal Management

POST/1/payment-terminals

Create Payment Terminal

Authorization
User sessionAPI credential
Permissions
payment-terminals:write
OAuth
-
Request
Request bodyapplication/json
abbDetailsobject
idTagPrefixstringREQUIRED
acquirerstring | null
adyen-tsgelavonnullpayoneworldline
adsTecDetailsobject
kwhPricenumberREQUIRED
connectorIdsstring[]REQUIRED
contractstringREQUIRED
customerroad
enabledbooleanREQUIRED
locationIdstringREQUIRED
namestringREQUIRED
payterDetailsobject
authorizationFlowstringREQUIRED
connect-firstconnect-or-authorize-firstinteractive-ui
langCodestringREQUIRED
deenesfritnl
paymentMethodstringREQUIRED
cardcard-rfid
preAuthAmountnumberREQUIRED
serialNumberstringREQUIRED
roamingDetailsobject
ptpCountryCodestringREQUIRED
ptpPartyIdstringREQUIRED
terminalIdstringREQUIRED
sichargeDetailsobject
preAuthAmountnumberREQUIRED
typestringREQUIRED
abbads-tecalpitronicautelcharge-paydbte-totemevboxg2mobilityiesmadic-lafonpayterroamingsicharge
vendorTerminalIdstring
Responses
201OK application/json
dataPayterPaymentTerminal | AlpitronicPaymentTerminal | SichargePaymentTerminal | AdsTecPaymentTerminal | ETotemPaymentTerminal | MadicLafonPaymentTerminal | ChargePayPaymentTerminal | EVBoxPaymentTerminal | DbtPaymentTerminal | G2MobilityPaymentTerminal | AutelPaymentTerminal | AbbPaymentTerminal | IesPaymentTerminal | RoamingPaymentTerminal
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/payment-terminals/search

Search Payment Terminals

Authorization
User sessionAPI credential
Permissions
payment-terminals:read
OAuth
-
Request
Request bodyapplication/json
formatstring
default json
keywordsstring
limitnumber
skipnumber
default 0
sortobject
default {"field":"createdAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
Responses
200OK application/json
dataobject | object | object | object | object | object | object | object | object | object | object | object | object | object[]
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/1/payment-terminals/{id}

Get Payment Terminal

Authorization
User sessionAPI credential
Permissions
payment-terminals:read
OAuth
-
Request
Path parameters1
idstringREQUIRED
Responses
200OK application/json
dataPayterPaymentTerminal | AlpitronicPaymentTerminal | SichargePaymentTerminal | AdsTecPaymentTerminal | ETotemPaymentTerminal | MadicLafonPaymentTerminal | ChargePayPaymentTerminal | EVBoxPaymentTerminal | DbtPaymentTerminal | G2MobilityPaymentTerminal | AutelPaymentTerminal | AbbPaymentTerminal | IesPaymentTerminal | RoamingPaymentTerminal
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
PATCH/1/payment-terminals/{id}

Update Payment Terminal

Authorization
User sessionAPI credential
Permissions
payment-terminals:write
OAuth
-
Request
Path parameters1
idstringREQUIRED
Request bodyapplication/json
abbDetailsobject
idTagPrefixstringREQUIRED
acquirerstring | null
adyen-tsgelavonnullpayoneworldline
adsTecDetailsobject
kwhPricenumberREQUIRED
connectorIdsstring[]
contractstring
customerroad
enabledboolean
namestring
payterDetailsobject
authorizationFlowstring
connect-firstconnect-or-authorize-firstinteractive-ui
langCodestring
deenesfritnl
paymentMethodstring
cardcard-rfid
preAuthAmountnumberREQUIRED
serialNumberstring
sichargeDetailsobject
preAuthAmountnumberREQUIRED
Responses
200OK application/json
dataPayterPaymentTerminal | AlpitronicPaymentTerminal | SichargePaymentTerminal | AdsTecPaymentTerminal | ETotemPaymentTerminal | MadicLafonPaymentTerminal | ChargePayPaymentTerminal | EVBoxPaymentTerminal | DbtPaymentTerminal | G2MobilityPaymentTerminal | AutelPaymentTerminal | AbbPaymentTerminal | IesPaymentTerminal | RoamingPaymentTerminal
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
DELETE/1/payment-terminals/{id}

Delete Payment Terminal

Authorization
User sessionAPI credential
Permissions
payment-terminals:write
OAuth
-
Request
Path parameters1
idstringREQUIRED
Responses
204OK text/plain
Returns a file (Text).
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED