Payment Methods
Search for a Payment Method
Return a list of stored payment methods where search criteria is in the message body.
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.
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
account_name?string
A meaningful label for the merchant account set by Global Payments.
Length
1 <= length <= 50card?
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/payment-methods/search" \ -H "X-GP-Version: 2021-03-22" \ -H "Content-Type: application/json" \ -d '{ "account_name": "Tokenization", "card": { "number": "4263970000005262", "expiry_month": "05", "expiry_year": "25" } }'{ "total_record_count": 1000, "current_page_size": 564, "merchant_id": "MER_c4c0df11039c48a9b63701adeaa296c3", "merchant_name": "Sandbox_merchant_2", "account_id": "TRA_86920f927028745yt34d077d88beb29b", "account_name": "Tokenization", "filter": { "account_name": "Tokenization", "number": "4263970000005262", "expiry_month": "05", "expiry_year": "25" }, "paging": { "page": 1, "page_size": 5, "order_by": "TIME_CREATED", "order": "ASC" }, "payment_methods": [ { "id": "PMT_f5bbdfde-3010-4802-8f5d-1cdb2a2381c2", "time_created": "2021-05-03T21:23:39.718Z", "status": "ACTIVE", "reference": "CustABC_Card_1", "card": { "number_last4": "string", "brand": "VISA", "expiry_month": "05", "expiry_year": "25", "masked_network_token_last4": "xxxxxxxxxxxx5262", "network_token_expiry_month": "05", "network_token_expiry_year": "25" } } ], "action": { "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d", "type": "PAYMENT_METHOD_CREATE", "time_created": "2021-05-03T21:23:39.718Z", "result_code": "SUCCESS", "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d", "app_name": "my_lovely_app" }}