Get a list of Actions
Get a list of Actions using criteria passed in the query string. Page through the result set to access all records.
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"ID of the action that was executed that initialed the activity this notification is providing an update on.
The type of action that was executed that initialed the activity this notification is providing an update on.
The resource the action is directly related to.
The status of the resource the action is directly related to.
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.
dateA meaningful label for the merchant set by Global Payments.
1 <= length <= 50A meaningful label for the merchant account set by Global Payments.
1 <= length <= 50The name of the app that is being used to execute and sign the action
The version of the platform the action relates to.
The error code of the action if the action resulted in an error.
The HTTP response code for the action.
The Id of a specific resource linked to the action.
Header 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/actions?resource=TRANSACTIONS" \ -H "X-GP-Version: 2021-03-22"{ "total_record_count": 1000, "current_page_size": 564, "merchant_id": "MER_c4c0df11039c48a9b63701adeaa296c3", "merchant_name": "Sandbox_merchant_2", "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" }, "actions": [ { "id": "ACT_bxWus66W5qSTCcGECIPUT5zLhISaMy", "type": "MERCHANT_EDIT", "time_created": "2019-08-24T14:15:22Z", "resource": "string", "resource_id": "string", "resource_status": "string", "version": "string", "http_response_code": "string", "response_code": "string", "app_id": "string", "app_name": "string", "merchant_name": "Sandbox_merchant_2", "account_name": "transaction_processing" } ], "action": { "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d", "type": "TRANSFER", "time_created": "2021-05-03T21:23:39.718Z", "result_code": "SUCCESS", "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d", "app_name": "my_lovely_app" }}