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

Get Orders

GET
/merchants/{id}/orders

Get a list of Orders

Get a list of orders made for a particular merchant. Page through the result set to access all records.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

This is the merchant id to uniquely identify the entity on the Global Payments system.

Lengthlength <= 50

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/MER_31087d9c-e68c-4389-9f13-39378e166ea5/orders" \  -H "X-GP-Version: 2021-03-22"
{  "total_record_count": 1000,  "current_page_size": 564,  "merchant_id": "MER_c4c0df11039c48a9b63701adeaa296c3",  "merchant_name": "Curtis_Douglas49",  "account_id": "TRA_6491c2bb5c5344f28a053f7698e522e9",  "account_name": "transaciton processing",  "filter": {    "from__time_created": "2019-08-24",    "to_time_created": "2023-05-01",    "id": "ORD_zvQ6JT0n0wfhaztiL8vCyE0yQslvkz",    "status": "INITIATED"  },  "paging": {    "page": 1,    "page_size": 5,    "order_by": "TIME_CREATED",    "order": "ASC"  },  "orders": [    {      "id": "ORD_zvQ6JT0n0wfhaztiL8vCyE0yQslvkz",      "merchant_id": "MER_c4c0df11039c48a9b63701adeaa296c3",      "merchant_name": "Curtis_Douglas49",      "status": "INITIATED",      "account_id": "TRA_6491c2bb5c5344f28a053f7698e522e9",      "account_name": "transaciton processing",      "time_created": "2023-03-10T13:14:48.386Z",      "time_last_updated": "2023-03-10T13:14:48.386Z",      "reference": "string"    }  ],  "action": {    "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "ORDER_INITIATED",    "time_created": "2023-03-10T13:14:48.386Z",    "result_code": "SUCCESS",    "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "app_name": "my_lovely_app"  }}

Address Lookup GET

To ensure the appropriate formatting of an address is included as part of a UK merchant boarding application, you can use Address Lookup to perform a search on all addresses with a certain house number or house name within a postal code.

Create an Order POST

Allows an embedded partner to order a device used for card present transactions or check the price of a potential order.