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

Upload Merchant Documentation

POST
/merchants/{id}/documents

Upload merchant documentation

Upload documentation related to 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

function?string

This is the intended function of the document being uploaded. * IDENTITY_VERIFICATION indicates a document that is used to validate the identity of applicant. Generally, this would only be required if the automated validation fails. * RISK_REVIEW indicates a document that has been requested by the risk or fraud prevention team of the platform. * UNDERWRITING indicates documentation related to a processing volume increase request.

Value in

  • "IDENTITY_VERIFICATION"
  • "RISK_REVIEW"
  • "UNDERWRITING"
b64_content?string

The document to be uploaded in base64 format.

Length1 <= length <= 250
format?string

This is the format of the file being uploaded.

Value in

  • "TIF"
  • "TIFF"
  • "PDF"
  • "BMP"
  • "JPEG"
  • "GIF"
  • "PNG"
  • "DOC"
  • "DOCX"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/merchants/MER_31087d9c-e68c-4389-9f13-39378e166ea5/documents" \  -H "X-GP-Version: 2021-03-22" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "DOC_34uTXDOO6KXgFO7I2ojADxH4KfrCz5",  "status": "UPLOADED",  "name": "UNDERWRITING_718564831_8vOut0YO32",  "action": {    "id": "ACT_124234234234234234",    "type": "DOCUMENT_UPLOAD",    "time_created": "2021-05-03T21:23:39.718Z",    "result_code": "SUCCESS",    "app_id": "U1lRHKomEn7DN907RCDPxVhyMfiMLcfy",    "app_name": "demo_app"  }}

Edit Merchant PATCH

Edit merchant Edit the detail associated with a Merchant.

Address Lookup GET

To ensure the appropriate formatting of an address is included as part of a UK merchant boarding application, you can use Address Lookup to perform a search on all addresses with a certain house number or house name within a postal code.