Payment Terminals
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.
Payment Terminal Management
POST/1/payment-terminals
Create Payment Terminal
Authorization
User sessionAPI credentialPermissions
payment-terminals:writeOAuth
-
Request
Request bodyapplication/json
abbDetailsobject
abbDetailsobject
idTagPrefixstringREQUIRED
acquirerstring | null
adyen-tsgelavonnullpayoneworldlineadsTecDetailsobject
adsTecDetailsobject
kwhPricenumberREQUIRED
connectorIdsstring[]REQUIRED
contractstringREQUIRED
customerroadenabledbooleanREQUIRED
locationIdstringREQUIRED
namestringREQUIRED
payterDetailsobject
payterDetailsobject
authorizationFlowstringREQUIRED
connect-firstconnect-or-authorize-firstinteractive-uilangCodestringREQUIRED
deenesfritnlpaymentMethodstringREQUIRED
cardcard-rfidpreAuthAmountnumberREQUIRED
serialNumberstringREQUIRED
roamingDetailsobject
roamingDetailsobject
ptpCountryCodestringREQUIRED
ptpPartyIdstringREQUIRED
terminalIdstringREQUIRED
sichargeDetailsobject
sichargeDetailsobject
preAuthAmountnumberREQUIRED
typestringREQUIRED
abbads-tecalpitronicautelcharge-paydbte-totemevboxg2mobilityiesmadic-lafonpayterroamingsichargevendorTerminalIdstring
Responses
201OK application/json
dataPayterPaymentTerminal | AlpitronicPaymentTerminal | SichargePaymentTerminal | AdsTecPaymentTerminal | ETotemPaymentTerminal | MadicLafonPaymentTerminal | ChargePayPaymentTerminal | EVBoxPaymentTerminal | DbtPaymentTerminal | G2MobilityPaymentTerminal | AutelPaymentTerminal | AbbPaymentTerminal | IesPaymentTerminal | RoamingPaymentTerminal
metaobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/payment-terminals/search
Search Payment Terminals
Authorization
User sessionAPI credentialPermissions
payment-terminals:readOAuth
-
Request
Request bodyapplication/json
formatstring
default
jsonkeywordsstring
limitnumber
localestring
Browser locale, e.g. nl-NL, for a CSV export: sets its decimal sign and delimiter. Without it the CSV keeps its default format.
skipnumber
default
0sortobjectdefault {"field":"createdAt","order":"desc"}
sortobject
default
{"field":"createdAt","order":"desc"}fieldstringREQUIRED
orderstringREQUIRED
ascdescResponses
200OK application/json
dataobject | object | object | object | object | object | object | object | object | object | object | object | object | object[]
metaobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/1/payment-terminals/{id}
Get Payment Terminal
Authorization
User sessionAPI credentialPermissions
payment-terminals:readOAuth
-
Request
Path parameters1
idstringREQUIRED
Responses
200OK application/json
dataPayterPaymentTerminal | AlpitronicPaymentTerminal | SichargePaymentTerminal | AdsTecPaymentTerminal | ETotemPaymentTerminal | MadicLafonPaymentTerminal | ChargePayPaymentTerminal | EVBoxPaymentTerminal | DbtPaymentTerminal | G2MobilityPaymentTerminal | AutelPaymentTerminal | AbbPaymentTerminal | IesPaymentTerminal | RoamingPaymentTerminal
metaobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
PATCH/1/payment-terminals/{id}
Update Payment Terminal
Authorization
User sessionAPI credentialPermissions
payment-terminals:writeOAuth
-
Request
Path parameters1
idstringREQUIRED
Request bodyapplication/json
abbDetailsobject
abbDetailsobject
idTagPrefixstringREQUIRED
acquirerstring | null
adyen-tsgelavonnullpayoneworldlineadsTecDetailsobject
adsTecDetailsobject
kwhPricenumberREQUIRED
connectorIdsstring[]
contractstring
customerroadenabledboolean
namestring
payterDetailsobject
payterDetailsobject
authorizationFlowstring
connect-firstconnect-or-authorize-firstinteractive-uilangCodestring
deenesfritnlpaymentMethodstring
cardcard-rfidpreAuthAmountnumberREQUIRED
serialNumberstring
sichargeDetailsobject
sichargeDetailsobject
preAuthAmountnumberREQUIRED
Responses
200OK application/json
dataPayterPaymentTerminal | AlpitronicPaymentTerminal | SichargePaymentTerminal | AdsTecPaymentTerminal | ETotemPaymentTerminal | MadicLafonPaymentTerminal | ChargePayPaymentTerminal | EVBoxPaymentTerminal | DbtPaymentTerminal | G2MobilityPaymentTerminal | AutelPaymentTerminal | AbbPaymentTerminal | IesPaymentTerminal | RoamingPaymentTerminal
metaobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
DELETE/1/payment-terminals/{id}
Delete Payment Terminal
Authorization
User sessionAPI credentialPermissions
payment-terminals:writeOAuth
-
Request
Path parameters1
idstringREQUIRED
Responses
204OK text/plain
Returns a file (Text).
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED