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

Get List of Authentications

GET
/authentications

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.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

to_time_created?string

The end time to search for in a range, using the resource time_created value.

Formatdate
from_time_created?string

The start time to search for in a range, using the resource time_created value.

Formatdate
id?string

A unique identifier that is used to identify and reference an instance of this resource. It is generated by Global Payments to identify the authentication and must be used to action or reference that authentication.

Length1 <= length <= 50
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
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"
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"
source?string

Indicates the type of system used to initiate the authentication.

  • BROWSER
  • MERCHANT_INITIATED
  • MOBILE_SDK
Length1 <= length <= 50

Value in

  • "BROWSER"
  • "MERCHANT_INITIATED"
  • "MOBILE_SDK"
three_ds.ds_trans_ref?string

The reference created by the 3DSecure Directory Server to identify the specific authentication attempt.

Length1 <= length <= 5
three_ds.server_trans_ref?string

The reference created by the 3DSecure provider to identify the specific authentication attempt.

Length1 <= length <= 50
three_ds.liability_shift?string

Indicates if the payment has been successfully completed authentication, either by the customer during 3DS or using 3RI in a merchant initiated transaction. If the value returned is YES, then it's recommended to proceed and execute a card authorization. In the event of a "fraudulent" chargeback from the customer, the liability for that dispute has shifted to the issuing bank and away from the merchant.

  • YES
  • NO
  • UNSURE
Length1 <= length <= 50

Value in

  • "YES"
  • "NO"
  • "UNSURE"
three_ds.authentication_value?string

A CNP Card transaction's 3D Secure Customer Authentication Verification Value that is used to determine and validate the degree of authentication executed for this transaction.

Length1 <= length <= 50
three_ds.eci?string

An indication of the degree of the authentication and liability shift obtained for this transaction. It is returned after the 3D Secure process has completed.

Length1 <= length <= 5
three_ds.message_version?string

Indicates the version of 3DS.

page?number

Indicates the page sequence to return in the response. The number of records presented on each page is determined by page_size field.1 means the first page, 2 the second and so on.

Default1
page_size?number

The total number of records to return in a single page for a list. page:

Default5
order?string

The direction of the ordering of the entire list, ASC or DESC

Default"DESC"

Value in

  • "ASC"
  • "DESC"
order_by?string

The field to order the list by.

Default"TIME_CREATED"

Header Parameters

X-GP-Version*string

The version of the API to execute the request.

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

Response Body

application/json

curl -X GET "https://example.com/authentications" \  -H "X-GP-Version: 2021-03-22"
{  "current_page_size": 564,  "merchant_id": "MER_A6A1EC44522F96630ABEA17A",  "merchant_name": "ABC INDUSTRIES",  "account_id": "TRA_86920f927028745yt34d077d88beb29b",  "account_name": "transaction_processing",  "filter": {    "from_time_created": "2022-05-01",    "to_time_created": "2023-05-01"  },  "paging": {    "page_size": 5,    "page": 1,    "order": "ASC",    "order_by": "TIME_CREATED"  },  "authentications": {    "id": "AUT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "time_created": "2021-05-03T21:23:39.718Z",    "status": "AVAILABLE",    "channel": "CP",    "amount": "11099",    "currency": "USD",    "country": "US",    "source": "BROWSER",    "payment_method": {      "result": "string",      "message": "string",      "entry_mode": "ECOM",      "fingerprint": "string",      "fingerprint_presence_indicator": "NEW",      "name": "John's payment Method",      "card": {        "funding": "CREDIT",        "brand": "VISA",        "authcode": "string",        "brand_reference": "000000321000010",        "masked_number_first6last4": "426397xxxxxx5262",        "cvv_indicator": "PRESENT",        "cvv_result": "MATCHED",        "avs_address_result": "MATCHED",        "avs_postal_code_result": "MATCHED"      },      "three_ds": {        "acs_trans_ref": "string",        "ds_trans_ref": "strin",        "server_trans_ref": "string",        "liability_shift": "YES",        "value": "string",        "eci": "strin",        "status": "AUTHENTICATION_SUCCESSFUL",        "status_reason": "HIGH_CONFIDENCE",        "message_category": "PAYMENT_AUTHENTICATION",        "message_version": "string",        "challenge_status": "MANDATED"      }    },    "action_create_id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "system": {      "mid": "string",      "tid": "string",      "name": "string"    }  },  "action": {    "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "CHECK_AVAILABILITY",    "time_created": "2019-08-24T14:15:22Z",    "result_code": "SUCCESS",    "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "app_name": "my_lovely_app"  }}

Get a Single Action GET

Get the details of a single action using its unique id.

Check Availability POST

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.