Payers

Get a Payer

GET
/payers/{id}

Get Details about a single Payer

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the Payer on the Global Payments system.

Lengthlength <= 50

Query Parameters

masked?string

Specifies the masking behavior for personally identifiable fields in the response. When set to YES or omitted, all identifying fields are returned in a masked format. Set to NO to retrieve the unmasked values.

Length1 <= length <= 50
Default"YES"

Value in

  • "YES"
  • "NO"

Header Parameters

X-GP-Version*string

The version of the API to execute the request.

Length1 <= length <= 50
Default"2021-03-22"
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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/payers/PYR_e1f1a86a10944ae9abea5b091450b692" \  -H "X-GP-Version: 2021-03-22"
{  "id": "PYR_2ee5480308664428bef46d1094f22adc",  "time_created": "2025-08-11T11:39:03.000Z",  "time_last_updated": "2025-08-11T11:39:03.000Z",  "merchant_id": "MER_c5d37eaf0e3841e083c232b2318af55c",  "merchant_name": "Sandbox_Merchant_4",  "account_id": "TKA_c1de85a8a5844c56abd9ca07bbd792c8",  "account_name": "tokenization",  "first_name": "JXXXXXX",  "last_name": "MXXXXXXX",  "reference": "Testing_Payer_Encrypted",  "action": {    "id": "ACT_tMbpPICyMawrwPFiaZ89O4bD9GvG79",    "type": "PAYER_SINGLE",    "time_created": "2025-08-11T11:43:44.185Z",    "result_code": "SUCCESS",    "app_id": "T6og1tbECpHFeO104qUM383oq5bOJ12r",    "app_name": "Postman_Collection_Test"  }}