v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Gateway Features
Merchants

Get a Specific Merchant's Information

❗️ Never Use Real API Keys

Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.

<details> <summary>Usage</summary> <p>This request will return all the details of a specific merchant account. If you need to get multiple merchants' info at once, use the <a href="../reference/getmerchantlist" title="Get Merchant List">Get Merchant List</a> request.</p> </details>
get/v4/merchants/{gateway_id}

Path parameters

gateway_idstring required

The merchant ID that the request should operate on.

Headers

Content-Typestring required

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

Authorizationstring required

Your v4 API key that was generated in the Partner portal.

Response

Success

objectType'serviceConfig'

The type of object that was returned as a result of the request.

idstring

The ID for the transaction.

createdstring date-time

The timestamp indicating when the transaction was created.

updatedstring date-time

The timestamp indicating when the transaction was last updated.

firstNamestring

The first name of the merchant's company contact.

lastNamestring

The last name of the merchant's company contact.

companystring

The merchant's company name.

emailstring

The email of the merchant's company contact.

phonestring

The phone number of the merchant's company contact.

faxstring

The fax number of the merchant's company contact.

address1string

The first line of the merchant's address.

address2string

The second line of the merchant's address.

citystring

The city associated with the merchant's address.

statestring

The state associated with the merchant's address.

zipstring

The postal code associated with the merchant's address.

countrystring

The country associated with the merchant's address.

timezonestring

The merchant's timezone.

costPlanstring

The cost plan assigned to the merchant.

statusstring

The status of the merchant.

externalIdentifierstring

A description to further describe or identify the merchant.

lastTransactionDatestring

The date of the last transaction on the merchant.

parentAffiliateIdstring

The ID of the affiliate directly above the merchant.

needsPendingServicesActivatedstring

Merchant needs pending services activated.

payFacBillingPeriodstring

Payment Facilitator Billing Period.

rejectedCertificatesstring

Number of rejected certificates.