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

Edit Merchant

PATCH
/merchants/{id}

Edit merchant

Edit the detail associated with a Merchant.

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

Request Body

application/json

name?string

This is a label to identify the merchant

Length1 <= length <= 100
status_change_reason?string

This is the reason or nature of the status.

  • 'ACTIVE - The merchant is in good standing.
  • CLOSED_BY_MERCHANT - The merchant has been closed at the request of the merchant or partner.
  • CLOSED_BY_RISK - The merchant has been closed by a Global Payments Risk Team.
  • APPLICATION_DENIED - The merchant application has been denied by the Global Payments Risk Team.
  • PENDING_REVIEW - The merchant application is pending review from the Global Payments Risk Team.
  • PENDING_MERCHANT_CONSENT - The merchant must agree to terms and conditions prior to accepting payments.
  • PENDING_IDENTITY_VALIDATION - The applicant's identity and/or business documents must be reviewed by the Global Payments Risk Team.
  • PENDING_IDENTITY_VALIDATION_AND_PAYMENT - The applicant's identity and/or business documents must be reviewed by the Global Payments Risk Team and submit payment.
  • PENDING_PAYMENT - The merchant must submit payment.
  • UNKNOWN_STATUS - Contact your relationship manager for more details.
  • REMOVE_PARTNERSHIP - The partner has requested to disassociate the merchant from the partner program.

Value in

  • "ACTIVE"
  • "CLOSED_BY_MERCHANT"
  • "CLOSED_BY_RISK"
  • "APPLICATION_DENIED"
  • "PENDING_REVIEW"
  • "PENDING_MERCHANT_CONSENT"
  • "PENDING_IDENTITY_VALIDATION"
  • "PENDING_IDENTITY_VALIDATION_AND_PAYMENT"
  • "PENDING_PAYMENT"
  • "UNKNOWN_STATUS"
  • "REMOVE_PARTNERSHIP"
legal_name?string

The legal business name of the merchant being boarded.

Length1 <= length <= 255
dba?string

The merchant's DBA (Doing Business As) name or the alternate name the merchant may be known as.

Length1 <= length <= 255
merchant_category_code?string

A four-digit number used to classify the merchant into an industry or market segment.

webstite?string

The merchant's business website URL

description?string

A description of the merchant's business.

Length1 <= length <= 255
currency?string

The currency in which the funds are held in ISO-4217(alpha-3).

Length3 <= length <= 3
tax_id_reference?string

The merchantes tax identification number. For exampe, in the US the (EIN) Employer Identification Number would be used

Length1 <= length <= 9
notification_email?string

Primary email configured with the merchant. If not provided, communication will be routed to persons.email, where function= APPLICANT

Lengthlength <= 50
pricing_profile?string

Describes the pricing profile the merchant is to be configured for. This will drive the services, pricing and limits configured for merchant boarding

Lengthlength <= 255
addresses?array<>
persons?array<>
payment_processing_statistics?
payment_methods?array<>
notifications?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Callbacks

curl -X PATCH "https://example.com/merchants/MER_31087d9c-e68c-4389-9f13-39378e166ea5" \  -H "X-GP-Version: 2021-03-22" \  -H "Content-Type: application/json" \  -d '{    "payment_methods": [      {        "functions": [          "PRIMARY_PAYOUT"        ],        "name": "primary bank name",        "reference": "1234567",        "bank_transfer": {          "account_holder_type": "PERSONAL",          "account_type": "CHECKING",          "account_number": "1234567",          "bank": {            "name": "bank name",            "code": "83908420",            "international_code": "83908420",            "address": {              "line_1": "123 St",              "line_2": "Suite 2",              "line_3": "1234",              "city": "Mesa",              "state": "AZ",              "postal_code": "85284",              "country": "US"            }          }        },        "notifications": {          "status_url": "https://www.webhooknotificationurl.com/"        }      }    ]  }'
{  "id": "MER_31087d9c-e68c-4389-9f13-39378e166ea5",  "name": "Unique Username",  "status": "ACTIVE",  "type": "MERCHANT",  "time_created": "2019-08-24T14:15:22Z",  "time_last_updated": "2019-08-24T14:15:22Z",  "status_description": "Merchant Boarding in progress",  "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"  }}

Get Merchant info GET

Get information about the merchant executing the action.

Upload Merchant Documentation POST

Upload merchant documentation Upload documentation related to a Merchant.