GithubSupport CenterStatus pageBecome a Partner

Business Contact

Retrieves Business Contact

get

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.

Path parameters
merchantNumberstringRequired

MerchantNumber used to get business contact.

businessContactIdinteger · int32Required

BusinessContactId used to get business contact details.

Query parameters
encryptedSsnbooleanOptionalDefault: false
Header parameters
exchangeIdstringOptional

Correlation Id for the request

Responses
200
Returns a single business contact successfully.
application/json
get
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
}

Updates Business Contact.

put

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.

Path parameters
merchantNumberstringRequired

MerchantNumber used to update contact.

businessContactIdinteger · int32Required

BusinessContactId used to refer a particular businessContact.

Query parameters
encryptedSsnbooleanOptionalDefault: false
Header parameters
exchangeIdstringOptional

Correlation Id for the request

Body
businessContactIdinteger · int32Optional

Unique identifier for the business contact.

Example: 12345
ownershipAmountnumber · double | nullableOptional

Ownership percentage or amount associated with the contact.

Example: 25.5
emailAddressstringRequired

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
put
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
}

Deletes a Business Contact.

delete

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.

Path parameters
merchantNumberstringRequired

MerchantNumber used to delete its contact.

businessContactIdinteger · int32Required

BusinessContactId used to delete a particular business contact.

Header parameters
exchangeIdstringOptional

Correlation Id for the request

Responses
200
Deletes a business contact successfully.
delete
DELETE /api/demographics/v1/BusinessContacts/{merchantNumber}/{businessContactId} HTTP/1.1
Host: localhost:5000
Accept: */*

No content

Get Business Contacts

get
Path parameters
merchantNumberstringRequired

Merchant number.

Query parameters
encryptedSsnbooleanOptionalDefault: false
Header parameters
exchangeIdstringOptional

Correlation Id for the request

Responses
200
Returns a list of business contacts successfully.
application/json
get
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
    }
  ]
}

Creates Business Contact

post

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.

Path parameters
merchantNumberstringRequired

MerchantNumber required to create the business Contact for the specified merchant.

Query parameters
encryptedSsnbooleanOptionalDefault: false
Header parameters
exchangeIdstringOptional

Correlation Id for the request

Body
businessContactIdinteger · int32Optional

Unique identifier for the business contact.

Example: 12345
ownershipAmountnumber · double | nullableOptional

Ownership percentage or amount associated with the contact.

Example: 25.5
emailAddressstringRequired

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
post
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
}

Retrieves Ownership Disclosure

get

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.

Path parameters
merchantNumberstringRequired

Merchant number to get ownership Disclosure.

Header parameters
exchangeIdstringOptional

Correlation Id for the request

Responses
200
Returns a business contact successfully.
application/json
get
GET /api/demographics/v1/BusinessContacts/{merchantNumber}/beneficialowneragreement HTTP/1.1
Host: localhost:5000
Accept: */*

{
  "allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded": true
}

Creates Ownership Disclosure

post

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.

Path parameters
merchantNumberstringRequired

Merchant number used to create Ownership Disclosure

Header parameters
exchangeIdstringOptional

Correlation Id for the request

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
post
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
}

Updates Ownership Disclosure

put

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.

Path parameters
merchantNumberstringRequired

Merchant number used to update Ownership Disclosure

Header parameters
exchangeIdstringOptional

Correlation Id for the request

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
put
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
}
PreviousBank AccountNextDocuments

Was this helpful?