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

Get Merchant's Account info

GET
/accounts

Get information about the merchant's accounts.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

page?number

Indicates the page sequence to return in the response. The number of records presented on each page is determined by page_size field.

Range1 <= value <= 1000
Default1
page_size?number

The total number of objects to return in a single page for that list.

Range1 <= value <= 1000
Default5
order?string

The direction of the ordering of the entire list, ASC or DESC

Value in

  • "ASC"
  • "DESC"
order_by?"TIME_CREATED"

The value to order the entire list by.

Value in

  • "TIME_CREATED"
status?string

Indicates where a configured entity on the Global Payments system is in its lifecycle. * ACTIVE - The configured entity is able to execute related API actions. * INACTIVE - The configured entity is not able to execute related API actions as its status has been set to inactive.

Length0 <= length <= 50

Value in

  • "ACTIVE"
  • "INACTIVE"
name?string

A meaningful label for the merchant account set by Global Payments.

Length1 <= length <= 50
id?string

A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.

Length1 <= length <= 50
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

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/accounts" \  -H "X-GP-Version: 2021-03-22"
Empty

Create Access Token POST

Create a bearer access token. Using your app credentials, send a request to create a bearer access token that can be used to execute subsequent API actions. The actions that the token can execute are determined by the permissions the app has.

Get info about a Single Account GET

Get the details of a single Account using its unique id.