Merchant
Retrieve a list of merchants with optional filter pagination capabilities.
Returns a list of merchants successfully.
Error occurred retrieving data.
GET /api/demographics/v1/Merchants?PageSize=1&PageNumber=1 HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"_links": {
"ANY_ADDITIONAL_PROPERTY": null
},
"hierarchyNodeKey": "text",
"dbaName": "text",
"merchantNumber": "text"
}
],
"page": {
"number": 1,
"size": 1,
"sort": {
"fields": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"totalPages": 1,
"numberOfElements": 1,
"totalElements": 1,
"first": true,
"last": true
}
}Creates a new merchant after validating required fields and additional checks, including: -Required fields: dbaName, hierarchyNodeKey, and userName -Compliance with business rules and configurations such as paper statement preferences -MCC (Merchant Category Code) validation Upon successful validation, the merchant is created and queued for processing.
The unique identifier for the business.
524398752The key representing the hierarchy node to which the business belongs.
7412523The Doing-Business-As (DBA) name of the merchant.
Jane's SandwichesThe merchant's unique identification number.
987654321The website of the business.
https:/www.janessandwiches.comIndicates whether the business accepts paper statements.
trueIndicates whether the business accepts paper tax forms.
falseThe identifier representing the type of the company.
2Indicates whether the business is part of a chain of merchants.
falseCreated a merchant successfully.
Bad Request: Validation failed due to missing or invalid information (e.g., DBA Name, HierarchyNodeKey, or MCC code).
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
POST /api/demographics/v1/Merchants HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 727
{
"businessID": 524398752,
"hierarchyNodeKey": "7412523",
"dbaName": "Jane's Sandwiches",
"merchantNumber": "987654321",
"emailAddress": "[email protected]",
"webSite": "https:/www.janessandwiches.com",
"phones": [
{
"phoneTypeCodeID": "1",
"areaCode": "415",
"phoneNumber": "5551234",
"extension": "101"
}
],
"acceptsPaperStatements": "true",
"acceptsPaperTaxForms": "false",
"companyTypeId": 2,
"isChainMerchant": false,
"seasonalSchedule": {
"january": true,
"february": false,
"march": true,
"april": true,
"may": true,
"june": false,
"july": true,
"august": true,
"september": false,
"october": true,
"november": true,
"december": false
},
"salesInformation": {
"salesInformationID": 1001,
"businessID": 2002,
"assignedUser": 3003,
"referralPartner": "John Doe",
"compensationType": "2"
}
}{
"_links": {
"self": {
"href": "/api/demographics/v1.0/merchants/987654321"
}
},
"businessID": 524398752,
"hierarchyNodeKey": "7412523",
"dbaName": "Jane's Sandwiches",
"merchantNumber": "987654321",
"emailAddress": "[email protected]",
"webSite": "https:/www.janessandwiches.com",
"phones": [
{
"phoneTypeCodeID": "1",
"areaCode": "415",
"phoneNumber": "5551234",
"extension": "101"
}
],
"acceptsPaperStatements": "true",
"acceptsPaperTaxForms": "false",
"companyTypeId": 2,
"isChainMerchant": false,
"seasonalSchedule": {
"january": true,
"february": false,
"march": true,
"april": true,
"may": true,
"june": false,
"july": true,
"august": true,
"september": false,
"october": true,
"november": true,
"december": false
},
"salesInformation": {
"salesInformationID": 1001,
"businessID": 2002,
"assignedUser": 3003,
"referralPartner": "John Doe",
"compensationType": "2"
}
}Retrieve details of a specific merchant using the merchantNumber.
The merchant's unique identification number.
Returns a single merchant successfully.
If merchantNumber is null or white space.
If merchant is not found.
Error occurred returning merchant.
GET /api/demographics/v1/Merchants/{merchantNumber} HTTP/1.1
Host:
Accept: */*
{
"_links": {
"self": {
"href": "/api/demographics/v1.0/merchants/987654321"
}
},
"businessID": 524398752,
"hierarchyNodeKey": "7412523",
"dbaName": "Jane's Sandwiches",
"merchantNumber": "987654321",
"emailAddress": "[email protected]",
"webSite": "https:/www.janessandwiches.com",
"phones": [
{
"phoneTypeCodeID": "1",
"areaCode": "415",
"phoneNumber": "5551234",
"extension": "101"
}
],
"acceptsPaperStatements": "true",
"acceptsPaperTaxForms": "false",
"companyTypeId": 2,
"isChainMerchant": false,
"seasonalSchedule": {
"january": true,
"february": false,
"march": true,
"april": true,
"may": true,
"june": false,
"july": true,
"august": true,
"september": false,
"october": true,
"november": true,
"december": false
},
"salesInformation": {
"salesInformationID": 1001,
"businessID": 2002,
"assignedUser": 3003,
"referralPartner": "John Doe",
"compensationType": "2"
}
}Update the details of an existing merchant identified by the merchant number.
Note: If the merchant is locked, the update is staged instead of applied immediately. After a successful update, a merchant change event is queued.
The merchant's unique identification number.
The unique identifier for the business.
524398752The key representing the hierarchy node to which the business belongs.
7412523The Doing-Business-As (DBA) name of the merchant.
Jane's SandwichesThe merchant's unique identification number.
987654321The website of the business.
https:/www.janessandwiches.comIndicates whether the business accepts paper statements.
trueIndicates whether the business accepts paper tax forms.
falseThe identifier representing the type of the company.
2Indicates whether the business is part of a chain of merchants.
falseUpdates a merchant successfully.
Accepted: Request change was accepted.
Bad Request: If merchant number is null/empty or business object is null or If data is invalid or MCC code not found.
Unauthorized: User does not have the required role or access.
Not Found: Resource not found exception.
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/Merchants/{merchantNumber} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 727
{
"businessID": 524398752,
"hierarchyNodeKey": "7412523",
"dbaName": "Jane's Sandwiches",
"merchantNumber": "987654321",
"emailAddress": "[email protected]",
"webSite": "https:/www.janessandwiches.com",
"phones": [
{
"phoneTypeCodeID": "1",
"areaCode": "415",
"phoneNumber": "5551234",
"extension": "101"
}
],
"acceptsPaperStatements": "true",
"acceptsPaperTaxForms": "false",
"companyTypeId": 2,
"isChainMerchant": false,
"seasonalSchedule": {
"january": true,
"february": false,
"march": true,
"april": true,
"may": true,
"june": false,
"july": true,
"august": true,
"september": false,
"october": true,
"november": true,
"december": false
},
"salesInformation": {
"salesInformationID": 1001,
"businessID": 2002,
"assignedUser": 3003,
"referralPartner": "John Doe",
"compensationType": "2"
}
}{
"_links": {
"self": {
"href": "/api/demographics/v1.0/merchants/987654321"
}
},
"businessID": 524398752,
"hierarchyNodeKey": "7412523",
"dbaName": "Jane's Sandwiches",
"merchantNumber": "987654321",
"emailAddress": "[email protected]",
"webSite": "https:/www.janessandwiches.com",
"phones": [
{
"phoneTypeCodeID": "1",
"areaCode": "415",
"phoneNumber": "5551234",
"extension": "101"
}
],
"acceptsPaperStatements": "true",
"acceptsPaperTaxForms": "false",
"companyTypeId": 2,
"isChainMerchant": false,
"seasonalSchedule": {
"january": true,
"february": false,
"march": true,
"april": true,
"may": true,
"june": false,
"july": true,
"august": true,
"september": false,
"october": true,
"november": true,
"december": false
},
"salesInformation": {
"salesInformationID": 1001,
"businessID": 2002,
"assignedUser": 3003,
"referralPartner": "John Doe",
"compensationType": "2"
}
}Delete an existing merchant record identified by the merchant number.
The operation validates the request through multiple steps:
Verifies the merchant number and checks if the merchant is locked
Rejects the request if the merchant is locked and changes aren't allowed
Stages changes before processing the deletion to ensure compliance with business rules
Updates the merchant's lifecycle status
Queues changes securely
The merchant's unique identification number.
Deletes a merchant successfully.
No content
Accepted: Changes are staged and will be processed asynchronously.
Bad Request: MerchantNumber is null/empty or operation is invalid due to locked status response.
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: Merchant not found.
Internal Server Error: This could be due to system errors. Please contact support for assistance.
DELETE /api/demographics/v1/Merchants/{merchantNumber} HTTP/1.1
Host:
Accept: */*
No content
Retrieve the merchant's primary physical address.
Note: -The accuracy of the provided address is verified through secure access using the "MID" authorisation policy.
The merchant's unique identification number.
Returns a merchant's physical address successfully.
Bad Request: If merchant number is null/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: Business Physical address not found for MerchantNumber provided.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/MerchantPhysicalAddresses/{merchantNumber} HTTP/1.1
Host:
Accept: */*
{
"stateCode": "CA",
"zip": "90001",
"countryCode": 1,
"line1": "123 Main Street",
"line2": "Apt 4B",
"line3": "text",
"city": "Los Angeles"
}Update the physical address for a merchant identified by the merchant number. Address details are provided in the request body.
Note: The accuracy of the provided address is verified through secure access using the "MID" authorisation policy.
The merchant's unique identification number.
Represents the physical address of a business.
The state code where the business is located. The code is a two-letter abbreviation.
CAThe zip code of the business's physical address.
90001The country code representing the country where the business is located.
1The first line of the business's physical address. Possible value: street address.
123 Main StreetThe second line of the business's physical address. Possible values are optional, for apartment, suite.
Apt 4BThe third line of the business's physical address (optional).
The city name where the business is located.
Los AngelesUpdates a merchant's physical address successfully.
Accepted: Request change is accepted.
Bad Request: If merchant number is null/empty or physicalAddress is null or If 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 merchant or its physical address not found.
Conflict: Request change is 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/MerchantPhysicalAddresses/{merchantNumber} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 127
{
"stateCode": "CA",
"zip": "90001",
"countryCode": 1,
"line1": "123 Main Street",
"line2": "Apt 4B",
"line3": "text",
"city": "Los Angeles"
}{
"stateCode": "CA",
"zip": "90001",
"countryCode": 1,
"line1": "123 Main Street",
"line2": "Apt 4B",
"line3": "text",
"city": "Los Angeles"
}Retrieve the merchant's mailing address identified by the merchant number.
Note: The merchant number must be valid and exist in the system for the request to succeed. Access is secured using the "MID" authorisation policy and requires the "getaddress" entitlement.
The merchant's unique identification number.
Returns a merchant's mailing address successfully.
Bad Request: If merchantNumber is null/empty or mailingAddress is null or If 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 merchant or its mailing address not found.
Internal Server Error: This could be due to system errors. Please contact support for assistance.
GET /api/demographics/v1/MerchantMailingAddresses/{merchantNumber} HTTP/1.1
Host:
Accept: */*
{
"stateCode": "CA",
"zip": "90001",
"countryCode": 10,
"line1": "123 Main St",
"line2": "Apt 4B",
"line3": "Building C",
"city": "Los Angeles"
}Update the mailing address for a merchant identified by the merchant number. The mailing address is used for official correspondence and can be the same as or different from the physical address. Address details are provided in the request body.
The merchant's unique identification number.
The state code of the mailing address (2 digits).
CAThe zip code of the mailing address.
90001The country code representing the country of the mailing address. (Any code between 1 and 840)
10The first line of the mailing address.
123 Main StThe second line of the mailing address (optional).
Apt 4BThe third line of the mailing address (optional).
Building CThe city of the mailing address.
Los AngelesUpdates a merchant's mailing address successfully.
Accepted: Request change was accepted.
Bad Request: If merchant number is null/empty or merchant mailing Address cannot be updated.
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 merchant 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/MerchantMailingAddresses/{merchantNumber} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 130
{
"stateCode": "CA",
"zip": "90001",
"countryCode": 10,
"line1": "123 Main St",
"line2": "Apt 4B",
"line3": "Building C",
"city": "Los Angeles"
}{
"stateCode": "CA",
"zip": "90001",
"countryCode": 10,
"line1": "123 Main St",
"line2": "Apt 4B",
"line3": "Building C",
"city": "Los Angeles"
}Was this helpful?