Global Payments API
GP Developer PortalGP API reference
HomeAPI ReferenceSDKsContext Plugin
Transactions

Synchronize a Device

POST
/devices

Synchronize a physical device to successfully transaction process.(Availability in production depends on your live configuration.)

Authorization

bearerAuth
AuthorizationBearer <token>

Access token from POST /accesstoken, sent as Authorization: Bearer <token>.

In: header

Header Parameters

X-GP-Idempotency?string

Integrator generated value submitted in the request header that is checked to ensure the same value has not been seen in the last 24 hours. It is used to ensure idempotency is maintained with this action.

Length1 <= length <= 50
X-GP-Version*string

The version of the API to execute the request.

Length1 <= length <= 50
Default"2021-03-22"

Request Body

application/json

account_name?string

A meaningful label that better identifies the account.

Length1 <= length <= 50
channel?string

Describes whether the transaction was processed in a face to face(CP) scenario or a Customer Not Present (CNP) scenario.

  • CP - A Customer Present transaction is when the payer and the merchant are in direct face to face contact when exchanging payment method information to fulfill a transaction. e.g. in a store and paying at the counter that is attended by a clerk.
  • CNP - A Customer NOT Present transaction is when the payer and the merchant are not together when exchanging payment method information to fulfill a transaction. e.g. a transaction executed from a merchant's website or over the phone
Length1 <= length <= 50

Value in

  • "CP"
  • "CNP"
country?string

This is the country the merchant is domiciled in. For example, if the merchant is based in Canada it must be set to CA.if the merchant is based in England it must be set to GB.if the merchant is based in USA it must be set to US.The country in ISO-3166-1(alpha-2 code) format.

Length2 <= length <= 2
currency?string

The currency of the amount in ISO-4217(alpha-3).

Length3 <= length <= 3

Value in

  • "USD"
  • "EUR"
  • "CAD"
  • "AFN"
  • "DZD"
  • "ARS"
  • "AMD"
  • "AWG"
  • "AUD"
  • "AZN"
  • "BSD"
  • "BHD"
  • "THB"
  • "PAB"
  • "BBD"
  • "BYN"
  • "BZD"
  • "BMD"
  • "VEF"
  • "BOB"
  • "BRL"
  • "BND"
  • "BGN"
  • "BIF"
  • "CVE"
  • "CLP"
  • "COP"
  • "KMF"
  • "CDF"
  • "NIO"
  • "CRC"
  • "CUP"
  • "CZK"
  • "GMD"
  • "DKK"
  • "MKD"
  • "DJF"
  • "STD"
  • "DOP"
  • "VND"
  • "XCD"
  • "EGP"
  • "SVC"
  • "ETB"
  • "FKP"
  • "FJD"
  • "HUF"
  • "GHS"
  • "GIP"
  • "HTG"
  • "PYG"
  • "GNF"
  • "GYD"
  • "HKD"
  • "UAH"
  • "ISK"
  • "INR"
  • "IRR"
  • "IQD"
  • "JMD"
  • "JOD"
  • "KES"
  • "PGK"
  • "HRK"
  • "KWD"
  • "AOA"
  • "MMK"
  • "LAK"
  • "GEL"
  • "LBP"
  • "ALL"
  • "HNL"
  • "SLL"
  • "LRD"
  • "LYD"
  • "SZL"
  • "LSL"
  • "MGA"
  • "MWK"
  • "MYR"
  • "MUR"
  • "MXN"
  • "MDL"
  • "MAD"
  • "MZN"
  • "BOV"
  • "NGN"
  • "ERN"
  • "NAD"
  • "NPR"
  • "ANG"
  • "ILS"
  • "TWD"
  • "NZD"
  • "BTN"
  • "KPW"
  • "NOK"
  • "MRO"
  • "TOP"
  • "PKR"
  • "MOP"
  • "CUC"
  • "UYU"
  • "PHP"
  • "GBP"
  • "BWP"
  • "QAR"
  • "GTQ"
  • "ZAR"
  • "OMR"
  • "KHR"
  • "RON"
  • "MVR"
  • "IDR"
  • "RUB"
  • "RWF"
  • "SHP"
  • "SAR"
  • "RSD"
  • "SCR"
  • "SGD"
  • "PEN"
  • "SBD"
  • "KGS"
  • "SOS"
  • "TJS"
  • "SSP"
  • "LKR"
  • "XSU"
  • "SDG"
  • "SRD"
  • "SEK"
  • "CHF"
  • "SYP"
  • "BDT"
  • "WST"
  • "TZS"
  • "KZT"
  • "TTD"
  • "MNT"
  • "TND"
  • "TRY"
  • "TMT"
  • "AED"
  • "UGX"
  • "CLF"
  • "COU"
  • "UZS"
  • "VUV"
  • "KRW"
  • "YER"
  • "JPY"
  • "CNY"
  • "ZMW"
  • "ZWL"
  • "PLN"
device?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/devices" \  -H "X-GP-Version: 2021-03-22" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "DEV_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",  "time_created": "2026-05-03T21:23:39.718Z",  "type": "TERMINAL",  "status": "AVAILABLE",  "merchant_id": "MER_A6A1EC44522F96630ABEA17A",  "merchant_name": "ABC INDUSTRIES",  "account_id": "TRA_86920f927028745yt34d077d88beb29b",  "account_name": "transaction_processing",  "channel": "CP",  "country": "US",  "device": {    "result": "string",    "message": "string",    "balance_key": "string",    "mac_key": "string",    "mac": "string",    "pin_key": "string"  },  "action": {    "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "AUTHORIZE",    "time_created": "2026-05-03T21:23:39.718Z",    "result_code": "SUCCESS",    "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "app_name": "my_lovely_app"  }}

Split a Transaction Amount POST

Transfer part of a transaction amount, executed by a merchant, to the partner account. Availability of this feature in production depends on your allowed live configuration. Please contact Global Payments before coding this feature to confirm it will be available to you when you go live.

Challenge a Disputed Transaction POST

Upload documentation to challenge a disputed transaction. (Availability in production depends on your live configuration.)