# Models ## The MerchantDemographics.Api.Controllers.Mapping object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Controllers.Mapping":{"type":"object","properties":{"businessContactId":{"type":"integer","format":"int32"},"documentType":{"type":"string","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Controllers.SignedApp object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Controllers.SignedApp":{"type":"object","properties":{"mapping":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Controllers.Mapping"},"nullable":true},"file":{"type":"string","format":"byte","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Controllers.Mapping":{"type":"object","properties":{"businessContactId":{"type":"integer","format":"int32"},"documentType":{"type":"string","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Controllers.SignedAppBase64 object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Controllers.SignedAppBase64":{"type":"object","properties":{"mapping":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Controllers.Mapping"},"nullable":true},"file":{"type":"string","description":"The signed application document as a Base64-encoded string (Optional).","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Controllers.Mapping":{"type":"object","properties":{"businessContactId":{"type":"integer","format":"int32"},"documentType":{"type":"string","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.BankAccount object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BankAccount":{"required":["aba","accountNumber","bankAccountNameTypeID","bankAccountTypeID","bankName","hasChargebacks","hasFees","hasFunds"],"type":"object","properties":{"bankAccountID":{"type":"string","description":"Unique identifier for the bank account.","nullable":true},"bankName":{"minLength":1,"type":"string","description":"Name of the bank associated with the account."},"nameOnAccount":{"type":"string","description":"The name on the bank account.","nullable":true},"accountHolderFirstName":{"type":"string","description":"The first name of the account holder.","nullable":true},"accountHolderLastName":{"type":"string","description":"The last name of the account holder.","nullable":true},"bankAccountTypeID":{"maximum":3,"minimum":1,"type":"string","description":"Type of bank account. Possible values:\r\n1 - Checking\r\n2 - Savings"},"bankAccountNameTypeID":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Name type ID for the bank account.","format":"int32"},"aba":{"minLength":1,"type":"string","description":"The routing number associated with the bank account. In different regions, this may represent BIC (EU) or Sort Code (UK). \r\nMandatory for US and UK; optional for EU."},"accountNumber":{"minLength":1,"type":"string","description":"The account number associated with the bank account."},"lastFourAccountNumber":{"type":"string","description":"The last four digits of the bank account number.","nullable":true},"encryptedAccountNumber":{"type":"string","description":"Encrypted version of the bank account number.","format":"byte","nullable":true},"voidedCheckDocumentID":{"type":"string","description":"Document ID for the voided check linked to the bank account.","format":"uuid"},"hasFees":{"type":"boolean","description":"Indicates if the account has fees associated with it."},"hasFunds":{"type":"boolean","description":"Indicates if the account has available funds."},"hasChargebacks":{"type":"boolean","description":"Indicates if the account has a history of chargebacks."},"isNameSameAsLegalOrDBAName":{"type":"string","description":"Indicates if the account name is the same as the legal or DBA name.","nullable":true},"currency":{"type":"string","description":"The account currency in ISO 4217 code","nullable":true},"purpose":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.Enums.BankAccountPurpose"},"lastUpdatedUtc":{"type":"string","description":"UTC date and time when the account was last updated.","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.Enums.BankAccountPurpose":{"enum":["Settlement","Invoicing","Direct"],"type":"string"}}}} ``` ## The MerchantDemographics.Api.Models.BankAccountCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BankAccountCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.BankAccount"},"description":"A list of bank account details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.BankAccount":{"required":["aba","accountNumber","bankAccountNameTypeID","bankAccountTypeID","bankName","hasChargebacks","hasFees","hasFunds"],"type":"object","properties":{"bankAccountID":{"type":"string","description":"Unique identifier for the bank account.","nullable":true},"bankName":{"minLength":1,"type":"string","description":"Name of the bank associated with the account."},"nameOnAccount":{"type":"string","description":"The name on the bank account.","nullable":true},"accountHolderFirstName":{"type":"string","description":"The first name of the account holder.","nullable":true},"accountHolderLastName":{"type":"string","description":"The last name of the account holder.","nullable":true},"bankAccountTypeID":{"maximum":3,"minimum":1,"type":"string","description":"Type of bank account. Possible values:\r\n1 - Checking\r\n2 - Savings"},"bankAccountNameTypeID":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Name type ID for the bank account.","format":"int32"},"aba":{"minLength":1,"type":"string","description":"The routing number associated with the bank account. In different regions, this may represent BIC (EU) or Sort Code (UK). \r\nMandatory for US and UK; optional for EU."},"accountNumber":{"minLength":1,"type":"string","description":"The account number associated with the bank account."},"lastFourAccountNumber":{"type":"string","description":"The last four digits of the bank account number.","nullable":true},"encryptedAccountNumber":{"type":"string","description":"Encrypted version of the bank account number.","format":"byte","nullable":true},"voidedCheckDocumentID":{"type":"string","description":"Document ID for the voided check linked to the bank account.","format":"uuid"},"hasFees":{"type":"boolean","description":"Indicates if the account has fees associated with it."},"hasFunds":{"type":"boolean","description":"Indicates if the account has available funds."},"hasChargebacks":{"type":"boolean","description":"Indicates if the account has a history of chargebacks."},"isNameSameAsLegalOrDBAName":{"type":"string","description":"Indicates if the account name is the same as the legal or DBA name.","nullable":true},"currency":{"type":"string","description":"The account currency in ISO 4217 code","nullable":true},"purpose":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.Enums.BankAccountPurpose"},"lastUpdatedUtc":{"type":"string","description":"UTC date and time when the account was last updated.","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.Enums.BankAccountPurpose":{"enum":["Settlement","Invoicing","Direct"],"type":"string"}}}} ``` ## The MerchantDemographics.Api.Models.BeneficialOwnerDisclosure object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BeneficialOwnerDisclosure":{"type":"object","properties":{"allPersonsWithOverTwentyFivePercentOwnershipHaveBeenAdded":{"type":"boolean","description":"Indicates whether all persons with more than 25% ownership have been added to the disclosure."}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.BoardingError object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BoardingError":{"type":"object","properties":{"errorMessage":{"type":"string","description":"Describes the error and provide detailed information on what went wrong during the request processing.","nullable":true},"resultCode":{"type":"integer","description":"Code associated with the error and helps to categorize the error type or severity. (It can be any error code 400/401/501, etc depending upon its type)","format":"int32"},"timeStamp":{"type":"string","description":"DateTime in ISO 8601 format. It is read-only and automatically set to the current date and time.","format":"date-time","readOnly":true},"fieldPath":{"type":"array","items":{"type":"string"},"description":"Field path(s) where the error occurred in a data structure. It can contains any field.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.Business object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.Business":{"required":["companyTypeId","dbaName","hierarchyNodeKey","phones","seasonalSchedule"],"type":"object","properties":{"businessID":{"type":"integer","description":"The unique identifier for the business.","format":"int32"},"hierarchyNodeKey":{"minLength":1,"type":"string","description":"The key representing the hierarchy node to which the business belongs."},"dbaName":{"minLength":1,"type":"string","description":"The Doing-Business-As (DBA) name of the merchant."},"merchantNumber":{"type":"string","description":"The merchant's unique identification number.","nullable":true},"emailAddress":{"type":"string","description":"The email address of the business.","nullable":true},"webSite":{"type":"string","description":"The website of the business.","nullable":true},"phones":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.BusinessPhone"},"description":"A list of phone numbers associated with the business."},"acceptsPaperStatements":{"type":"string","description":"Indicates whether the business accepts paper statements.","nullable":true},"acceptsPaperTaxForms":{"type":"string","description":"Indicates whether the business accepts paper tax forms.","nullable":true},"companyTypeId":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The identifier representing the type of the company.","format":"int32"},"isChainMerchant":{"type":"boolean","description":"Indicates whether the business is part of a chain of merchants."},"seasonalSchedule":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.SeasonalSchedule"},"salesInformation":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.SalesInformation"}},"additionalProperties":false},"MerchantDemographics.Api.Models.BusinessPhone":{"required":["areaCode","phoneNumber","phoneTypeCodeID"],"type":"object","properties":{"phoneTypeCodeID":{"type":"string","description":"The code representing the type of contact, such as mobile, office, or home."},"areaCode":{"maxLength":3,"minLength":3,"type":"string","description":"The three-digit area code for the phone number."},"phoneNumber":{"maxLength":8,"minLength":7,"type":"string","description":"The main phone number excluding the area code.","format":"tel"},"extension":{"type":"string","description":"The phone extension, if applicable.","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.SeasonalSchedule":{"required":["april","august","december","february","january","july","june","march","may","november","october","september"],"type":"object","properties":{"january":{"type":"boolean","description":"Indicates whether the business operates in January."},"february":{"type":"boolean","description":"Indicates whether the business operates in February."},"march":{"type":"boolean","description":"Indicates whether the business operates in March."},"april":{"type":"boolean","description":"Indicates whether the business operates in April."},"may":{"type":"boolean","description":"Indicates whether the business operates in May."},"june":{"type":"boolean","description":"Indicates whether the business operates in June."},"july":{"type":"boolean","description":"Indicates whether the business operates in July."},"august":{"type":"boolean","description":"Indicates whether the business operates in August."},"september":{"type":"boolean","description":"Indicates whether the business operates in September."},"october":{"type":"boolean","description":"Indicates whether the business operates in October."},"november":{"type":"boolean","description":"Indicates whether the business operates in November."},"december":{"type":"boolean","description":"Indicates whether the business operates in December."}},"additionalProperties":false,"description":"Indicates whether the merchant operates seasonally and specifies the months they are active."},"MerchantDemographics.Api.Models.SalesInformation":{"required":["businessID"],"type":"object","properties":{"salesInformationID":{"type":"integer","description":"The unique identifier for the sales information (excluded from Swagger documentation).","format":"int32"},"businessID":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The unique identifier for the associated business.","format":"int32"},"assignedUser":{"type":"integer","description":"The user ID of the person assigned to the sales record.","format":"int32"},"referralPartner":{"type":"string","description":"The name of the referral partner, if applicable.","nullable":true},"compensationType":{"type":"string","description":"The type of compensation associated with the sales, represented as an integer.","nullable":true}},"additionalProperties":false,"description":"Represents sales-related information for a business. This class is marked as obsolete and is used only for backward compatibility."}}}} ``` ## The MerchantDemographics.Api.Models.BusinessContact object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BusinessContact":{"required":["contact","contactTypes","emailAddress","phoneNumbers"],"type":"object","properties":{"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.BusinessContactPhone"},"description":"A collection of phone numbers."},"businessContactId":{"type":"integer","description":"Unique identifier for the business contact.","format":"int32"},"contact":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.Contact"},"ownershipAmount":{"type":"string","description":"Ownership percentage or amount associated with the contact.","nullable":true},"emailAddress":{"minLength":1,"type":"string","description":"The email address of the business contact."},"title":{"type":"string","description":"Job title or position of the business contact.","nullable":true},"contactTypes":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.BusinessContactContactType"},"description":"List of contact types associated with the business contact."},"isCompassUser":{"type":"boolean","description":"Indicates whether the contact is a Compass user."},"isMerchantHomeUser":{"type":"boolean","description":"Indicates whether the contact is a Merchant Home user."},"isVirtualTerminalUser":{"type":"boolean","description":"Indicates whether the contact is a Virtual Terminal user."},"isAuthorizedToPurchase":{"type":"boolean","description":"Specifies if the contact is authorized to make purchases."}},"additionalProperties":false},"MerchantDemographics.Api.Models.BusinessContactPhone":{"required":["areaCode","phoneNumber","phoneTypeCodeID"],"type":"object","properties":{"phoneTypeCodeID":{"type":"string","description":"Specifies the particular contact type."},"areaCode":{"maxLength":3,"minLength":3,"type":"string","description":"The area code of the phone number, typically 3 digits."},"phoneNumber":{"maxLength":8,"minLength":7,"type":"string","description":"The phone number without the area code. Should be between 7 and 8 digits in length.","format":"tel"},"extension":{"type":"string","description":"The phone number extension (optional).","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.Contact":{"required":["countryOfCitizenshipCode","firstName","lastName"],"type":"object","properties":{"countryOfCitizenshipCode":{"maximum":840,"minimum":1,"type":"string","description":"The country code for the citizenship of the contact. Must be a valid ISO code between 1 and 840."},"address":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.ContactAddress"},"ssnLastFour":{"type":"string","description":"The last four digits of the contact's SSN (Social Security Number). Excluded from Swagger documentation.","nullable":true},"encryptedSSN":{"type":"string","description":"The encrypted Social Security Number (SSN) of the contact.","format":"byte","nullable":true},"ssn":{"maxLength":9,"minLength":9,"type":"string","description":"The full legal ID, such as SSN, of the contact. Strips dashes automatically.","nullable":true},"contactId":{"type":"integer","description":"The unique identifier for the contact. Excluded from Swagger documentation.","format":"int32"},"firstName":{"minLength":1,"type":"string","description":"The first name of the contact."},"lastName":{"minLength":1,"type":"string","description":"The last name of the contact."},"dateOfBirth":{"type":"string","description":"The date of birth of the contact.","nullable":true},"dateOfBirthString":{"type":"string","description":"The date of birth in \"MMddyyyy\" format","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Contains all details of the business contact."},"MerchantDemographics.Api.Models.ContactAddress":{"required":["city","countryCode","line1","stateCode","zip"],"type":"object","properties":{"line1":{"minLength":1,"type":"string","description":"The first line of the address (Example, street address, P.O. box)."},"line2":{"type":"string","description":"The second line of the address (optional).","nullable":true},"line3":{"type":"string","description":"The third line of the address (optional).","nullable":true},"city":{"minLength":1,"type":"string","description":"The city or locality of the address."},"countryCode":{"maximum":840,"minimum":1,"type":"string","description":"The country code for the address. Typically a numeric code for the country."},"stateCode":{"maxLength":10,"minLength":2,"type":"string","description":"The state or region code. Typically a 2-letter code representing the state."},"zip":{"minLength":1,"type":"string","description":"The postal code (zip code) of the address."}},"additionalProperties":false,"description":"Address details of the contact."},"MerchantDemographics.Api.Models.BusinessContactContactType":{"type":"object","properties":{"businessContactContactTypeID":{"type":"integer","description":"The unique identifier for the BusinessContactContactType entity.","format":"int32"},"businessContactID":{"type":"integer","description":"The unique identifier for the associated business contact.","format":"int32"},"contactTypeID":{"type":"integer","description":"The unique identifier for the contact type associated with the business contact.","format":"int32"}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.BusinessContactCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BusinessContactCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.BusinessContact"},"nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.BusinessContact":{"required":["contact","contactTypes","emailAddress","phoneNumbers"],"type":"object","properties":{"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.BusinessContactPhone"},"description":"A collection of phone numbers."},"businessContactId":{"type":"integer","description":"Unique identifier for the business contact.","format":"int32"},"contact":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.Contact"},"ownershipAmount":{"type":"string","description":"Ownership percentage or amount associated with the contact.","nullable":true},"emailAddress":{"minLength":1,"type":"string","description":"The email address of the business contact."},"title":{"type":"string","description":"Job title or position of the business contact.","nullable":true},"contactTypes":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.BusinessContactContactType"},"description":"List of contact types associated with the business contact."},"isCompassUser":{"type":"boolean","description":"Indicates whether the contact is a Compass user."},"isMerchantHomeUser":{"type":"boolean","description":"Indicates whether the contact is a Merchant Home user."},"isVirtualTerminalUser":{"type":"boolean","description":"Indicates whether the contact is a Virtual Terminal user."},"isAuthorizedToPurchase":{"type":"boolean","description":"Specifies if the contact is authorized to make purchases."}},"additionalProperties":false},"MerchantDemographics.Api.Models.BusinessContactPhone":{"required":["areaCode","phoneNumber","phoneTypeCodeID"],"type":"object","properties":{"phoneTypeCodeID":{"type":"string","description":"Specifies the particular contact type."},"areaCode":{"maxLength":3,"minLength":3,"type":"string","description":"The area code of the phone number, typically 3 digits."},"phoneNumber":{"maxLength":8,"minLength":7,"type":"string","description":"The phone number without the area code. Should be between 7 and 8 digits in length.","format":"tel"},"extension":{"type":"string","description":"The phone number extension (optional).","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.Contact":{"required":["countryOfCitizenshipCode","firstName","lastName"],"type":"object","properties":{"countryOfCitizenshipCode":{"maximum":840,"minimum":1,"type":"string","description":"The country code for the citizenship of the contact. Must be a valid ISO code between 1 and 840."},"address":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.ContactAddress"},"ssnLastFour":{"type":"string","description":"The last four digits of the contact's SSN (Social Security Number). Excluded from Swagger documentation.","nullable":true},"encryptedSSN":{"type":"string","description":"The encrypted Social Security Number (SSN) of the contact.","format":"byte","nullable":true},"ssn":{"maxLength":9,"minLength":9,"type":"string","description":"The full legal ID, such as SSN, of the contact. Strips dashes automatically.","nullable":true},"contactId":{"type":"integer","description":"The unique identifier for the contact. Excluded from Swagger documentation.","format":"int32"},"firstName":{"minLength":1,"type":"string","description":"The first name of the contact."},"lastName":{"minLength":1,"type":"string","description":"The last name of the contact."},"dateOfBirth":{"type":"string","description":"The date of birth of the contact.","nullable":true},"dateOfBirthString":{"type":"string","description":"The date of birth in \"MMddyyyy\" format","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Contains all details of the business contact."},"MerchantDemographics.Api.Models.ContactAddress":{"required":["city","countryCode","line1","stateCode","zip"],"type":"object","properties":{"line1":{"minLength":1,"type":"string","description":"The first line of the address (Example, street address, P.O. box)."},"line2":{"type":"string","description":"The second line of the address (optional).","nullable":true},"line3":{"type":"string","description":"The third line of the address (optional).","nullable":true},"city":{"minLength":1,"type":"string","description":"The city or locality of the address."},"countryCode":{"maximum":840,"minimum":1,"type":"string","description":"The country code for the address. Typically a numeric code for the country."},"stateCode":{"maxLength":10,"minLength":2,"type":"string","description":"The state or region code. Typically a 2-letter code representing the state."},"zip":{"minLength":1,"type":"string","description":"The postal code (zip code) of the address."}},"additionalProperties":false,"description":"Address details of the contact."},"MerchantDemographics.Api.Models.BusinessContactContactType":{"type":"object","properties":{"businessContactContactTypeID":{"type":"integer","description":"The unique identifier for the BusinessContactContactType entity.","format":"int32"},"businessContactID":{"type":"integer","description":"The unique identifier for the associated business contact.","format":"int32"},"contactTypeID":{"type":"integer","description":"The unique identifier for the contact type associated with the business contact.","format":"int32"}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.BusinessContactContactType object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BusinessContactContactType":{"type":"object","properties":{"businessContactContactTypeID":{"type":"integer","description":"The unique identifier for the BusinessContactContactType entity.","format":"int32"},"businessContactID":{"type":"integer","description":"The unique identifier for the associated business contact.","format":"int32"},"contactTypeID":{"type":"integer","description":"The unique identifier for the contact type associated with the business contact.","format":"int32"}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.BusinessContactPhone object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BusinessContactPhone":{"required":["areaCode","phoneNumber","phoneTypeCodeID"],"type":"object","properties":{"phoneTypeCodeID":{"type":"string","description":"Specifies the particular contact type."},"areaCode":{"maxLength":3,"minLength":3,"type":"string","description":"The area code of the phone number, typically 3 digits."},"phoneNumber":{"maxLength":8,"minLength":7,"type":"string","description":"The phone number without the area code. Should be between 7 and 8 digits in length.","format":"tel"},"extension":{"type":"string","description":"The phone number extension (optional).","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.BusinessListItemWithLinks object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BusinessListItemWithLinks":{"type":"object","properties":{"_links":{"type":"object","additionalProperties":{"nullable":true},"description":"Reference link to fetch merchant’s detailed information.","nullable":true,"readOnly":true},"hierarchyNodeKey":{"type":"string","description":"Identifier for the merchant’s hierarchy node.","nullable":true},"dbaName":{"type":"string","description":"Doing-Business-As (DBA) name of the merchant.","nullable":true},"merchantNumber":{"type":"string","description":"Unique merchant identifier.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.BusinessListItemWithLinksCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BusinessListItemWithLinksCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.BusinessListItemWithLinks"},"description":"Contains the list of merchant records and pagination details.","nullable":true},"page":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.Pagination"}},"additionalProperties":false},"MerchantDemographics.Api.Models.BusinessListItemWithLinks":{"type":"object","properties":{"_links":{"type":"object","additionalProperties":{"nullable":true},"description":"Reference link to fetch merchant’s detailed information.","nullable":true,"readOnly":true},"hierarchyNodeKey":{"type":"string","description":"Identifier for the merchant’s hierarchy node.","nullable":true},"dbaName":{"type":"string","description":"Doing-Business-As (DBA) name of the merchant.","nullable":true},"merchantNumber":{"type":"string","description":"Unique merchant identifier.","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.Pagination":{"type":"object","properties":{"number":{"type":"integer","description":"Current page number in the result.","format":"int32"},"size":{"type":"integer","description":"The number of records returned per page.","format":"int32"},"sort":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.PageSort"},"totalPages":{"type":"integer","description":"Total number of available pages.","format":"int32"},"numberOfElements":{"type":"integer","description":"Number of elements in the current page.","format":"int32"},"totalElements":{"type":"integer","description":"Total number of merchants available.","format":"int32"},"first":{"type":"boolean","description":"Indicates if this is the first page."},"last":{"type":"boolean","description":"Indicates if this is the last page."}},"additionalProperties":false,"description":"Paging information for merchant records."},"MerchantDemographics.Api.Models.PageSort":{"type":"object","properties":{"fields":{"type":"object","additionalProperties":{"type":"string","nullable":true},"description":"Sorting criteria applied to the results.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.BusinessMailingAddress object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BusinessMailingAddress":{"required":["city","countryCode","line1","stateCode","zip"],"type":"object","properties":{"stateCode":{"maxLength":10,"minLength":2,"type":"string","description":"The state code of the mailing address (2 digits)."},"zip":{"minLength":1,"type":"string","description":"The zip code of the mailing address."},"countryCode":{"maximum":840,"minimum":1,"type":"integer","description":"The country code representing the country of the mailing address. (Any code between 1 and 840)","format":"int32"},"line1":{"minLength":1,"type":"string","description":"The first line of the mailing address."},"line2":{"type":"string","description":"The second line of the mailing address (optional).","nullable":true},"line3":{"type":"string","description":"The third line of the mailing address (optional).","nullable":true},"city":{"minLength":1,"type":"string","description":"The city of the mailing address."}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.BusinessPhone object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BusinessPhone":{"required":["areaCode","phoneNumber","phoneTypeCodeID"],"type":"object","properties":{"phoneTypeCodeID":{"type":"string","description":"The code representing the type of contact, such as mobile, office, or home."},"areaCode":{"maxLength":3,"minLength":3,"type":"string","description":"The three-digit area code for the phone number."},"phoneNumber":{"maxLength":8,"minLength":7,"type":"string","description":"The main phone number excluding the area code.","format":"tel"},"extension":{"type":"string","description":"The phone extension, if applicable.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.BusinessPhysicalAddress object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BusinessPhysicalAddress":{"required":["city","countryCode","line1","stateCode","zip"],"type":"object","properties":{"stateCode":{"maxLength":10,"minLength":2,"type":"string","description":"The state code where the business is located. The code is a two-letter abbreviation."},"zip":{"minLength":1,"type":"string","description":"The zip code of the business's physical address."},"countryCode":{"maximum":840,"minimum":1,"type":"integer","description":"The country code representing the country where the business is located.","format":"int32"},"line1":{"minLength":1,"type":"string","description":"The first line of the business's physical address. Possible value: street address."},"line2":{"type":"string","description":"The second line of the business's physical address. Possible values are optional, for apartment, suite.","nullable":true},"line3":{"type":"string","description":"The third line of the business's physical address (optional).","nullable":true},"city":{"minLength":1,"type":"string","description":"The city name where the business is located."}},"additionalProperties":false,"description":"Represents the physical address of a business."}}}} ``` ## The MerchantDemographics.Api.Models.BusinessWithLinks object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.BusinessWithLinks":{"required":["companyTypeId","dbaName","hierarchyNodeKey","phones","seasonalSchedule"],"type":"object","properties":{"_links":{"type":"object","additionalProperties":{"nullable":true},"description":"Represents a business entity with a collection of hypermedia links to related resources.","nullable":true,"readOnly":true},"businessID":{"type":"integer","description":"The unique identifier for the business.","format":"int32"},"hierarchyNodeKey":{"minLength":1,"type":"string","description":"The key representing the hierarchy node to which the business belongs."},"dbaName":{"minLength":1,"type":"string","description":"The Doing-Business-As (DBA) name of the merchant."},"merchantNumber":{"type":"string","description":"The merchant's unique identification number.","nullable":true},"emailAddress":{"type":"string","description":"The email address of the business.","nullable":true},"webSite":{"type":"string","description":"The website of the business.","nullable":true},"phones":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.BusinessPhone"},"description":"A list of phone numbers associated with the business."},"acceptsPaperStatements":{"type":"string","description":"Indicates whether the business accepts paper statements.","nullable":true},"acceptsPaperTaxForms":{"type":"string","description":"Indicates whether the business accepts paper tax forms.","nullable":true},"companyTypeId":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The identifier representing the type of the company.","format":"int32"},"isChainMerchant":{"type":"boolean","description":"Indicates whether the business is part of a chain of merchants."},"seasonalSchedule":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.SeasonalSchedule"},"salesInformation":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.SalesInformation"}},"additionalProperties":false},"MerchantDemographics.Api.Models.BusinessPhone":{"required":["areaCode","phoneNumber","phoneTypeCodeID"],"type":"object","properties":{"phoneTypeCodeID":{"type":"string","description":"The code representing the type of contact, such as mobile, office, or home."},"areaCode":{"maxLength":3,"minLength":3,"type":"string","description":"The three-digit area code for the phone number."},"phoneNumber":{"maxLength":8,"minLength":7,"type":"string","description":"The main phone number excluding the area code.","format":"tel"},"extension":{"type":"string","description":"The phone extension, if applicable.","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.SeasonalSchedule":{"required":["april","august","december","february","january","july","june","march","may","november","october","september"],"type":"object","properties":{"january":{"type":"boolean","description":"Indicates whether the business operates in January."},"february":{"type":"boolean","description":"Indicates whether the business operates in February."},"march":{"type":"boolean","description":"Indicates whether the business operates in March."},"april":{"type":"boolean","description":"Indicates whether the business operates in April."},"may":{"type":"boolean","description":"Indicates whether the business operates in May."},"june":{"type":"boolean","description":"Indicates whether the business operates in June."},"july":{"type":"boolean","description":"Indicates whether the business operates in July."},"august":{"type":"boolean","description":"Indicates whether the business operates in August."},"september":{"type":"boolean","description":"Indicates whether the business operates in September."},"october":{"type":"boolean","description":"Indicates whether the business operates in October."},"november":{"type":"boolean","description":"Indicates whether the business operates in November."},"december":{"type":"boolean","description":"Indicates whether the business operates in December."}},"additionalProperties":false,"description":"Indicates whether the merchant operates seasonally and specifies the months they are active."},"MerchantDemographics.Api.Models.SalesInformation":{"required":["businessID"],"type":"object","properties":{"salesInformationID":{"type":"integer","description":"The unique identifier for the sales information (excluded from Swagger documentation).","format":"int32"},"businessID":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The unique identifier for the associated business.","format":"int32"},"assignedUser":{"type":"integer","description":"The user ID of the person assigned to the sales record.","format":"int32"},"referralPartner":{"type":"string","description":"The name of the referral partner, if applicable.","nullable":true},"compensationType":{"type":"string","description":"The type of compensation associated with the sales, represented as an integer.","nullable":true}},"additionalProperties":false,"description":"Represents sales-related information for a business. This class is marked as obsolete and is used only for backward compatibility."}}}} ``` ## The MerchantDemographics.Api.Models.Contact object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.Contact":{"required":["countryOfCitizenshipCode","firstName","lastName"],"type":"object","properties":{"countryOfCitizenshipCode":{"maximum":840,"minimum":1,"type":"string","description":"The country code for the citizenship of the contact. Must be a valid ISO code between 1 and 840."},"address":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.ContactAddress"},"ssnLastFour":{"type":"string","description":"The last four digits of the contact's SSN (Social Security Number). Excluded from Swagger documentation.","nullable":true},"encryptedSSN":{"type":"string","description":"The encrypted Social Security Number (SSN) of the contact.","format":"byte","nullable":true},"ssn":{"maxLength":9,"minLength":9,"type":"string","description":"The full legal ID, such as SSN, of the contact. Strips dashes automatically.","nullable":true},"contactId":{"type":"integer","description":"The unique identifier for the contact. Excluded from Swagger documentation.","format":"int32"},"firstName":{"minLength":1,"type":"string","description":"The first name of the contact."},"lastName":{"minLength":1,"type":"string","description":"The last name of the contact."},"dateOfBirth":{"type":"string","description":"The date of birth of the contact.","nullable":true},"dateOfBirthString":{"type":"string","description":"The date of birth in \"MMddyyyy\" format","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Contains all details of the business contact."},"MerchantDemographics.Api.Models.ContactAddress":{"required":["city","countryCode","line1","stateCode","zip"],"type":"object","properties":{"line1":{"minLength":1,"type":"string","description":"The first line of the address (Example, street address, P.O. box)."},"line2":{"type":"string","description":"The second line of the address (optional).","nullable":true},"line3":{"type":"string","description":"The third line of the address (optional).","nullable":true},"city":{"minLength":1,"type":"string","description":"The city or locality of the address."},"countryCode":{"maximum":840,"minimum":1,"type":"string","description":"The country code for the address. Typically a numeric code for the country."},"stateCode":{"maxLength":10,"minLength":2,"type":"string","description":"The state or region code. Typically a 2-letter code representing the state."},"zip":{"minLength":1,"type":"string","description":"The postal code (zip code) of the address."}},"additionalProperties":false,"description":"Address details of the contact."}}}} ``` ## The MerchantDemographics.Api.Models.ContactAddress object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.ContactAddress":{"required":["city","countryCode","line1","stateCode","zip"],"type":"object","properties":{"line1":{"minLength":1,"type":"string","description":"The first line of the address (Example, street address, P.O. box)."},"line2":{"type":"string","description":"The second line of the address (optional).","nullable":true},"line3":{"type":"string","description":"The third line of the address (optional).","nullable":true},"city":{"minLength":1,"type":"string","description":"The city or locality of the address."},"countryCode":{"maximum":840,"minimum":1,"type":"string","description":"The country code for the address. Typically a numeric code for the country."},"stateCode":{"maxLength":10,"minLength":2,"type":"string","description":"The state or region code. Typically a 2-letter code representing the state."},"zip":{"minLength":1,"type":"string","description":"The postal code (zip code) of the address."}},"additionalProperties":false,"description":"Address details of the contact."}}}} ``` ## The MerchantDemographics.Api.Models.EDocsFile object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.EDocsFile":{"required":["category","fileName","merchantNumber"],"type":"object","properties":{"category":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The category of the document, represented as an integer value.","format":"int32"},"categoryDescription":{"type":"string","description":"A description of the document category.","nullable":true},"description":{"type":"string","description":"A brief description of the document.","nullable":true},"documentId":{"type":"string","description":"The unique identifier for the document.","format":"uuid"},"fileName":{"minLength":1,"type":"string","description":"The name of the file associated with the document."},"merchantNumber":{"minLength":1,"type":"string","description":"The merchant's unique identifier."},"metaData":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.EDocsFileMetaData"},"description":"A list of metadata associated with the document.","nullable":true},"fileExtension":{"type":"string","description":"The file extension of the document.","nullable":true},"dateUploaded":{"type":"string","description":"The date and time (ISO 8601 format) when the document was uploaded. \r\nFormat: yyyy-MM-ddTHH:mm:ssZ","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.EDocsFileMetaData":{"type":"object","properties":{"metadataKey":{"type":"string","description":"The key or name of the metadata field.","nullable":true},"metadataValue":{"type":"string","description":"The value associated with the metadata key.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.EDocsFileCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.EDocsFileCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.EDocsFile"},"description":"Contains the details of the document.","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.EDocsFile":{"required":["category","fileName","merchantNumber"],"type":"object","properties":{"category":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The category of the document, represented as an integer value.","format":"int32"},"categoryDescription":{"type":"string","description":"A description of the document category.","nullable":true},"description":{"type":"string","description":"A brief description of the document.","nullable":true},"documentId":{"type":"string","description":"The unique identifier for the document.","format":"uuid"},"fileName":{"minLength":1,"type":"string","description":"The name of the file associated with the document."},"merchantNumber":{"minLength":1,"type":"string","description":"The merchant's unique identifier."},"metaData":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.EDocsFileMetaData"},"description":"A list of metadata associated with the document.","nullable":true},"fileExtension":{"type":"string","description":"The file extension of the document.","nullable":true},"dateUploaded":{"type":"string","description":"The date and time (ISO 8601 format) when the document was uploaded. \r\nFormat: yyyy-MM-ddTHH:mm:ssZ","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.EDocsFileMetaData":{"type":"object","properties":{"metadataKey":{"type":"string","description":"The key or name of the metadata field.","nullable":true},"metadataValue":{"type":"string","description":"The value associated with the metadata key.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.EDocsFileMetaData object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.EDocsFileMetaData":{"type":"object","properties":{"metadataKey":{"type":"string","description":"The key or name of the metadata field.","nullable":true},"metadataValue":{"type":"string","description":"The value associated with the metadata key.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.Enums.BankAccountPurpose object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.Enums.BankAccountPurpose":{"enum":["Settlement","Invoicing","Direct"],"type":"string"}}}} ``` ## The MerchantDemographics.Api.Models.Enums.CardBrandRef object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.Enums.CardBrandRef":{"enum":[1,2,3,4,5,6,7,8,-1],"type":"integer","format":"int32"}}}} ``` ## The MerchantDemographics.Api.Models.ErrorResults object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.ErrorResults":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.BoardingError"},"nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.BoardingError":{"type":"object","properties":{"errorMessage":{"type":"string","description":"Describes the error and provide detailed information on what went wrong during the request processing.","nullable":true},"resultCode":{"type":"integer","description":"Code associated with the error and helps to categorize the error type or severity. (It can be any error code 400/401/501, etc depending upon its type)","format":"int32"},"timeStamp":{"type":"string","description":"DateTime in ISO 8601 format. It is read-only and automatically set to the current date and time.","format":"date-time","readOnly":true},"fieldPath":{"type":"array","items":{"type":"string"},"description":"Field path(s) where the error occurred in a data structure. It can contains any field.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.FulfillmentHouseAddress object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.FulfillmentHouseAddress":{"required":["city","countryCode","line1","stateCode","zip"],"type":"object","properties":{"line1":{"minLength":1,"type":"string","description":"The first line of the vendors address. Possible values are street number, building number, and street name."},"line2":{"type":"string","description":"The second line of the vendors address. Possible values are apartment number, suite number, or building number.","nullable":true},"line3":{"type":"string","description":"The third line of the vendors address, if applicable.","nullable":true},"city":{"minLength":1,"type":"string","description":"City name where the vendor is located."},"countryCode":{"maximum":840,"minimum":1,"type":"string","description":"The country where the address is located. Three-letter country codes defined by ISO 3166-1. \r\nRetrieve allowed values programmatically using GET /api/demographics/v1.0/References/CountryOptions."},"stateCode":{"maxLength":10,"minLength":2,"type":"string","description":"The state or region of the address. Allowed values are the suffixes of the values defined in ISO 3166-2. \r\nExample, the US-MO can be shortened to MO. Retrieve allowed values programmatically using GET /api/demographics/v1.0/References/StateOptions."},"zip":{"minLength":1,"type":"string","description":"The zip or postal code of the vendors address."}},"additionalProperties":false,"description":"Indicates the address of the primary vendor to the supply chain or distribution model. \r\nIt is required when usesFulfillmentHouse is true. \r\nIf the usesFulfillmentHouse is false, the FulfillmentHouseAddress object in the request body will be ignored and previous values will be deleted."}}}} ``` ## The MerchantDemographics.Api.Models.FulfillmentHousePhone object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.FulfillmentHousePhone":{"required":["areaCode","phoneNumber"],"type":"object","properties":{"areaCode":{"maxLength":3,"minLength":3,"type":"string","description":"The 3-digit area code of the phone number."},"phoneNumber":{"maxLength":8,"minLength":7,"type":"string","description":"The 7-digit telephone number.","format":"tel"},"extension":{"type":"string","description":"The extension of the phone number, if needed.","nullable":true},"phoneTypeCodeID":{"type":"string","description":"Used to indicate a phone type. Allowed values:\r\n1 - Cell Phone\r\n2 - Fax\r\n3 - Home\r\n4 - Other\r\n5 - Work\r\nRetrieve allowed values programmatically using endpoint GET /api/demographics/v1.0/References/PhoneTypes.","nullable":true}},"additionalProperties":false,"description":"The phone of the primary vendor to the supply chain or distribution model.\r\nRequired and validated when UsesFulfillmentHouse is set to 'true'.\r\nIf UsesFulfillmentHouse is set to 'false', ignore the FulfillmentHousePhone from request body, and previous values are deleted.\r\nDo not populate the FulfillmentHousePhone object if UsesFulfillmentHouse is set to 'false'."}}}} ``` ## The MerchantDemographics.Api.Models.PageSort object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.PageSort":{"type":"object","properties":{"fields":{"type":"object","additionalProperties":{"type":"string","nullable":true},"description":"Sorting criteria applied to the results.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.Pagination object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.Pagination":{"type":"object","properties":{"number":{"type":"integer","description":"Current page number in the result.","format":"int32"},"size":{"type":"integer","description":"The number of records returned per page.","format":"int32"},"sort":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.PageSort"},"totalPages":{"type":"integer","description":"Total number of available pages.","format":"int32"},"numberOfElements":{"type":"integer","description":"Number of elements in the current page.","format":"int32"},"totalElements":{"type":"integer","description":"Total number of merchants available.","format":"int32"},"first":{"type":"boolean","description":"Indicates if this is the first page."},"last":{"type":"boolean","description":"Indicates if this is the last page."}},"additionalProperties":false,"description":"Paging information for merchant records."},"MerchantDemographics.Api.Models.PageSort":{"type":"object","properties":{"fields":{"type":"object","additionalProperties":{"type":"string","nullable":true},"description":"Sorting criteria applied to the results.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.SalesInformation object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.SalesInformation":{"required":["businessID"],"type":"object","properties":{"salesInformationID":{"type":"integer","description":"The unique identifier for the sales information (excluded from Swagger documentation).","format":"int32"},"businessID":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The unique identifier for the associated business.","format":"int32"},"assignedUser":{"type":"integer","description":"The user ID of the person assigned to the sales record.","format":"int32"},"referralPartner":{"type":"string","description":"The name of the referral partner, if applicable.","nullable":true},"compensationType":{"type":"string","description":"The type of compensation associated with the sales, represented as an integer.","nullable":true}},"additionalProperties":false,"description":"Represents sales-related information for a business. This class is marked as obsolete and is used only for backward compatibility."}}}} ``` ## The MerchantDemographics.Api.Models.SalesProfileCBD object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.SalesProfileCBD":{"type":"object","properties":{"annualCBDRevenuePercentage":{"type":"string","description":"The percentage of the merchant's annual revenue that results from sales of products containing CBD.","nullable":true},"cbdProductInventoryPercentage":{"type":"string","description":"The percentage of the products in the merchants inventory containing CBD.","nullable":true},"incorporatedDate":{"type":"string","description":"The date of incorporation of the merchant.\r\nDates can be provided in the format yyyy-mm-ddThh:mm:ss or yyyy-mm-dd, however hours minutes and seconds will be omitted.\r\n2023-11-06: We are currently keeping IncorporatedDate because we have a partner using the SalesProfile V1 endpoints.\r\nV1 does not have its own DateOfIncorporation, this is the only place they can access the date. So, we need to keep it\r\nand the sync method in SalesProfileV2. The sync method is currently the only way IncorporatedDate has a value in it.","nullable":true,"deprecated":true},"salesProfileCBDCategory":{"type":"string","description":"Indicates the category that the merchant falls in CBD Program.\r\nIt is Backend-calculated category for the CBD Program.\r\nNot required in the request.","nullable":true},"cbdCategoryID":{"type":"string","description":"The CBD Category designator for the acquiring bank. \r\nCalculated on the backend; do not provide.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.SalesProfileV2 object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.SalesProfileV2":{"required":["annualVolume","averageTicket","cardBrands","cardPresentPercentage","currentlyOpenForBusiness","futureDeliveryTypeID","highTicket","mccCode","previouslyAcceptedPaymentCards","productsSold","returnRefundPolicy","sellsFirearmAccessories","sellsFirearms"],"type":"object","properties":{"usesFulfillmentHouse":{"type":"string","description":"Indicates whether a vendor handles accepting, shipping, or fulfilling merchant products, or billing merchant customers. \r\nRequired if the application is E-Comm or if it does more than 30% Card Not Present; otherwise can be null. \r\nEven if needed and not provided via API, a MOTO questionnaire will be collected as part of the underwriting process.","nullable":true},"offersNegativeOptionBilling":{"type":"string","description":"Indicates whether the vendor offers negative option billing. \r\nRequired if the application is E-Comm or if it does more than 30% Card Not Present; otherwise can be null. \r\nEven if needed and not provided via API, a MOTO questionnaire will be collected as part of the underwriting process.","nullable":true},"fulfillmentHouseAddress":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.FulfillmentHouseAddress"},"fulfillmentHousePhone":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.FulfillmentHousePhone"},"vendorName":{"type":"string","description":"Name of the vendor associated with a merchant.","nullable":true},"dateOfIncorporation":{"type":"string","description":"Date of incorporation of the merchant.\r\nFormat: yyyy-mm-ddThh:mm:ss or yyyy-mm-dd.\r\nHowever, hours, minutes, and seconds will be omitted.","nullable":true},"useExtraCnpValidation":{"type":"string","description":"Indicates whether DateOfIncorporation is required when merchant is E-Commerce or >30% Card Not Present.","nullable":true},"isECommerce":{"type":"string","description":"Indicates whether the business is entirely online (E-Commerce).","nullable":true},"mccCode":{"maxLength":4,"minLength":4,"type":"string","description":"Indicates the 4-digit Merchant Category Code (MCC) used to classify merchants and businesses by the type of goods or services provided."},"cardPresentPercentage":{"type":"string","description":"The percentage of the merchant's transactions classified as card present."},"returnRefundPolicy":{"minLength":1,"type":"string","description":"Indicates the merchant's policy regarding returns and refunds."},"productsSold":{"minLength":1,"type":"string","description":"A description of the products sold by the merchant."},"previouslyAcceptedPaymentCards":{"type":"string","description":"Indicates whether the merchant previously accepted card payments."},"previousProcessorId":{"maximum":2147483647,"minimum":1,"type":"string","description":"Identifier of the previous payment processor.\r\nRequired if the merchant previously accepted card payments.\r\nThe value must be in range of [1, 2147483647].","nullable":true},"previouslyTerminatedOrIdentifiedByRiskMonitoring":{"type":"string","description":"\r\n
\r\n Indicates whether the merchant was previously terminated by another processor or identified by their risk monitoring solutions.","nullable":true},"reasonPreviouslyTerminatedOrIdentifiedByRisk":{"type":"string","description":"\r\n
\r\n Additional information for merchants who were previously terminated by another processor or identified by their risk monitoring solution.\r\n Required when PreviouslyTerminatedOrIdentifiedByRiskMonitoring is set to true.","nullable":true},"currentlyOpenForBusiness":{"type":"string","description":"Indicates whether the merchant is currently open for business."},"annualVolume":{"type":"string","description":"The annual gross volume of sales done by the merchant.\r\nIf the merchant has been open for less than 12 months, the projected annual gross volume of sales."},"averageTicket":{"type":"string","description":"The average volume of a transaction for the merchant."},"highTicket":{"type":"string","description":"The high volume of a transaction for the merchant."},"ownsProduct":{"type":"string","description":"Indicates whether a merchant owns the products that they sell.","nullable":true},"ordersProduct":{"type":"string","description":"Indicates whether a merchant orders the products that they sell.","nullable":true},"sellsFirearms":{"type":"string","description":"Indicates whether a merchant sells firearms."},"sellsCBD":{"type":"string","description":"Indicates whether the merchant sells CBD or CBD based products.\r\nNote: This field has been deprecated in favor of the CBDSalesTypeId field and should no longer be used.","nullable":true,"deprecated":true},"cbdSalesTypeID":{"type":"string","description":"Indicate merchant participation in the Xplor Pay's CBD Program.\r\n1 - CBD Seller\r\n2 - CBD Supplier\r\n3 - None\r\nIf this value is omitted, the CBDSalesTypeID is assumed to be None.","nullable":true},"salesProfileCBD":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.SalesProfileCBD"},"sellsFirearmAccessories":{"type":"string","description":"Indicates whether a merchant sells firearms accessories."},"futureDeliveryTypeID":{"type":"string","description":"Indicates typical delivery range for post-purchase products.\r\nRequired if FutureDeliveryPercentage is greater than 0.\r\nAllowed values:\r\n1 - Products are delivered within 1-7 days\r\n2 - Products are delivered between 7-14 days\r\n3 - Products are delivered at later time\r\nRetrieve allowed values programmatically using endpoint GET /api/demographics/v1.0/References/FutureDeliveryTypes"},"otherDeliveryType":{"type":"string","description":"Additional information once products are delivered.\r\nRequired when FutureDeliveryTypeId is 3.","nullable":true},"otherDeliveryTypeInDays":{"type":"integer","description":"A numeric version of OtherDeliveryType.\r\n(Note: Currently in development and the field OtherDeliveryType should be used in lieu of this.)","format":"int32"},"futureDeliveryPercentage":{"type":"string","description":"The percentage of products delivered after the time of purchase.","nullable":true},"fireArmsLicense":{"type":"string","description":"The Federal Firearms License (FFL) number assigned to a merchant by the U.S. Bureau of Alcohol, Tobacco, Firearms and Explosives.\r\nA 15 digit number containing 14 numbers and 1 letter.\r\nRequired when a SellsFirearms is true.\r\nCan be left null, otherwise.","nullable":true},"cardBrands":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.Api.Models.Enums.CardBrandRef"},"description":"Indicates the set of card brands that are accepted by the partner.\r\nAllowed values:\r\n1 - American Express through the OptBlue Program\r\n2 - Debit\r\n3 - Discover\r\n4 - MasterCard\r\n5 - Visa\r\n6 - EBT\r\n7 - American Express through the ESA Program."},"ebtNumber":{"type":"string","description":"The Electronics Benefit Transfer (EBT) number assigned to a merchant by the U.S. Department of Agriculture.\r\nTypically a 7 digit number. Required if CardBrands includes 6 (EBT); otherwise can be null.","nullable":true},"amexMID":{"type":"string","description":"Number assigned to participants in Amex ESA program.\r\nRequired if cardBrands includes 7 indicating that the merchant accepts Amex ESA; otherwise can be null.","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.FulfillmentHouseAddress":{"required":["city","countryCode","line1","stateCode","zip"],"type":"object","properties":{"line1":{"minLength":1,"type":"string","description":"The first line of the vendors address. Possible values are street number, building number, and street name."},"line2":{"type":"string","description":"The second line of the vendors address. Possible values are apartment number, suite number, or building number.","nullable":true},"line3":{"type":"string","description":"The third line of the vendors address, if applicable.","nullable":true},"city":{"minLength":1,"type":"string","description":"City name where the vendor is located."},"countryCode":{"maximum":840,"minimum":1,"type":"string","description":"The country where the address is located. Three-letter country codes defined by ISO 3166-1. \r\nRetrieve allowed values programmatically using GET /api/demographics/v1.0/References/CountryOptions."},"stateCode":{"maxLength":10,"minLength":2,"type":"string","description":"The state or region of the address. Allowed values are the suffixes of the values defined in ISO 3166-2. \r\nExample, the US-MO can be shortened to MO. Retrieve allowed values programmatically using GET /api/demographics/v1.0/References/StateOptions."},"zip":{"minLength":1,"type":"string","description":"The zip or postal code of the vendors address."}},"additionalProperties":false,"description":"Indicates the address of the primary vendor to the supply chain or distribution model. \r\nIt is required when usesFulfillmentHouse is true. \r\nIf the usesFulfillmentHouse is false, the FulfillmentHouseAddress object in the request body will be ignored and previous values will be deleted."},"MerchantDemographics.Api.Models.FulfillmentHousePhone":{"required":["areaCode","phoneNumber"],"type":"object","properties":{"areaCode":{"maxLength":3,"minLength":3,"type":"string","description":"The 3-digit area code of the phone number."},"phoneNumber":{"maxLength":8,"minLength":7,"type":"string","description":"The 7-digit telephone number.","format":"tel"},"extension":{"type":"string","description":"The extension of the phone number, if needed.","nullable":true},"phoneTypeCodeID":{"type":"string","description":"Used to indicate a phone type. Allowed values:\r\n1 - Cell Phone\r\n2 - Fax\r\n3 - Home\r\n4 - Other\r\n5 - Work\r\nRetrieve allowed values programmatically using endpoint GET /api/demographics/v1.0/References/PhoneTypes.","nullable":true}},"additionalProperties":false,"description":"The phone of the primary vendor to the supply chain or distribution model.\r\nRequired and validated when UsesFulfillmentHouse is set to 'true'.\r\nIf UsesFulfillmentHouse is set to 'false', ignore the FulfillmentHousePhone from request body, and previous values are deleted.\r\nDo not populate the FulfillmentHousePhone object if UsesFulfillmentHouse is set to 'false'."},"MerchantDemographics.Api.Models.SalesProfileCBD":{"type":"object","properties":{"annualCBDRevenuePercentage":{"type":"string","description":"The percentage of the merchant's annual revenue that results from sales of products containing CBD.","nullable":true},"cbdProductInventoryPercentage":{"type":"string","description":"The percentage of the products in the merchants inventory containing CBD.","nullable":true},"incorporatedDate":{"type":"string","description":"The date of incorporation of the merchant.\r\nDates can be provided in the format yyyy-mm-ddThh:mm:ss or yyyy-mm-dd, however hours minutes and seconds will be omitted.\r\n2023-11-06: We are currently keeping IncorporatedDate because we have a partner using the SalesProfile V1 endpoints.\r\nV1 does not have its own DateOfIncorporation, this is the only place they can access the date. So, we need to keep it\r\nand the sync method in SalesProfileV2. The sync method is currently the only way IncorporatedDate has a value in it.","nullable":true,"deprecated":true},"salesProfileCBDCategory":{"type":"string","description":"Indicates the category that the merchant falls in CBD Program.\r\nIt is Backend-calculated category for the CBD Program.\r\nNot required in the request.","nullable":true},"cbdCategoryID":{"type":"string","description":"The CBD Category designator for the acquiring bank. \r\nCalculated on the backend; do not provide.","nullable":true}},"additionalProperties":false},"MerchantDemographics.Api.Models.Enums.CardBrandRef":{"enum":[1,2,3,4,5,6,7,8,-1],"type":"integer","format":"int32"}}}} ``` ## The MerchantDemographics.Api.Models.SeasonalSchedule object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.SeasonalSchedule":{"required":["april","august","december","february","january","july","june","march","may","november","october","september"],"type":"object","properties":{"january":{"type":"boolean","description":"Indicates whether the business operates in January."},"february":{"type":"boolean","description":"Indicates whether the business operates in February."},"march":{"type":"boolean","description":"Indicates whether the business operates in March."},"april":{"type":"boolean","description":"Indicates whether the business operates in April."},"may":{"type":"boolean","description":"Indicates whether the business operates in May."},"june":{"type":"boolean","description":"Indicates whether the business operates in June."},"july":{"type":"boolean","description":"Indicates whether the business operates in July."},"august":{"type":"boolean","description":"Indicates whether the business operates in August."},"september":{"type":"boolean","description":"Indicates whether the business operates in September."},"october":{"type":"boolean","description":"Indicates whether the business operates in October."},"november":{"type":"boolean","description":"Indicates whether the business operates in November."},"december":{"type":"boolean","description":"Indicates whether the business operates in December."}},"additionalProperties":false,"description":"Indicates whether the merchant operates seasonally and specifies the months they are active."}}}} ``` ## The MerchantDemographics.Api.Models.SiteSurvey object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.SiteSurvey":{"required":["agreementAccepted","inventoryMatchesProductSold","siteSurveyConductedInPerson","siteTypeID","validIDVerified"],"type":"object","properties":{"siteTypeID":{"maximum":4,"minimum":1,"type":"string","description":"Site values are from 1 to 4, representing different site types. Possible values:\r\n1 - Other\r\n2 - BrickAndMortar\r\n3 - Tradeshow\r\n4 - Residence"},"otherSiteTypeDescription":{"type":"string","description":"Description of the site type, used when SiteTypeID is 1 (Other).","nullable":true},"siteSurveyConductedInPerson":{"type":"string","description":"Indicates whether the site survey was conducted in person."},"merchantAcquisitionTypeID":{"maximum":3,"minimum":1,"type":"string","description":"The type of merchant acquisition. Valid values are from 1 to 3, representing acquisition methods.","nullable":true},"validIDVerified":{"type":"string","description":"Indicates whether a valid ID has been verified."},"inventoryMatchesProductSold":{"type":"string","description":"Indicates whether the inventory matches the products being sold."},"inventoryMatchesProductSoldComments":{"type":"string","description":"Additional comments if the inventory does not match the products being sold.","nullable":true},"agreementAccepted":{"type":"string","description":"Indicates whether the agreement has been accepted by the merchant."},"selfSignUpApplication":{"type":"boolean","description":"Indicates whether the application was submitted via self-sign-up."}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Models.TaxpayerV2 object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Models.TaxpayerV2":{"required":["businessLegalName","tin","tinTypeID"],"type":"object","properties":{"legalFirstName":{"type":"string","description":"First name of the tax payer.","nullable":true},"legalLastName":{"type":"string","description":"Last name of the tax payer.","nullable":true},"tin":{"maxLength":9,"minLength":9,"type":"string","description":"Taxpayer Identification Number (TIN). Must be exactly 9 characters long."},"encryptedTIN":{"type":"string","description":"Encrypted representation of the TIN for security purposes.","format":"byte","nullable":true},"tinLastFour":{"type":"string","description":"Represents last fout digits of TIN number","nullable":true,"readOnly":true},"tinTypeID":{"maximum":3,"minimum":1,"type":"string","description":"Identifier for the type of TIN. Must be between 1 and 3."},"businessLegalName":{"minLength":1,"type":"string","description":"The legal name of the business associated with the taxpayer."},"stateIncorporatedCode":{"type":"string","description":"The state where the business is incorporated. Represented as a two-character code.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.Api.Validation.SerializableValidationResult object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.Api.Validation.SerializableValidationResult":{"type":"object","properties":{"errorMessagesByMemberName":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"},"nullable":true},"description":"A dictionary of error messages categorized by member name.","nullable":true,"readOnly":true},"generalErrorMessages":{"type":"array","items":{"type":"string"},"description":"A list of general error messages not associated with any specific member.","nullable":true,"readOnly":true},"success":{"type":"boolean","description":"Indicates whether the validation was successful.","readOnly":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.BusinessSearchResult object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.BusinessSearchResult":{"type":"object","properties":{"hierarchyNodeKey":{"type":"string","description":"The unique identifier for the business in the hierarchy structure. Typically used to reference the business's position within a hierarchy.","nullable":true},"businessDBA":{"type":"string","description":"The Doing Business As (DBA) name of the business, representing the trade name under which the business operates.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.BusinessSearchResultCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.BusinessSearchResultCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.BusinessSearchResult"},"description":"Object - Contains the business information within the hierarchy.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.BusinessSearchResult":{"type":"object","properties":{"hierarchyNodeKey":{"type":"string","description":"The unique identifier for the business in the hierarchy structure. Typically used to reference the business's position within a hierarchy.","nullable":true},"businessDBA":{"type":"string","description":"The Doing Business As (DBA) name of the business, representing the trade name under which the business operates.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.CompanyTypeCode object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.CompanyTypeCode":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the company type.","format":"int32"},"type":{"type":"string","description":"The name or type of the company, such as LLC, SP, or NP etc.","nullable":true},"legalIdentifiersRequired":{"type":"boolean","description":"Indicates whether legal identifiers (e.g., registration number, tax ID) are required for this company type."},"description":{"type":"string","description":"A brief description of the company type, explaining its characteristics or legal structure.","nullable":true},"countryCode":{"type":"string","description":"The country code associated with the company type, typically using the ISO 3166-1 alpha-2 format.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.CompanyTypeCodeCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.CompanyTypeCodeCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.CompanyTypeCode"},"description":"A collection of Company Type Code and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.CompanyTypeCode":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the company type.","format":"int32"},"type":{"type":"string","description":"The name or type of the company, such as LLC, SP, or NP etc.","nullable":true},"legalIdentifiersRequired":{"type":"boolean","description":"Indicates whether legal identifiers (e.g., registration number, tax ID) are required for this company type."},"description":{"type":"string","description":"A brief description of the company type, explaining its characteristics or legal structure.","nullable":true},"countryCode":{"type":"string","description":"The country code associated with the company type, typically using the ISO 3166-1 alpha-2 format.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.CompensationType object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.CompensationType":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the compensation type.","format":"int32"},"description":{"type":"string","description":"A brief description of the compensation type, such as Bonus, or All Residual.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.CompensationTypeCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.CompensationTypeCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.CompensationType"},"description":"A collection of Compensation Type and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.CompensationType":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the compensation type.","format":"int32"},"description":{"type":"string","description":"A brief description of the compensation type, such as Bonus, or All Residual.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.ContactType object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.ContactType":{"type":"object","properties":{"contactTypeID":{"type":"integer","description":"The unique identifier for the contact type.","format":"int32"},"contactTypeCode":{"type":"string","description":"The code that represents the type of contact.","nullable":true},"contactTypeDescription":{"type":"string","description":"A brief description of the contact type.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.ContactTypeCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.ContactTypeCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.ContactType"},"description":"A collection of contact types and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.ContactType":{"type":"object","properties":{"contactTypeID":{"type":"integer","description":"The unique identifier for the contact type.","format":"int32"},"contactTypeCode":{"type":"string","description":"The code that represents the type of contact.","nullable":true},"contactTypeDescription":{"type":"string","description":"A brief description of the contact type.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.CountryOption object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.CountryOption":{"type":"object","properties":{"countryCode":{"type":"integer","description":"The unique numeric code for the country.","format":"int32"},"countryName":{"type":"string","description":"The name of the country.","nullable":true},"isDisplayed":{"type":"boolean","description":"Indicates whether the country should be displayed in the UI or a specific context."},"iso2":{"type":"string","description":"The ISO 3166-1 alpha-2 code for the country.","nullable":true},"iso3":{"type":"string","description":"The ISO 3166-1 alpha-3 code for the country.","nullable":true},"stateOrProvinceIsRequired":{"type":"boolean","description":"Indicates whether the state or province is required for addresses in this country."}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.CountryOptionCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.CountryOptionCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.CountryOption"},"description":"A collection of Company Option and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.CountryOption":{"type":"object","properties":{"countryCode":{"type":"integer","description":"The unique numeric code for the country.","format":"int32"},"countryName":{"type":"string","description":"The name of the country.","nullable":true},"isDisplayed":{"type":"boolean","description":"Indicates whether the country should be displayed in the UI or a specific context."},"iso2":{"type":"string","description":"The ISO 3166-1 alpha-2 code for the country.","nullable":true},"iso3":{"type":"string","description":"The ISO 3166-1 alpha-3 code for the country.","nullable":true},"stateOrProvinceIsRequired":{"type":"boolean","description":"Indicates whether the state or province is required for addresses in this country."}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.DocumentCategory object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.DocumentCategory":{"type":"object","properties":{"documentCategoryID":{"type":"integer","description":"The unique identifier for the document category.","format":"int32"},"documentCategoryName":{"type":"string","description":"The name of the document category.","nullable":true},"documentCategoryDesc":{"type":"string","description":"A description of the document category providing more context about the category.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.DocumentCategoryCodeCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.DocumentCategoryCodeCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.DocumentCategory"},"description":"A collection of Document category and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.DocumentCategory":{"type":"object","properties":{"documentCategoryID":{"type":"integer","description":"The unique identifier for the document category.","format":"int32"},"documentCategoryName":{"type":"string","description":"The name of the document category.","nullable":true},"documentCategoryDesc":{"type":"string","description":"A description of the document category providing more context about the category.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.LegalIdentifierType object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.LegalIdentifierType":{"type":"object","properties":{"type":{"type":"string","description":"The type of legal identifier (TIN, SSN, SIRET, etc.)","nullable":true},"description":{"type":"string","description":"A description of the legal identifier type.","nullable":true},"isVatIdentifier":{"type":"boolean","description":"Indicates whether the identifier is a VAT-related identifier."},"countryCode":{"type":"string","description":"The country code associated with the legal identifier.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.LegalIdentifierTypeCodeCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.LegalIdentifierTypeCodeCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.LegalIdentifierType"},"description":"A collection of legal identifier types.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.LegalIdentifierType":{"type":"object","properties":{"type":{"type":"string","description":"The type of legal identifier (TIN, SSN, SIRET, etc.)","nullable":true},"description":{"type":"string","description":"A description of the legal identifier type.","nullable":true},"isVatIdentifier":{"type":"boolean","description":"Indicates whether the identifier is a VAT-related identifier."},"countryCode":{"type":"string","description":"The country code associated with the legal identifier.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.MerchantAcquisitionTypeCode object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.MerchantAcquisitionTypeCode":{"type":"object","properties":{"merchantAcquisitionTypeID":{"type":"integer","description":"The unique identifier for the merchant acquisition type.","format":"int32"},"merchantAcquisitionType":{"type":"string","description":"A description or code that represents the type of merchant acquisition.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.MerchantAcquisitionTypeCodeCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.MerchantAcquisitionTypeCodeCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.MerchantAcquisitionTypeCode"},"description":"A collection of merchant acquisition type codes and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.MerchantAcquisitionTypeCode":{"type":"object","properties":{"merchantAcquisitionTypeID":{"type":"integer","description":"The unique identifier for the merchant acquisition type.","format":"int32"},"merchantAcquisitionType":{"type":"string","description":"A description or code that represents the type of merchant acquisition.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.MerchantCategoryCode object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.MerchantCategoryCode":{"type":"object","properties":{"mccCode":{"type":"string","description":"The unique code representing a specific merchant category.","nullable":true},"mccGroupCode":{"type":"string","description":"The group code associated with the merchant category, used for classification purposes.","nullable":true},"mccDescription":{"type":"string","description":"A brief description of the merchant category represented by the MCC code.","nullable":true},"mccMostUsedRank":{"type":"string","description":"The rank indicating how frequently this merchant category code is used.","nullable":true},"mccIsSupported":{"type":"boolean","description":"Indicates whether the merchant category code is supported in the current system or application."},"isRestricted":{"type":"boolean","description":"Indicates whether the merchant category code is restricted to be seen from the retrieved list"}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.MerchantCategoryCodeCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.MerchantCategoryCodeCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.MerchantCategoryCode"},"description":"A collection of Merchant Category Code and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.MerchantCategoryCode":{"type":"object","properties":{"mccCode":{"type":"string","description":"The unique code representing a specific merchant category.","nullable":true},"mccGroupCode":{"type":"string","description":"The group code associated with the merchant category, used for classification purposes.","nullable":true},"mccDescription":{"type":"string","description":"A brief description of the merchant category represented by the MCC code.","nullable":true},"mccMostUsedRank":{"type":"string","description":"The rank indicating how frequently this merchant category code is used.","nullable":true},"mccIsSupported":{"type":"boolean","description":"Indicates whether the merchant category code is supported in the current system or application."},"isRestricted":{"type":"boolean","description":"Indicates whether the merchant category code is restricted to be seen from the retrieved list"}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.PhoneTypeCodeRef object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.PhoneTypeCodeRef":{"type":"object","properties":{"phoneTypeCodeID":{"type":"integer","description":"The unique identifier for the phone type code.","format":"int32"},"phoneTypeCode":{"type":"string","description":"The code that represents the type of phone (e.g., C, H, W).","nullable":true},"phoneTypeDescription":{"type":"string","description":"A brief description of the phone type (e.g., Cell, Home, Work).","nullable":true},"displayOrder":{"type":"integer","description":"The display order of the phone type code in a list or UI.","format":"int32"}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.PhoneTypeCodeRefCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.PhoneTypeCodeRefCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.PhoneTypeCodeRef"},"description":"A collection of phone type codes and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.PhoneTypeCodeRef":{"type":"object","properties":{"phoneTypeCodeID":{"type":"integer","description":"The unique identifier for the phone type code.","format":"int32"},"phoneTypeCode":{"type":"string","description":"The code that represents the type of phone (e.g., C, H, W).","nullable":true},"phoneTypeDescription":{"type":"string","description":"A brief description of the phone type (e.g., Cell, Home, Work).","nullable":true},"displayOrder":{"type":"integer","description":"The display order of the phone type code in a list or UI.","format":"int32"}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.PreviousProcessor object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.PreviousProcessor":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the previous processor.","format":"int32"},"description":{"type":"string","description":"A brief description of the previous processor, such as Bangor Savings Bank, Blue Pay or Citi Merchant Services, etc.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.PreviousProcessorCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.PreviousProcessorCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.PreviousProcessor"},"description":"A collection of previous processors, providing details about each processor used in the past.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.PreviousProcessor":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the previous processor.","format":"int32"},"description":{"type":"string","description":"A brief description of the previous processor, such as Bangor Savings Bank, Blue Pay or Citi Merchant Services, etc.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.SignatureSection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.SignatureSection":{"type":"object","properties":{"signatureSectionTypeId":{"type":"integer","description":"The unique identifier for the signature section type.","format":"int32"},"signatureSectionTypeName":{"type":"string","description":"The name of the signature section type.","nullable":true},"signatureSectionTypeDescription":{"type":"string","description":"A description of the signature section, providing more context about its use or purpose.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.SignatureSectionCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.SignatureSectionCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.SignatureSection"},"description":"A collection of signature section and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.SignatureSection":{"type":"object","properties":{"signatureSectionTypeId":{"type":"integer","description":"The unique identifier for the signature section type.","format":"int32"},"signatureSectionTypeName":{"type":"string","description":"The name of the signature section type.","nullable":true},"signatureSectionTypeDescription":{"type":"string","description":"A description of the signature section, providing more context about its use or purpose.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.SignatureSourceType object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.SignatureSourceType":{"type":"object","properties":{"signatureSourceTypeId":{"type":"integer","description":"The unique identifier for the signature source type.","format":"int32"},"signatureSourceTypeName":{"type":"string","description":"The name of the signature source type.","nullable":true},"signatureSourceTypeDescription":{"type":"string","description":"A description of the signature source type, explaining its purpose or usage.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.SignatureSourceTypeCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.SignatureSourceTypeCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.SignatureSourceType"},"description":"A collection of Signature source type and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.SignatureSourceType":{"type":"object","properties":{"signatureSourceTypeId":{"type":"integer","description":"The unique identifier for the signature source type.","format":"int32"},"signatureSourceTypeName":{"type":"string","description":"The name of the signature source type.","nullable":true},"signatureSourceTypeDescription":{"type":"string","description":"A description of the signature source type, explaining its purpose or usage.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.SiteType object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.SiteType":{"type":"object","properties":{"siteTypeID":{"type":"integer","description":"The unique identifier for the site type.","format":"int32"},"siteTypeDescription":{"type":"string","description":"A description of the site type such as Tradeshow, Residence, etc.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.SiteTypeCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.SiteTypeCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.SiteType"},"description":"A collection of State type and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.SiteType":{"type":"object","properties":{"siteTypeID":{"type":"integer","description":"The unique identifier for the site type.","format":"int32"},"siteTypeDescription":{"type":"string","description":"A description of the site type such as Tradeshow, Residence, etc.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.StateOption object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.StateOption":{"type":"object","properties":{"stateCode":{"type":"string","description":"The unique code for the state or province, typically represented as an abbreviation.","nullable":true},"stateName":{"type":"string","description":"The full name of the state or province.","nullable":true},"isDisplayed":{"type":"boolean","description":"Indicates whether the state or province should be displayed in the UI or a specific context."},"countryCode":{"type":"string","description":"The country code associated with this state or province, typically using ISO 3166-1 alpha-2 format.","nullable":true}},"additionalProperties":false}}}} ``` ## The MerchantDemographics.References.Api.Models.StateOptionCollection object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"MerchantDemographics.References.Api.Models.StateOptionCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.StateOption"},"description":"A collection of State Option and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.StateOption":{"type":"object","properties":{"stateCode":{"type":"string","description":"The unique code for the state or province, typically represented as an abbreviation.","nullable":true},"stateName":{"type":"string","description":"The full name of the state or province.","nullable":true},"isDisplayed":{"type":"boolean","description":"Indicates whether the state or province should be displayed in the UI or a specific context."},"countryCode":{"type":"string","description":"The country code associated with this state or province, typically using ISO 3166-1 alpha-2 format.","nullable":true}},"additionalProperties":false}}}} ``` ## The Microsoft.AspNetCore.Mvc.ProblemDetails object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"Microsoft.AspNetCore.Mvc.ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}} ``` ## The StagedChange.Client.Models.StagedChangeResponse object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"StagedChange.Client.Models.StagedChangeResponse":{"type":"object","properties":{"uniqueIdentifier":{"type":"string","nullable":true}},"additionalProperties":false}}}} ``` ## The eDocs.Contracts.DocumentCategory object ```json {"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"components":{"schemas":{"eDocs.Contracts.DocumentCategory":{"enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44],"type":"integer","format":"int32"}}}} ```