For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

Board Merchant

Underwrite and configure a Merchant with payment processing capability on the Global Payments system.

Header Parameters

authorizationstringrequired

Bearer access token value used to authorize and access the API. Must always begin with the string "Bearer".

example: Bearer DCKbRy6gtN6gWJI2ja0B7e3POtbb

default: Bearer DCKbRy6gtN6gWJI2ja0B7e3POtbb

content-typestringrequired

Format of the message body.

example: application/json

default: application/json

x-gp-versionstringrequired

The version of the API to execute the request.

example: 2021-03-22

default: 2021-03-22

minLength: 1

maxLength: 50

x-gp-idempotencystring

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.

minLength: 1

maxLength: 50

Request Parameters

namestringrequired

This is a label to identify the merchant

example: Unique Username

minLength: 1

maxLength: 100

typestring

Indicates the type of organization entitiy being boarded. Must always be set to MERCHANT.

MERCHANT - The entity is selling their own goods and services
PARTNER - The entity managing multiple merchants within their integration.

example: MERCHANT

legal_namestringrequired

The legal business name of the merchant being boarded.

example: Merchant XYZ Inc

minLength: 1

maxLength: 255

dbastringrequired

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

example: MERCHANT XYZ

minLength: 1

maxLength: 255

merchant_category_codestring

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

example: 5999

websitestringrequired

The merchant's business website URL

example: https://example.com/

descriptionstringrequired

A description of the merchant's business.

example: Retail

minLength: 1

maxLength: 255

registration_numberstring

This is the business's company registration number.

example: 153759456

maxLength: 55

currencystring

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

example: USD

minLength: 3

maxLength: 3

ip_addressstring

The IP the merchant signed up from.

example: 165.225.11.46

notification_emailstring

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

example: merchant@example.com

maxLength: 50

legal_entitystring

The legal entity or type of business registration of the merchant.

LIMITED_COMPANY
PUBLICLY_TRADED_CORPORATION
NON_PUBLICLY_TRADED_CORPORATION
NON_PROFT_ORGANIZATION
GOVERNMENT_ORGANIZATION
NON_PUBLICLY_TRADED_LLC
PUBLICLY_TRADED_LLC
GENERAL_PARTNERSHIP
PUBLICLY_TRADED_PARTNERSHIP
SOLE_PROPRIETORSHIP
AMERICAN_EXPRESS

example: LIMITED_COMPANY

possible values:

tax_id_referencestring

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

example: 123456789

minLength: 1

maxLength: 9

referencestring

A client indicated merchant reference identifier.

example: Merchant1234

maxLength: 50

languagestring

The preferred language of the merchant.In the format ISO-639-1 (alpha-2) or ISO-639-1 (alpha-2)_ISO-3166(alpha-2)

example: en

attestationsarray

addressesarrayrequired

payment_processing_statisticsobject

pricing_profilestring

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

example: test

maxLength: 255

payment_methodsarray

personsarrayrequired

productsarray

notificationsobject

batch_close_timestring

Specified time to close the Batch

example: 20:00

minLength: 1

maxLength: 50

configurationsobject

Response Parameters

Merchant Create Notification

merchant create notificationobject

example: {id:MER_31087d9c-e68c-4389-9f13-39378e166ea5,name:UniqueUsername,status:ACTIVE,type:MERCHANT,time_created:2019-08-24T14:15:22Z,time_last_updated:2019-08-24T14:15:22Z,email:example@email.com,address:{line_1:123MerchantStreet,line_2:Suite2,line_3:foyer,city:BeverlyHills,state:CA,postal_code:90210,country:US},contact_phone:{country_code:US,subscriber_number:string},products:[{id:PRO_31087d9c-e68c-4389-9f13-39378e166ea5,name:ACHProcessing,account:{id:FMA_02ca6d0284b743449a28aadfb702c71c,type:FUND_MANAGEMENT,name:718586025_753619,status:ACTIVE,channel:[CNP],time_created:2019-08-24T14:15:22Z,permissions:[APP_GET_Single_Key]}}],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}}

Endpoints

POSThttps://apis.sandbox.globalpay.com/ucp/merchants

POSThttps://apis.globalpay.com/ucp/merchants

Examples

NO BODY REQUIRED

Policies

Connect

Additional Resources

Board Merchant

Header Parameters

Request Parameters

Response Parameters

Merchant Create Notification

Endpoints

Board Merchant

Header Parameters

Request Parameters

Response Parameters200 Success

Merchant Create Notification

Endpoints

200 SuccessCOPY

Response Parameters