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

Check Availability

POST
/authentications

Start the authentication process by confirming the available mechanisms to authenticate the payer based on a payment method. 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.

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

Value in

  • "AD"
  • "AE"
  • "AF"
  • "AG"
  • "AI"
  • "AL"
  • "AM"
  • "AO"
  • "AQ"
  • "AR"
  • "AS"
  • "AT"
  • "AU"
  • "AW"
  • "AX"
  • "AZ"
  • "BA"
  • "BB"
  • "BD"
  • "BE"
  • "BF"
  • "BG"
  • "BH"
  • "BI"
  • "BJ"
  • "BL"
  • "BM"
  • "BN"
  • "BO"
  • "BQ"
  • "BR"
  • "BS"
  • "BT"
  • "BV"
  • "BW"
  • "BY"
  • "BZ"
  • "CA"
  • "CC"
  • "CD"
  • "CF"
  • "CG"
  • "CH"
  • "CI"
  • "CK"
  • "CL"
  • "CM"
  • "CN"
  • "CO"
  • "CR"
  • "CU"
  • "CV"
  • "CW"
  • "CX"
  • "CY"
  • "CZ"
  • "DE"
  • "DJ"
  • "DK"
  • "DM"
  • "DO"
  • "DZ"
  • "EC"
  • "EE"
  • "EG"
  • "EH"
  • "ER"
  • "ES"
  • "ET"
  • "FI"
  • "FJ"
  • "FK"
  • "FM"
  • "FO"
  • "FR"
  • "GA"
  • "GB"
  • "GD"
  • "GE"
  • "GF"
  • "GG"
  • "GH"
  • "GI"
  • "GL"
  • "GM"
  • "GN"
  • "GP"
  • "GQ"
  • "GR"
  • "GS"
  • "GT"
  • "GU"
  • "GW"
  • "GY"
  • "HK"
  • "HM"
  • "HN"
  • "HR"
  • "HT"
  • "HU"
  • "ID"
  • "IE"
  • "IL"
  • "IM"
  • "IN"
  • "IO"
  • "IQ"
  • "IR"
  • "IS"
  • "IT"
  • "JE"
  • "JM"
  • "JO"
  • "JP"
  • "KE"
  • "KG"
  • "KH"
  • "KI"
  • "KM"
  • "KN"
  • "KP"
  • "KR"
  • "KW"
  • "KY"
  • "KZ"
  • "LA"
  • "LB"
  • "LC"
  • "LI"
  • "LK"
  • "LR"
  • "LS"
  • "LT"
  • "LU"
  • "LV"
  • "LY"
  • "MA"
  • "MC"
  • "MD"
  • "ME"
  • "MF"
  • "MG"
  • "MH"
  • "MK"
  • "ML"
  • "MM"
  • "MN"
  • "MO"
  • "MP"
  • "MQ"
  • "MR"
  • "MS"
  • "MT"
  • "MU"
  • "MV"
  • "MW"
  • "MX"
  • "MY"
  • "MZ"
  • "NA"
  • "NC"
  • "NE"
  • "NF"
  • "NG"
  • "NI"
  • "NL"
  • "NO"
  • "NP"
  • "NR"
  • "NU"
  • "NZ"
  • "OM"
  • "PA"
  • "PE"
  • "PF"
  • "PG"
  • "PH"
  • "PK"
  • "PL"
  • "PM"
  • "PN"
  • "PR"
  • "PS"
  • "PT"
  • "PW"
  • "PY"
  • "QA"
  • "RE"
  • "RO"
  • "RS"
  • "RU"
  • "RW"
  • "SA"
  • "SB"
  • "SC"
  • "SD"
  • "SE"
  • "SG"
  • "SH"
  • "SI"
  • "SJ"
  • "SK"
  • "SL"
  • "SM"
  • "SN"
  • "SO"
  • "SR"
  • "SS"
  • "ST"
  • "SV"
  • "SX"
  • "SY"
  • "SZ"
  • "TC"
  • "TD"
  • "TF"
  • "TG"
  • "TH"
  • "TJ"
  • "TK"
  • "TL"
  • "TM"
  • "TN"
  • "TO"
  • "TR"
  • "TT"
  • "TV"
  • "TW"
  • "TZ"
  • "UA"
  • "UG"
  • "UM"
  • "US"
  • "UY"
  • "UZ"
  • "VA"
  • "VC"
  • "VE"
  • "VG"
  • "VI"
  • "VN"
  • "VU"
  • "WF"
  • "WS"
  • "YE"
  • "YT"
  • "ZA"
  • "ZM"
  • "ZW"
amount*string

The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always represented in the lowest denomination of the related currency. and with no decimal point. Note for European merchants: This field is mandatory for SCA.

Length1 <= length <= 50
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"
reference*string

Merchant defined field to reference the authentication.

Length1 <= length <= 50
payment_method*
notifications*
mobile_data?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Callbacks

curl -X POST "https://example.com/authentications" \  -H "X-GP-Version: 2021-03-22" \  -H "Content-Type: application/json" \  -d '{    "account_name": "Transaction_Processing",    "reference": "3ds2_ref1",    "channel": "CNP",    "amount": "5089",    "currency": "EUR",    "country": "FR",    "payment_method": {      "card": {        "number": "4012001038488884",        "expiry_month": "12",        "expiry_year": "30"      }    },    "notifications": {      "challenge_return_url": "https://ensi808o85za.x.pipedream.net/",      "three_ds_method_return_url": "https://ensi808o85za.x.pipedream.net/"    }  }'
{  "id": "AUT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",  "time_created": "2021-05-03T21:23:39.718Z",  "transaction_type": "SALE",  "status": "AVAILABLE",  "channel": "CP",  "amount": "11099",  "currency": "USD",  "country": "US",  "merchant_id": "MER_A6A1EC44522F96630ABEA17A",  "merchant_name": "ABC INDUSTRIES",  "account_id": "TRA_86920f927028745yt34d077d88beb29b",  "account_name": "transaction_processing",  "reference": "becf9f3e-4d33-459c-8ed2-0c4affc9555e",  "three_ds": {    "server_trans_ref": "string",    "message_version": "string",    "ds_protocol_version_start": "string",    "ds_protocol_version_end": "string",    "acs_protocol_version_start": "string",    "acs_protocol_version_end": "string",    "acs_info_indicator": [      "NOT_AVAILABLE"    ],    "enrolled_status": "ENROLLED",    "eci": "strin",    "liability_shift": "YES",    "challenge_model": "STATIC_CHALLENGE",    "session_data_field_name": "threeDSSessionData",    "message_type": "CREQ",    "challenge_value": "string",    "redirect_url": "string",    "acs_challenge_request_url": "string",    "method_url": "string",    "method_data": {      "three_ds_server_trans_id": "string",      "three_ds_method_return_url": "string",      "encoded_method_data": "string"    }  },  "notifications": {    "challenge_return_url": "string"  },  "action": {    "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "CHECK_AVAILABILITY",    "time_created": "2021-05-03T21:23:39.718Z",    "result_code": "SUCCESS",    "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "app_name": "my_lovely_app"  }}

Get List of Authentications GET

Return a list of Authentication Responses. 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.

Initiate POST

For 3DS 2, submit data including the billing and shipping details of the payer, at least one phone number, the device data, transaction details, outcome from the ACS Method URL if it took place and a link to the merchant's About or Contact page. 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. The `Challenge_Return_Notification` callback is sent to the URL supplied in an earlier request ({$request.body#/notifications/challenge_return_url}); see POST /authentications.