Merchants

Get Merchant info

GET
/merchants/{id}

Get information about the merchant executing the action.

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"

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" \  -H "X-GP-Version: 2021-03-22"
{  "id": "MER_31087d9c-e68c-4389-9f13-39378e166ea5",  "type": "MERCHANT",  "time_created": "2019-08-24T14:15:22Z",  "time_last_updated": "2019-08-24T14:15:22Z",  "status": "ACTIVE",  "status_reason": "CLOSED_BY_MERCHANT",  "name": "Unique Username",  "reference": "Merchant1234",  "currency": "USD",  "dba": "MERCHANT XYZ",  "website": "https://example.com/",  "tax_id_reference": "123456789",  "notification_email": "merchant@example.com",  "pricing_profile": "test",  "prepaid_card_status": "ACTIVE",  "notifications": {    "status_url": "https://www.example.com/notifications/status"  },  "persons": [    {      "functions": [        "APPLICANT"      ],      "first_name": "James",      "middle_name": "A",      "last_name": "Mason",      "email": "example@email.com",      "address": {        "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": "US",        "subscriber_number": "string"      },      "work_phone": {        "country_code": "US",        "subscriber_number": "string"      }    }  ],  "addresses": [    {      "functions": [        "BUSINESS"      ],      "line_1": "123 Merchant Street",      "line_2": "Suite 2",      "line_3": "foyer",      "city": "Beverly Hills",      "state": "CA",      "postal_code": "90210",      "country": "US"    }  ],  "payment_methods": [    {      "functions": [        "ACCOUNT_ACTIVATION_FEE"      ],      "name": "Johns Payment Method",      "bank_transfer": {        "account_holder_type": "PERSONAL",        "masked_number_last4": "1234",        "account_type": "CHECKING",        "bank": {          "code": "124002971",          "name": "High Street",          "address": {            "line_1": "123 Merchant Street",            "line_2": "Suite 2",            "line_3": "foyer",            "city": "Beverly Hills",            "state": "CA",            "postal_code": "90210",            "country": "US"          }        }      }    }  ],  "start_date": "1980-01-01",  "expiration_date": "1980-01-01",  "action": {    "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "MERCHANT_CREATE",    "time_created": "2021-05-03T21:23:39.718Z",    "result_code": "SUCCESS",    "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "app_name": "my_lovely_app"  }}