List Payment Methods
Return a list of stored payment methods.
Authorization
bearerAuth Access token from POST /accesstoken, sent as Authorization: Bearer <token>.
In: header
Query Parameters
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.
1The total number of records to return in a single page for a list. The maximum this value can be is 1000, meaning that the maximum number of records to return in a single request is 1000.
1 <= value <= 10005The direction of the ordering of the entire list, ASC or DESC
Value in
- "ASC"
- "DESC"
The field to order the list by.
"TIME_CREATED"Merchant defined field to uniquely reference the stored payment method.
1 <= length <= 50The overall status of the payment method.
ACTIVE- The entity is ACTIVE and can be used.INACTIVE- The entity is INACTIVE and cannot be used."DELETE- The status is DELETED. Once returned in an action response for a resource. The resource has been removed from the platform.
Value in
- "ACTIVE"
- "INACTIVE"
- "DELETED"
The start time to search for in a range, using the resource time_created value.
dateThe end time to search for in a range, using the resource time_created value.
dateThe start time to search for in a range, using time_last_updated value.
date-timeThe end time to search for in a range, using time_last_updated value
date-timeUnique Global Payments generated id used to reference a stored payment method on the Global Payments system. Often referred to as the payment method token. This value can be used instead of payment method details such as a card number and expiry date.
length <= 50Header Parameters
The version of the API to execute the request.
1 <= length <= 50"2021-03-22"Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/payment-methods" \ -H "X-GP-Version: 2021-03-22"{ "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": { "from_time_created": "2022-05-01", "to_time_created": "2023-05-01" }, "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" }}