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

Board Merchant

POST
/merchants

Board merchant

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

Authorization

bearerAuth
AuthorizationBearer <token>

Access token from POST /accesstoken, sent as Authorization: Bearer <token>.

In: header

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
type?string

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.
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.

website*string

The merchant's business website URL

description*string

A description of the merchant's business.

Length1 <= length <= 255
registration_number?string

This is the business's company registration number.

Lengthlength <= 55
currency?string

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

Length3 <= length <= 3
ip_address?string

The IP the merchant signed up from.

notification_email?string

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

Lengthlength <= 50
legal_entity?string

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

Value in

  • "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"
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
reference?string

A client indicated merchant reference identifier.

Lengthlength <= 50
language?string

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

attestations?array<>
addresses*array<>
payment_processing_statistics?
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
payment_methods?array<>
persons*array<>
products?array<>
notifications?
batch_close_time?string

Specified time to close the Batch

Length1 <= length <= 50
configurations?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Callbacks

curl -X POST "https://example.com/merchants" \  -H "X-GP-Version: 2021-03-22" \  -H "Content-Type: application/json" \  -d '{    "name": "{{$randomUserName}}",    "type": "MERCHANT",    "legal_name": "Global Payments Inc.",    "dba": "Global Payments",    "merchant_category_code": "5999",    "website": "https://www.example.com",    "description": "SAAS and Payments as a Service",    "currency": "CAD",    "ip_address": "165.225.11.46",    "reference": "767867986879",    "tax_id_reference": "153759426",    "notification_email": "merchantsupport@example.com",    "laguage": "en",    "pricing_profile": "Canada Test",    "attestations": [      {        "name": "PROPAY_SUB_MERCHANT_TERMS_AND_CONDITIONS",        "ip_address": "165.225.11.46",        "time_of_attestation": "2021-05-03T21:23:39.718Z"      },      {        "Name": "beneficial_owner",        "ip_address": "165.225.11.46",        "time_of_attestation": "2021-05-03T21:23:39.718Z"      }    ],    "addresses": [      {        "functions": [          "BUSINESS"        ],        "line_1": "1 Business Address",        "line_2": "Suite 2",        "line_3": "foyer",        "city": "Winnipeg",        "state": "MB",        "postal_code": "R2J 1Z6",        "country": "CA"      },      {        "functions": [          "SHIPPING"        ],        "line_1": "1 Shipping Address",        "line_2": "Suite 2",        "line_3": "foyer",        "city": "Wi",        "state": "MB",        "postal_code": "R2J 1Z6",        "country": "CA"      }    ],    "payment_processing_statistics": {      "total_monthly_sales_amount": "3000000",      "average_ticket_sales_amount": "50000",      "highest_ticket_sales_amount": "60000"    },    "payment_methods": [      {        "functions": [          "ACCOUNT_ACTIVATION_FEE"        ],        "name": "Card Holder Name",        "reference": "1234",        "card": {          "number": "4263970000005262",          "expiry_month": "01",          "expiry_year": "25",          "cvv": "123",          "address": {            "line_1": "1 Business Address",            "line_2": "Suite 2",            "line_3": "foyer",            "city": "Winnipeg",            "state": "MB",            "postal_code": "R2J 1Z6",            "country": "CA"          }        }      },      {        "functions": [          "PRIMARY_PAYOUT",          "SECONDARY_PAYOUT"        ],        "name": "John’s National Bank Account",        "reference": "My National Bank Account",        "bank_transfer": {          "account_holder_type": "PERSONAL",          "account_type": "CHECKING",          "account_number": "156423786",          "bank": {            "name": "National Bank ",            "code": "000126829",            "address": {              "line_1": "1 Business Address",              "line_2": "Suite 2",              "line_3": "foyer",              "city": "Winnipeg",              "state": "MB",              "postal_code": "R2J 1Z6",              "country": "CA"            }          }        }      }    ],    "persons": [      {        "functions": [          "APPLICANT",          "BENEFICIAL_OWNER"        ],        "first_name": "John",        "middle_name": "G",        "last_name": "Doe",        "email": "{{$randomEmail}}",        "date_of_birth": "1988-01-31",        "job_title": "CEO",        "national_id_reference": "132435169",        "addresses": [          {            "functions": [              "PERSONAL"            ],            "line_1": "1 Business Address",            "line_2": "Suite 2",            "line_3": "foyer",            "city": "Winnipeg",            "state": "MB",            "postal_code": "R2J 1Z6",            "country": "CA",            "contact_phone": {              "country_code": "1",              "subscriber_number": "8008675309"            },            "work_phone": {              "country_code": "1",              "subscriber_number": "8008675309"            }          }        ]      }    ],    "products": [      {        "id": "PRO_FMA_PUSH-FUNDS_PP"      },      {        "id": "PRO_TRA_CNP_PPP"      },      {        "id": "PRO_d02541e6-84e4-48e7-86a3-dddb68f51310"      }    ],    "notifications": {      "status_url": "https://www.example.com/notifications/status"    }  }'
{  "id": "MER_31087d9c-e68c-4389-9f13-39378e166ea5",  "name": "Unique Username",  "status": "ACTIVE",  "type": "MERCHANT",  "time_created": "2021-05-03T21:23:39.718Z",  "time_last_updated": "2021-05-03T21:23:39.718Z",  "status_description": "string",  "action": {    "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "MERCHANT_EDIT",    "time_created": "2021-05-03T21:23:39.718Z",    "result_code": "SUCCESS",    "app_id": "U1lRHKomEn7DN907RCDPxVhyMfiMLcfy",    "app_name": "demo_app"  }}

Get Merchants GET

Get Merchants within a Partner Program.

Get Merchant info GET

Get information about the merchant executing the action.