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

Get Merchants

GET
/merchants

Get Merchants within a Partner Program.

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.1 means the first page, 2 the second and so on.

Default1
page_size?number

The 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.

Range1 <= value <= 1000
Default5
id?string

A unique identifier for the merchant set by Global Payments.

Lengthlength <= 50
status?string

Indicates where the merchant is in its lifecycle.

  • ACTIVE - The entity is active on the Global Payments platform and can use the capabilities that are configured and active to payment process. * INACTIVE - The entity is disabled on the Global Payments platform and cannot use any payment processing capabilities. *UNDER_REVIEW - The entity is under review and cannot use any of the payment processing capabilities until the review is complete and the merchant is switched to active. * DECLINED - The entity did not complete the risk review process and cannot use any payment processing capabilities.

  • WITH_MERCHANT - The entity must submit additional information or documentation before activation.

Value in

  • "ACTIVE"
  • "INACTIVE"
  • "UNDER_REVIEW"
  • "DECLINED"
  • "WITH_MERCHANT"
name?string

This is a label to identify the merchant

Length1 <= length <= 100
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"
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.

Length1 <= length <= 50

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/merchants" \  -H "X-GP-Version: 2021-03-22"
{  "total_record_count": 1000,  "current_page_size": 564,  "merchant_id": "MER_31087d9c-e68c-4389-9f13-39378e166ea5",  "merchant_name": "Unique Username",  "account_id": "FMA_86920f927028745yt34d077d88beb29b",  "account_name": "funds_management",  "filter": {    "from_time_created": "2022-05-01",    "to_time_created": "2023-05-01"  },  "paging": {    "page_size": 5,    "page": 1,    "order": "ASC",    "order_by": "TIME_CREATED"  },  "merchants": [    {      "id": "MER_31087d9c-e68c-4389-9f13-39378e166ea5",      "name": "Unique Username",      "status": "ACTIVE",      "links": [        {          "rel": "SELF",          "href": "string"        }      ]    }  ],  "action": {    "id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "MERCHANT_CREATE",    "time_created": "2021-05-03T21:23:39.718Z",    "result_code": "SUCCESS",    "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "app_name": "my_lovely_app"  }}

Get a link GET

Get a single view of a link using the Global Payments link id. Get a single view of a link using the Global Payments ID. 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.

Board Merchant POST

Board merchant Underwrite and configure a Merchant with payment processing capability on the Global Payments system.