Global Payments API
GP Developer PortalGP API reference
HomeAPI ReferenceSDKsContext Plugin
Reports

Get a Transaction Summary Report

GET
/reports

Transaction Summary Report

Get an aggregated view of all Transactions across all Payment Methods. Availability of this feature in production depends on your allowed live configuration. Please contact Global Payments before coding this feature to confirm it will be available to you when you go live.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

payment_method.category?string

The payment method category used in the Transaction

Value in

  • "CARD"
  • "APM"
  • "DIGITAL_WALLETS"
  • "BANK_TRANSFER"
  • "UNKNOWN"
type*"TRANSACTION_SUMMARY"

Indicates the report type

Value in

  • "TRANSACTION_SUMMARY"
payment_method.brand?string

The Payment method brand used in the Transaction

Value in

  • "TESTPAY"
  • "PAYPAL"
  • "SOFORT"
  • "IDEAL"
  • "GIROPAY"
  • "OPEN_BANKING"
  • "WECHAT"
  • "ALIPAY"
  • "VISA"
  • "MASTERCARD"
  • "AMEX"
  • "DINERS"
  • "DISCOVER"
  • "JCB"
  • "CUP"
  • "APPLE_PAY"
  • "GOOGLE_PAY"
from_time_created?string

The start time to search for in a range, using the resource time_created value.

Formatdate
to_time_created?string

The end time to search for in a range, using the resource time_created value.

Formatdate

Header Parameters

X-GP-Version*string

The version of the API to execute the request.

Length1 <= length <= 50
Default"2021-03-22"

Response Body

application/json

curl -X GET "https://example.com/reports?type=TRANSACTION_SUMMARY" \  -H "X-GP-Version: 2021-03-22"
{  "current_page_size": 564,  "merchant_id": "MER_31087d9c-e68c-4389-9f13-39378e166ea5",  "merchant_name": "Sandbox_merchant_2",  "account_id": "DAA_86920f927028745yt34d077d88beb29b",  "account_name": "Settlement_Reporting",  "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"  },  "reports": [    {      "type": "TRANSACTION_SUMMARY",      "summary": {        "sales": {          "count": 5,          "amount": "100"        },        "refunds": {          "count": 5,          "amount": "100"        }      },      "payment_method_breakdown": [        {          "category": "CARD",          "brand": "VISA",          "count": 5,          "amount": "100",          "gratuity_amount": "100",          "sales": {            "count": 5,            "amount": "100"          },          "refunds": {            "count": 5,            "amount": "100"          },          "reversals": {            "count": 5,            "amount": "100"          }        }      ]    }  ],  "action": {    "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "REPORT_LIST",    "time_created": "2021-05-03T21:23:39.718Z",    "result_code": "SUCCESS",    "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "app_name": "my_lovely_app"  }}

Delete a Payer DELETE

Delete a payer Delete a Payer.

List Transactions GET

Get a list of transactions recently processed, using criteria passed in the query string. Page through the result set to access all records. Availability of this feature in production depends on your allowed live configuration. Please contact Global Payments before coding this feature to confirm it will be available to you when you go live.