Business Contact
Retrieve a specific business contact for the specified merchant using the businessContactId.
The merchant's unique identification number.
The unique identifier for the business contact.
Specifies whether to return the Social Security Number (SSN) in encrypted format. Default: false.
falseReturns a single business contact successfully.
Bad Request: If merchant number is null or empty.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Not Found: BusinessContacts not found.
Internal Server Error: This could be due to system errors. Please contact support for assistance.
GET /api/demographics/v1/BusinessContacts/{merchantNumber}/{businessContactId} HTTP/1.1
Host:
Accept: */*
{
"phoneNumbers": [
{
"phoneTypeCodeID": "1",
"areaCode": "212",
"phoneNumber": "5551234",
"extension": "101"
}
],
"businessContactId": 12345,
"contact": {
"countryOfCitizenshipCode": "840",
"address": {
"line1": "1234 Main St",
"line2": "Apt 101",
"line3": "Suite 200",
"city": "New York",
"countryCode": "1",
"stateCode": "NY",
"zip": "10001"
},
"ssnLastFour": "8786",
"encryptedSSN": "U2FsdGVkX1+...",
"ssn": "123456789",
"contactId": 632852759,
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1985-05-20",
"dateOfBirthString": "20051985"
},
"ownershipAmount": "25.5",
"emailAddress": "[email protected]",
"title": "Manager",
"contactTypes": [
{
"businessContactContactTypeID": 7781268,
"businessContactID": 76578,
"contactTypeID": 3
}
],
"isCompassUser": true,
"isMerchantHomeUser": false,
"isVirtualTerminalUser": true,
"isAuthorizedToPurchase": true
}Update an existing business contact for the specified merchant.
Note: The request requires the merchantNumber and businessContactId as route parameters, and the updated business contact details in the request body.
The merchant's unique identification number.
The unique identifier for the business contact.
Specifies whether to return the Social Security Number (SSN) in encrypted format. Default: false.
falseUnique identifier for the business contact.
12345Ownership percentage or amount associated with the contact.
25.5The email address of the business contact.
[email protected]Job title or position of the business contact.
ManagerIndicates whether the contact is a Compass user.
trueIndicates whether the contact is a Merchant Home user.
falseIndicates whether the contact is a Virtual Terminal user.
trueSpecifies if the contact is authorized to make purchases.
trueUpdates a business contact successfully.
Accepted: Request change was accepted.
Bad Request: If merchantNumber is null or empty, or data is invalid.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Not Found: If contact is not found.
Conflict: Request change was rejected because there is another one.
Internal Server Error: This could be due to system errors. Please contact support for assistance
PUT /api/demographics/v1/BusinessContacts/{merchantNumber}/{businessContactId} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 761
{
"phoneNumbers": [
{
"phoneTypeCodeID": "1",
"areaCode": "212",
"phoneNumber": "5551234",
"extension": "101"
}
],
"businessContactId": 12345,
"contact": {
"countryOfCitizenshipCode": "840",
"address": {
"line1": "1234 Main St",
"line2": "Apt 101",
"line3": "Suite 200",
"city": "New York",
"countryCode": "1",
"stateCode": "NY",
"zip": "10001"
},
"ssnLastFour": "8786",
"encryptedSSN": "U2FsdGVkX1+...",
"ssn": "123456789",
"contactId": 632852759,
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1985-05-20"
},
"ownershipAmount": "25.5",
"emailAddress": "[email protected]",
"title": "Manager",
"contactTypes": [
{
"businessContactContactTypeID": 7781268,
"businessContactID": 76578,
"contactTypeID": 3
}
],
"isCompassUser": true,
"isMerchantHomeUser": false,
"isVirtualTerminalUser": true,
"isAuthorizedToPurchase": true
}{
"phoneNumbers": [
{
"phoneTypeCodeID": "1",
"areaCode": "212",
"phoneNumber": "5551234",
"extension": "101"
}
],
"businessContactId": 12345,
"contact": {
"countryOfCitizenshipCode": "840",
"address": {
"line1": "1234 Main St",
"line2": "Apt 101",
"line3": "Suite 200",
"city": "New York",
"countryCode": "1",
"stateCode": "NY",
"zip": "10001"
},
"ssnLastFour": "8786",
"encryptedSSN": "U2FsdGVkX1+...",
"ssn": "123456789",
"contactId": 632852759,
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1985-05-20",
"dateOfBirthString": "20051985"
},
"ownershipAmount": "25.5",
"emailAddress": "[email protected]",
"title": "Manager",
"contactTypes": [
{
"businessContactContactTypeID": 7781268,
"businessContactID": 76578,
"contactTypeID": 3
}
],
"isCompassUser": true,
"isMerchantHomeUser": false,
"isVirtualTerminalUser": true,
"isAuthorizedToPurchase": true
}Delete the business contact for the specified merchant using the provided businessContactId.
Note: The deletion occurs only if the merchant account is not locked and at least one business contact remains. An audit entry is queued for successful deletions; otherwise, the request may be staged for later processing.
The merchant's unique identification number.
The unique identifier for the business contact.
Deletes a business contact successfully.
No content
Accepted: Request change was accepted.
Bad Request: If MerchantNumber is null or it's the only contact of the merchant.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Not Found: If contact is not found.
Conflict: Request change was rejected because there is another one.
Internal Server Error: This could be due to system errors. Please contact support for assistance
DELETE /api/demographics/v1/BusinessContacts/{merchantNumber}/{businessContactId} HTTP/1.1
Host:
Accept: */*
No content
Retrieve all business contacts associated with the merchant.
The merchant's unique identification number.
Specifies whether to return the Social Security Number (SSN) in encrypted format. Default: false.
falseReturns a list of business contacts successfully.
If merchantNumber is null or empty.
If no contacts returned.
Error occurred retrieving data.
GET /api/demographics/v1/BusinessContacts/{merchantNumber} HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"phoneNumbers": [
{
"phoneTypeCodeID": "1",
"areaCode": "212",
"phoneNumber": "5551234",
"extension": "101"
}
],
"businessContactId": 12345,
"contact": {
"countryOfCitizenshipCode": "840",
"address": {
"line1": "1234 Main St",
"line2": "Apt 101",
"line3": "Suite 200",
"city": "New York",
"countryCode": "1",
"stateCode": "NY",
"zip": "10001"
},
"ssnLastFour": "8786",
"encryptedSSN": "U2FsdGVkX1+...",
"ssn": "123456789",
"contactId": 632852759,
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1985-05-20",
"dateOfBirthString": "20051985"
},
"ownershipAmount": "25.5",
"emailAddress": "[email protected]",
"title": "Manager",
"contactTypes": [
{
"businessContactContactTypeID": 7781268,
"businessContactID": 76578,
"contactTypeID": 3
}
],
"isCompassUser": true,
"isMerchantHomeUser": false,
"isVirtualTerminalUser": true,
"isAuthorizedToPurchase": true
}
]
}Create a business contact for the specified merchant.
Note: -The created business contact can be used for further processing within the system.
The merchant's unique identification number.
Specifies whether to return the Social Security Number (SSN) in encrypted format. Default: false.
falseUnique identifier for the business contact.
12345Ownership percentage or amount associated with the contact.
25.5The email address of the business contact.
[email protected]Job title or position of the business contact.
ManagerIndicates whether the contact is a Compass user.
trueIndicates whether the contact is a Merchant Home user.
falseIndicates whether the contact is a Virtual Terminal user.
trueSpecifies if the contact is authorized to make purchases.
trueCreates a business contact successfully.
Accepted: Request change was accepted.
Bad Request: If merchantNumber is null or empty, or data is invalid.
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Not Found: If exception is thrown during creation or merchant contact not found.
Conflict: Request change was rejected because there is another one.
Internal Server Error: This could be due to system errors. Please contact support for assistance.
POST /api/demographics/v1/BusinessContacts/{merchantNumber} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 761
{
"phoneNumbers": [
{
"phoneTypeCodeID": "1",
"areaCode": "212",
"phoneNumber": "5551234",
"extension": "101"
}
],
"businessContactId": 12345,
"contact": {
"countryOfCitizenshipCode": "840",
"address": {
"line1": "1234 Main St",
"line2": "Apt 101",
"line3": "Suite 200",
"city": "New York",
"countryCode": "1",
"stateCode": "NY",
"zip": "10001"
},
"ssnLastFour": "8786",
"encryptedSSN": "U2FsdGVkX1+...",
"ssn": "123456789",
"contactId": 632852759,
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1985-05-20"
},
"ownershipAmount": "25.5",
"emailAddress": "[email protected]",
"title": "Manager",
"contactTypes": [
{
"businessContactContactTypeID": 7781268,
"businessContactID": 76578,
"contactTypeID": 3
}
],
"isCompassUser": true,
"isMerchantHomeUser": false,
"isVirtualTerminalUser": true,
"isAuthorizedToPurchase": true
}{
"phoneNumbers": [
{
"phoneTypeCodeID": "1",
"areaCode": "212",
"phoneNumber": "5551234",
"extension": "101"
}
],
"businessContactId": 12345,
"contact": {
"countryOfCitizenshipCode": "840",
"address": {
"line1": "1234 Main St",
"line2": "Apt 101",
"line3": "Suite 200",
"city": "New York",
"countryCode": "1",
"stateCode": "NY",
"zip": "10001"
},
"ssnLastFour": "8786",
"encryptedSSN": "U2FsdGVkX1+...",
"ssn": "123456789",
"contactId": 632852759,
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1985-05-20",
"dateOfBirthString": "20051985"
},
"ownershipAmount": "25.5",
"emailAddress": "[email protected]",
"title": "Manager",
"contactTypes": [
{
"businessContactContactTypeID": 7781268,
"businessContactID": 76578,
"contactTypeID": 3
}
],
"isCompassUser": true,
"isMerchantHomeUser": false,
"isVirtualTerminalUser": true,
"isAuthorizedToPurchase": true
}Retrieve the Beneficial Owner Disclosure for the specified merchant.
The merchant's unique identification number.
Returns a business contact successfully.
Bad Request: The request made by the user is invalid and cannot be processed (If MerchantNumber is null or Empty).
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Not Found: If resource not found exception is thrown during creation.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/BusinessContacts/{merchantNumber}/beneficialowneragreement HTTP/1.1
Host:
Accept: */*
{
"allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}Create a new Beneficial Owner Disclosure for the specified merchant.
Note: The request requires a valid BeneficialOwnerDisclosure object in the request body.
The merchant's unique identification number.
Indicates whether all persons with more than 25% ownership have been added to the disclosure.
trueBusiness contact created successfully.
Bad Request: The request made by the user is invalid and cannot be processed (If input is null or Empty).
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Not Found: If resource not found exception is thrown during creation.
Internal Server Error: This could be due to system errors. Please contact support for assistance
POST /api/demographics/v1/BusinessContacts/{merchantNumber}/beneficialowneragreement HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 66
{
"allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}{
"allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}Update an existing Beneficial Owner Disclosure for the specified merchant.
Note: Pass the updated BeneficialOwnerDisclosure object in request body.
The merchant's unique identification number.
Indicates whether all persons with more than 25% ownership have been added to the disclosure.
trueUpdates a business contact successfully.
Bad Request: The request made by the user is invalid and cannot be processed (If input is null or Empty).
Unauthorized: User does not have the required role or access.
Forbidden: The user does not have the necessary permissions to access this resource.
Not Found: If resource not found exception is thrown during creation.
Internal Server Error: This could be due to system errors. Please contact support for assistance
PUT /api/demographics/v1/BusinessContacts/{merchantNumber}/beneficialowneragreement HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 66
{
"allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}{
"allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}Was this helpful?