Payers

Create a Payer

POST
/payers

Create a Payer on the Global Payments system that can be used when creating a sale.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

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

Request Body

application/json

first_name*string

The first name of the Payer

Length1 <= length <= 50
last_name*string

The last name of the Payer

Length1 <= length <= 50
reference?string

This is a label set by the integrator to identify the Payer

Length1 <= length <= 50
email?string

The email address of the payer.

language?string

The preferred language of the payer. In the format ISO-639-1 (alpha-2) or ISO-639-1 (alpha-2)_ISO-3166(alpha-2)

payment_methods?array<>

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/payers" \  -H "X-GP-Version: 2021-03-22" \  -H "Content-Type: application/json" \  -d '{    "first_name": "John",    "last_name": "James",    "reference": "payer-123",    "payment_methods": [      {        "id": "PMT_oOAH6BClraQWS3Qy07dh7tZAN3X2nW",        "default": "YES"      }    ]  }'
{  "id": "PYR_2ee5480308664428bef46d1094f22adc",  "time_created": "2025-08-11T11:39:03.000Z",  "time_last_updated": "2025-08-11T11:39:03.000Z",  "first_name": "JXXXXXX",  "last_name": "MXXXXXXX",  "reference": "Testing_Payer_Encrypted",  "merchant_id": "MER_c5d37eaf0e3841e083c232b2318af55c",  "merchant_name": "Sandbox_Merchant_4",  "account_id": "TKA_c1de85a8a5844c56abd9ca07bbd792c8",  "account_name": "tokenization",  "action": {    "id": "ACT_YiMFP1AyT8984XMkfKdVvEv1IxbkSp",    "type": "PAYER_CREATE",    "time_created": "2025-08-11T11:39:03.194Z",    "result_code": "SUCCESS",    "app_id": "T6og1tbECpHFeO104qUM383oq5bOJ12r",    "app_name": "Postman_Collection_Test"  }}