Sign in

v1

latestOpenAPI 3.0.12026-07-2356172250.9 KB
Business Contact

Get business contact by Id

Retrieve a specific business contact for the specified merchant using the businessContactId.

get/api/demographics/v1/BusinessContacts/{merchantNumber}/{businessContactId}

Path parameters

merchantNumberstring required

The merchant's unique identification number.

businessContactIdinteger required

The unique identifier for the business contact.

Query parameters

encryptedSsnboolean

Specifies whether to return the Social Security Number (SSN) in encrypted format. Default: false.

Response

Returns a single business contact successfully.

businessContactIdinteger

Unique identifier for the business contact.

ownershipAmountstring nullable

Ownership percentage or amount associated with the contact.

emailAddressstring required

The email address of the business contact.

titlestring nullable

Job title or position of the business contact.

isCompassUserboolean

Indicates whether the contact is a Compass user.

isMerchantHomeUserboolean

Indicates whether the contact is a Merchant Home user.

isVirtualTerminalUserboolean

Indicates whether the contact is a Virtual Terminal user.

isAuthorizedToPurchaseboolean

Specifies if the contact is authorized to make purchases.