Payers
Edit a Payer
Update the information associated with a 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 platform.
Length
1 <= length <= 50Header Parameters
X-GP-Version*string
The version of the API to execute the request.
Length
1 <= length <= 50Default
"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.
Length
1 <= length <= 50Request Body
application/json
first_name?string
The first name of the Payer
Length
1 <= length <= 50last_name?string
The last name of the Payer
Length
1 <= length <= 50reference?string
This is a label set by the integrator to identify the Payer
Length
1 <= length <= 50payment_methods?array<>
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/payers/PYR_oOAH6BClraQWS3Qy07dh7tZAN3X2nW" \ -H "X-GP-Version: 2021-03-22" \ -H "Content-Type: application/json" \ -d '{ "first_name": "John", "last_name": "James" }'{ "id": "PYR_2ee5480308664428bef46d1094f22adc", "time_created": "2025-08-11T11:39:03.000Z", "time_last_updated": "2025-08-11T11:46:43.000Z", "first_name": "JXXX", "last_name": "JXXXX", "reference": "Testing_Payer_Encrypted", "merchant_id": "MER_c5d37eaf0e3841e083c232b2318af55c", "merchant_name": "Sandbox_Merchant_4", "account_id": "TKA_c1de85a8a5844c56abd9ca07bbd792c8", "account_name": "tokenization", "payment_methods": [ { "id": "PMT_ffc2fc7e-7292-4f3b-9798-5c231414158a", "default": "YES" } ], "action": { "id": "ACT_KXSqpFbwbZTyH8XHeN5Z6Bw6aaXarP", "type": "PAYER_EDIT", "time_created": "2025-08-11T11:46:43.089Z", "result_code": "SUCCESS", "app_id": "T6og1tbECpHFeO104qUM383oq5bOJ12r", "app_name": "Postman_Collection_Test" }}