Business Contact
This endpoint is used to retrieve a business contact associated with a specific merchant number and business contact ID. Response includes phoneNumbers, address details, email address, etc. along with other relevent information.
MerchantNumber used to get business contact.
BusinessContactId used to get business contact details.
falseCorrelation Id for the request
Returns 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: localhost:5000
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
}This endpoint is used to update an existing business contact for a merchant. The request must include a valid merchant number and the business contact ID of the record to be updated. The request body should contain the updated business contact details,including any necessary modifications.
MerchantNumber used to update contact.
BusinessContactId used to refer a particular businessContact.
falseCorrelation Id for the request
Unique identifier for the business contact.
12345Ownership percentage or amount associated with the contact.
25.5Job 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: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 753
{
"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
}This endpoint deletes a business contact associated with a given businessContactId from a specific merchant account. The deletion occurs after validating the request and ensuring the merchant is not locked or left without a contact. If changes are permitted, the deletion is processed, and an audit entry is queued. Otherwise, the request may be staged for later processing.
MerchantNumber used to delete its contact.
BusinessContactId used to delete a particular business contact.
Correlation Id for the request
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: localhost:5000
Accept: */*
No content
Merchant number.
falseCorrelation Id for the request
Returns 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: localhost:5000
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
}
]
}This endpoint is used to create a business contact for a particular merchant. The created merchant contact can be used for further processing in the system. The request includes addresses, phone numbers, email address etc, along with other relevent information related to a particular merchant.
MerchantNumber required to create the business Contact for the specified merchant.
falseCorrelation Id for the request
Unique identifier for the business contact.
12345Ownership percentage or amount associated with the contact.
25.5Job 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: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 753
{
"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
}This endpoint retrieves ownership disclosure information associated with a specified merchant number. The request must include a valid merchant number as part of the route parameters.
Merchant number to get ownership Disclosure.
Correlation Id for the request
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: localhost:5000
Accept: */*
{
"allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}This endpoint is used to create a new Beneficial Owner Disclosure for a specified merchant. It requires the merchant number as a route parameter and a valid BeneficialOwnerDisclosure object in the request body.
Merchant number used to create Ownership Disclosure
Correlation Id for the request
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: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 66
{
"allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}{
"allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}This endpoint is used to update an existing Beneficial Owner Disclosure for a specified merchant. The merchant number is provided as a route parameter, and the updated BeneficialOwnerDisclosure object is passed in the request body.
Merchant number used to update Ownership Disclosure
Correlation Id for the request
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: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 66
{
"allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}{
"allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}Was this helpful?