Create an Order
Allows an embedded partner to order a device used for card present transactions or check the price of a potential order.
Authorization
bearerAuth Access token from POST /accesstoken, sent as Authorization: Bearer <token>.
In: header
Path Parameters
This is the merchant id to uniquely identify the entity on the Global Payments system.
length <= 50Header Parameters
The version of the API to execute the request.
1 <= length <= 50"2021-03-22"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.
1 <= length <= 50Request Body
application/json
The pricing profile the ordering merchant is configured for. Only required if the merchant has changed to a new pricing profile after boarding.
length <= 255The only option for an orders request is FOR_REVIEW.
FOR_REIVEW- When passed in order request body, the price of the potential order will be shown. Device will not be requested until order has been completed (see complete order).
Value in
- "FOR_REVIEW"
Specified time to close the Batch
1 <= length <= 50Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/merchants/MER_31087d9c-e68c-4389-9f13-39378e166ea5/orders" \ -H "X-GP-Version: 2021-03-22" \ -H "Content-Type: application/json" \ -d '{ "products": { "id": "PRO_TRA_CP-US-CARD-A920_SP", "name": "string", "device": { "quantity": "1", "manufacturer_model": "A920", "account_name_format": "SERIAL_NUMBER" } }, "pricing_profile": "test", "addresses": { "functions": "SHIPPING", "name": "John Doe", "email": "Gerda.Johnston43@yahoo.com", "line_1": "123 Merchant Street", "line_2": "Suite 2", "line_3": "foyer", "city": "Beverly Hills", "state": "CA", "postal_code": "90210", "country": "US", "contact_phone": { "country_code": "01", "subscriber_number": "8008675309" } }, "payment_method": { "name": "John Doe", "card": { "number": "4111111111111111", "cvv": "852", "expiry_month": "11", "expiry_year": "30", "avs_postal_code": "90210" } }, "notifications": { "status_url": "https://www.example.com/notifications/status" } }'{ "id": "ORD_zvQ6JT0n0wfhaztiL8vCyE0yQslvkz", "merchant_id": "MER_c4c0df11039c48a9b63701adeaa296c3", "merchant_name": "Curtis_Douglas49", "status": "INITIATED", "time_created": "2023-03-10T13:14:48.386Z", "time_last_updated": "2023-03-10T13:14:48.386Z", "action": { "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d", "type": "ORDER_INITIATED", "time_created": "2021-05-03T21:23:39.718Z", "result_code": "SUCCESS", "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d", "app_name": "my_lovely_app" }}