Business Contact

Get Specific Business Contact

get

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

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

businessContactIdinteger · int32Required

The unique identifier for the business contact.

Query parameters

encryptedSsnbooleanOptional

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

Default: false

Responses

200

Returns a single business contact successfully.

application/json

400

Bad Request: If merchant number is null or empty.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

404

Not Found: BusinessContacts not found.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance.

application/json

get

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

GET /api/demographics/v1/BusinessContacts/{merchantNumber}/{businessContactId} HTTP/1.1
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 Business Contact

put

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.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

businessContactIdinteger · int32Required

The unique identifier for the business contact.

Query parameters

encryptedSsnbooleanOptional

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

Default: false

Body

businessContactIdinteger · int32Optional

Unique identifier for the business contact.

Example: 12345

ownershipAmountstring · nullableOptional

Ownership percentage or amount associated with the contact.

Example: 25.5

emailAddressstring · min: 1Required

The email address of the business contact.

Example: [email protected]

titlestring · nullableOptional

Job title or position of the business contact.

Example: Manager

isCompassUserbooleanOptional

Indicates whether the contact is a Compass user.

Example: true

isMerchantHomeUserbooleanOptional

Indicates whether the contact is a Merchant Home user.

Example: false

isVirtualTerminalUserbooleanOptional

Indicates whether the contact is a Virtual Terminal user.

Example: true

isAuthorizedToPurchasebooleanOptional

Specifies if the contact is authorized to make purchases.

Example: true

Responses

200

Updates a business contact successfully.

application/json

202

Accepted: Request change was accepted.

application/json

400

Bad Request: If merchantNumber is null or empty, or data is invalid.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

404

Not Found: If contact is not found.

application/json

409

Conflict: Request change was rejected because there is another one.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

put

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

PUT /api/demographics/v1/BusinessContacts/{merchantNumber}/{businessContactId} HTTP/1.1
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 Business Contact

delete

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.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

businessContactIdinteger · int32Required

The unique identifier for the business contact.

Responses

200

Deletes a business contact successfully.

No content

202

Accepted: Request change was accepted.

application/json

400

Bad Request: If MerchantNumber is null or it's the only contact of the merchant.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

404

Not Found: If contact is not found.

application/json

409

Conflict: Request change was rejected because there is another one.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

delete

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

DELETE /api/demographics/v1/BusinessContacts/{merchantNumber}/{businessContactId} HTTP/1.1
Accept: */*

No content

Get Business Contacts

get

Retrieve all business contacts associated with the merchant.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

encryptedSsnbooleanOptional

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

Default: false

Responses

200

Returns a list of business contacts successfully.

application/json

400

If merchantNumber is null or empty.

application/json

404

If no contacts returned.

application/json

500

Error occurred retrieving data.

application/json

get

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

GET /api/demographics/v1/BusinessContacts/{merchantNumber} HTTP/1.1
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 Business Contact

post

Create a business contact for the specified merchant.

Note: The created business contact can be used for further processing within the system.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

encryptedSsnbooleanOptional

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

Default: false

Body

businessContactIdinteger · int32Optional

Unique identifier for the business contact.

Example: 12345

ownershipAmountstring · nullableOptional

Ownership percentage or amount associated with the contact.

Example: 25.5

emailAddressstring · min: 1Required

The email address of the business contact.

Example: [email protected]

titlestring · nullableOptional

Job title or position of the business contact.

Example: Manager

isCompassUserbooleanOptional

Indicates whether the contact is a Compass user.

Example: true

isMerchantHomeUserbooleanOptional

Indicates whether the contact is a Merchant Home user.

Example: false

isVirtualTerminalUserbooleanOptional

Indicates whether the contact is a Virtual Terminal user.

Example: true

isAuthorizedToPurchasebooleanOptional

Specifies if the contact is authorized to make purchases.

Example: true

Responses

201

Creates a business contact successfully.

application/json

202

Accepted: Request change was accepted.

application/json

400

Bad Request: If merchantNumber is null or empty, or data is invalid.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

404

Not Found: If exception is thrown during creation or merchant contact not found.

application/json

409

Conflict: Request change was rejected because there is another one.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance.

application/json

post

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

POST /api/demographics/v1/BusinessContacts/{merchantNumber} HTTP/1.1
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
}

Get Ownership Disclosure

get

Retrieve the Beneficial Owner Disclosure for the specified merchant.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Responses

200

Returns a business contact successfully.

application/json

400

Bad Request: The request made by the user is invalid and cannot be processed (If MerchantNumber is null or Empty).

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

404

Not Found: If resource not found exception is thrown during creation.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

get

/api/demographics/v1/BusinessContacts/{merchantNumber}/beneficialowneragreement

GET /api/demographics/v1/BusinessContacts/{merchantNumber}/beneficialowneragreement HTTP/1.1
Accept: */*

{
  "allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}

Create Ownership Disclosure

post

Create a new Beneficial Owner Disclosure for the specified merchant.

Note: The request requires a valid BeneficialOwnerDisclosure object in the request body.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Body

allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAddedbooleanOptional

Indicates whether all persons with more than 25% ownership have been added to the disclosure.

Example: true

Responses

200

Business contact created successfully.

application/json

400

Bad Request: The request made by the user is invalid and cannot be processed (If input is null or Empty).

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

404

Not Found: If resource not found exception is thrown during creation.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

post

/api/demographics/v1/BusinessContacts/{merchantNumber}/beneficialowneragreement

POST /api/demographics/v1/BusinessContacts/{merchantNumber}/beneficialowneragreement HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}

{
  "allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}

Update Ownership Disclosure

put

Update an existing Beneficial Owner Disclosure for the specified merchant.

Note: Pass the updated BeneficialOwnerDisclosure object in request body.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Body

allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAddedbooleanOptional

Indicates whether all persons with more than 25% ownership have been added to the disclosure.

Example: true

Responses

200

Updates a business contact successfully.

application/json

400

Bad Request: The request made by the user is invalid and cannot be processed (If input is null or Empty).

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

404

Not Found: If resource not found exception is thrown during creation.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

put

/api/demographics/v1/BusinessContacts/{merchantNumber}/beneficialowneragreement

PUT /api/demographics/v1/BusinessContacts/{merchantNumber}/beneficialowneragreement HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}

{
  "allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}

PreviousBank Account NextDocuments

Last updated 29 days ago

Was this helpful?

hashtagGet Specific Business Contact

hashtagUpdate Business Contact

hashtagDelete Business Contact

hashtagGet Business Contacts

hashtagCreate Business Contact

hashtagGet Ownership Disclosure

hashtagCreate Ownership Disclosure

hashtagUpdate Ownership Disclosure

Get Specific Business Contact

Update Business Contact

Delete Business Contact

Get Business Contacts

Create Business Contact

Get Ownership Disclosure

Create Ownership Disclosure

Update Ownership Disclosure