Overview

This API specification is describing sandbox APIs provided by Global Payments Marketplace. It is available in different formats including as Open API YAML specification.

Version information

Version : 1.3

Contact information

Contact Email : apiteam@mygp.global

License information

License : Global Payments Marketplace Partner Agreement 1.0
License URL : https://mygp.cz/agreements/marketplace-partner-agreement-1.0
Terms of service : null

URI scheme

BasePath : /v1/sandbox
Schemes : HTTPS

Tags

  • customers : manipulation of sandbox customer records

  • orders : manipulation of sandbox customer orders

  • users : manipulation of sandbox user data

Paths

createSandboxCustomer

POST /customers

Description

New customer record is created for the sandbox.

Parameters

Type Name Schema

Body

request
required

CreateSandboxCustomerRequest

Responses

HTTP Code Description Schema

200

successful operation

CreateSandboxCustomerResponse

400

bad request

ApiResponse

Produces

  • application/json

Tags

  • customers

Security

Type Name Scopes

oauth2

mygp_auth

manage_sandbox_data

addGatewaysToCustomer

POST /customers/{customer_key}/add-gateways

Description

Appends new payment gateway records to an existing customer record. New gateway IDs must be unique and must not exist on the system.

Parameters

Type Name Description Schema

Path

customer_key
required

string

Body

request
optional

Only gateways property (array) of the request object must be populated.

ModifySandboxCustomerRequest

Responses

HTTP Code Description Schema

200

successful operation

AddGatewaysToCustomerResponse

400

bad request

ApiResponse

404

customer record not found

ApiResponse

Produces

  • application/json

Tags

  • customers

addOutletsToCustomer

POST /customers/{customer_key}/add-outlets

Description

Appends new outlet (brick & mortar shop) records to an existing customer record. New outlet IDs must be unique and must not exist on the system.

Parameters

Type Name Description Schema

Path

customer_key
required

string

Body

request
optional

Only outlets property (array) of the request object must be populated.

ModifySandboxCustomerRequest

Responses

HTTP Code Description Schema

200

successful operation

AddOutletsToCustomerResponse

400

bad request

ApiResponse

404

customer record not found

ApiResponse

Produces

  • application/json

Tags

  • customers

removeGatewaysFromCustomer

POST /customers/{customer_key}/remove-gateways

Description

Removes payment gateway records from an existing customer record. Gateway IDs must be linked to the customer record in order for the operation to have the desired effect.

Parameters

Type Name Description Schema

Path

customer_key
required

string

Body

request
optional

Only gateways property (array) of the request object must be populated.

ModifySandboxCustomerRequest

Responses

HTTP Code Description Schema

200

successful operation

ApiResponse

400

bad request

ApiResponse

404

customer record not found

ApiResponse

Produces

  • application/json

Tags

  • customers

removeOutletsFromCustomer

POST /customers/{customer_key}/remove-outlets

Description

Removes outlet (brick & mortar shop) records from an existing customer record. Outlet IDs must be linked to the customer record in order for the operation to have the desired effect.

Parameters

Type Name Description Schema

Path

customer_key
required

string

Body

request
optional

Only outlets property (array) of the request object must be populated.

ModifySandboxCustomerRequest

Responses

HTTP Code Description Schema

200

successful operation

ApiResponse

400

bad request

ApiResponse

404

customer record not found

ApiResponse

Produces

  • application/json

Tags

  • customers

getCustomerSubscriptions

GET /customers/{customer_key}/subscriptions

Description

Returns list of active subscription records for sandbox customer account.

Parameters

Type Name Schema

Path

customer_key
required

string

Responses

HTTP Code Description Schema

200

successful operation

GetCustomerSubscriptionsResponse

400

bad request

ApiResponse

404

customer record not found

ApiResponse

Produces

  • application/json

Tags

  • customers

createSandboxOrder

POST /orders

Description

New customer order is placed for the sandbox customer record.

Parameters

Type Name Schema

Body

request
required

CreateSandboxOrderRequest

Responses

HTTP Code Description Schema

200

successful operation

CreateSandboxOrderResponse

400

bad request

ApiResponse

404

customer record not found

ApiResponse

Tags

  • orders

Security

Type Name Scopes

oauth2

mygp_auth

manage_sandbox_data

createSandboxUser

POST /users

Description

New user account invitation is created and connected with sandbox customer record.

Parameters

Type Name Schema

Body

request
required

CreateSandboxUserRequest

Responses

HTTP Code Description Schema

200

successful operation

CreateSandboxUserResponse

400

bad request

ApiResponse

404

customer record not found

ApiResponse

Produces

  • application/json

Tags

  • users

Security

Type Name Scopes

oauth2

mygp_auth

manage_sandbox_data

Security

mygp_auth

Type : oauth2
Flow : application
Token URL : https://mygp.global/auth/realms/mygp-global/protocol/openid-connect/token

Name Description

manage_sandbox_data

manage sandbox data

Definitions

AddGatewaysToCustomerResponse

Polymorphism : Composition

Name Description Schema

code
required

Example : 200

integer (int32)

description
optional

Example : "Request was completed successfully."

string

message
required

Example : "SUCCESS"

string

outlets
required

Example : [ { "locid" : "PGWMID99008", "location_number" : "992020063951391" }, { "locid" : "OUTMID99009", "location_number" : "992020063951392" } ]

< object > array

AddOutletsToCustomerResponse

Polymorphism : Composition

Name Description Schema

code
required

Example : 200

integer (int32)

description
optional

Example : "Request was completed successfully."

string

message
required

Example : "SUCCESS"

string

outlets
required

Example : [ { "locid" : "OUTMID99006", "location_number" : "992020063991344" }, { "locid" : "OUTMID99007", "location_number" : "992020063991345" } ]

< object > array

ApiResponse

Name Description Schema

code
required

Example : 200

integer (int32)

description
optional

Example : "Request was completed successfully."

string

message
required

Example : "SUCCESS"

string

CreateSandboxCustomerRequest

Name Description Schema

gateways
optional

Example : [ "PGWMID99003", "PGWMID99004", "PGWMID99005" ]

< string > array

outlets
optional

Example : [ "OUTMID99001", "OUTMID99002" ]

< string > array

CreateSandboxCustomerResponse

Polymorphism : Composition

Name Description Schema

code
required

Example : 200

integer (int32)

customer_key
required

Example : "55a11fa2eaab24242d528a855b79973ee54319a1"

string

description
optional

Example : "Request was completed successfully."

string

message
required

Example : "SUCCESS"

string

CreateSandboxOrderRequest

Name Description Schema

customer_key
required

Example : "55a11fa2eaab24242d528a855b79973ee54319a1"

string

offer_id
optional

Example : "3BE2B9E5-4C5C-4ED3-9F93-925DD77C0214"

string (uuid)

operation
required

Example : "ADD"

enum (ADD, MODIFY, REMOVE)

subscription_id
optional

Example : "375C7547-7B76-490A-8FE9-C59AE91B49DA"

string (uuid)

CreateSandboxOrderResponse

Polymorphism : Composition

Name Description Schema

code
required

Example : 200

integer (int32)

description
optional

Example : "Request was completed successfully."

string

message
required

Example : "SUCCESS"

string

order_id
required

Example : "2D0FB6DA-5E9D-4599-952B-EC9AE0834E46"

string (uuid)

CreateSandboxUserRequest

Name Description Schema

customer_key
required

Example : "55a11fa2eaab24242d528a855b79973ee54319a1"

string

CreateSandboxUserResponse

Polymorphism : Composition

Name Description Schema

code
required

Example : 200

integer (int32)

customer_key
optional

Example : "f11532a96d16a054f254362575035c59522e9c3f"

string

description
optional

Example : "Request was completed successfully."

string

message
required

Example : "SUCCESS"

string

CustomerSubscriptionInfo

Name Description Schema

created
optional

Example : "2020-04-21T17:32:28Z"

string (date-time)

modifed
optional

Example : "2020-04-27T17:32:28Z"

string (date-time)

offer_id
optional

Example : "62c2b674-88cc-11ea-a2f9-c365138bfc0a"

string (uuid)

origin_id
optional

identifier assigned to this subscription instance on provider platform
Example : "85f8a306-88cc-11ea-bb4e-e36a2940b2dc"

string (uuid)

status
optional

Example : "ACTIVE"

string

subsciption_id
optional

Example : "54a764ae-88cc-11ea-90bb-87e0c451e1a0"

string (uuid)

GetCustomerSubscriptionsResponse

Polymorphism : Composition

Name Description Schema

code
required

Example : 200

integer (int32)

count
required

Example : 1

integer

description
optional

Example : "Request was completed successfully."

string

items
optional

< CustomerSubscriptionInfo > array

message
required

Example : "SUCCESS"

string

ModifySandboxCustomerRequest

Name Description Schema

gateways
optional

Example : [ "PGWMID99003", "PGWMID99004", "PGWMID99005" ]

< string > array

outlets
optional

Example : [ "OUTMID99001", "OUTMID99002" ]

< string > array