Add a new device

ApiScope: payment.dealerdevices.create
API Scope Level: DealerScope

Path Parameters

dealerUuid string required

application/json

Request Body required

deviceType string
deviceID string
alias string
gateway string

Possible values: [CREDITCALL, OPENEDGE, PAYMENTMATE, TEMPUS, CARDCONNECT, WORLDPAY, STRIPE, NMI, AFFIRM, SUNBIT, CASH, CHECK]

gatewaySpecificAttributes object
property name* string

Responses

• 200

---

OK

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]
dealerDevices object[]
Array [
id int64
uuid string
deviceID string
deviceType string
gateway string
dealerId int64 deprecated
lastFourDigit string
paymentDealer object
dealerUuid string
name string
dealerDeviceAttributes object[]
Array [
id int64
attributeName string
attributeValue string
dealerDeviceID int64
]
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ],
  "dealerDevices": [
    {
      "id": 0,
      "uuid": "string",
      "deviceID": "string",
      "deviceType": "string",
      "gateway": "string",
      "lastFourDigit": "string",
      "paymentDealer": {
        "dealerUuid": "string",
        "name": "string"
      },
      "dealerDeviceAttributes": [
        {
          "id": 0,
          "attributeName": "string",
          "attributeValue": "string",
          "dealerDeviceID": 0
        }
      ]
    }
  ]
}

POST /v4/dealers/:dealerUuid/devices

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/payment

Username

Password

dealerUuid — path required

Body required

{
  "deviceType": "string",
  "deviceID": "string",
  "alias": "string",
  "gateway": "CREDITCALL",
  "gatewaySpecificAttributes": {}
}

curl / cURL

curl -L -X POST '/payment/v4/dealers/:dealerUuid/devices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "deviceType": "string",
  "deviceID": "string",
  "alias": "string",
  "gateway": "CREDITCALL",
  "gatewaySpecificAttributes": {}
}'

python / requests

curl -L -X POST '/payment/v4/dealers/:dealerUuid/devices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "deviceType": "string",
  "deviceID": "string",
  "alias": "string",
  "gateway": "CREDITCALL",
  "gatewaySpecificAttributes": {}
}'

go / native

curl -L -X POST '/payment/v4/dealers/:dealerUuid/devices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "deviceType": "string",
  "deviceID": "string",
  "alias": "string",
  "gateway": "CREDITCALL",
  "gatewaySpecificAttributes": {}
}'

nodejs / axios

curl -L -X POST '/payment/v4/dealers/:dealerUuid/devices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "deviceType": "string",
  "deviceID": "string",
  "alias": "string",
  "gateway": "CREDITCALL",
  "gatewaySpecificAttributes": {}
}'

ruby / Net::HTTP

curl -L -X POST '/payment/v4/dealers/:dealerUuid/devices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "deviceType": "string",
  "deviceID": "string",
  "alias": "string",
  "gateway": "CREDITCALL",
  "gatewaySpecificAttributes": {}
}'

csharp / RestSharp

curl -L -X POST '/payment/v4/dealers/:dealerUuid/devices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "deviceType": "string",
  "deviceID": "string",
  "alias": "string",
  "gateway": "CREDITCALL",
  "gatewaySpecificAttributes": {}
}'

php / cURL

curl -L -X POST '/payment/v4/dealers/:dealerUuid/devices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "deviceType": "string",
  "deviceID": "string",
  "alias": "string",
  "gateway": "CREDITCALL",
  "gatewaySpecificAttributes": {}
}'

java / OkHttp

curl -L -X POST '/payment/v4/dealers/:dealerUuid/devices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "deviceType": "string",
  "deviceID": "string",
  "alias": "string",
  "gateway": "CREDITCALL",
  "gatewaySpecificAttributes": {}
}'

powershell / RestMethod

curl -L -X POST '/payment/v4/dealers/:dealerUuid/devices' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "deviceType": "string",
  "deviceID": "string",
  "alias": "string",
  "gateway": "CREDITCALL",
  "gatewaySpecificAttributes": {}
}'