Applicant identity
| Field Name | Description | Mandatory? | Validation Criteria |
|---|---|---|---|
| Acceptor Reference | The unique identifier provided by the transactor used to identify the Acceptor application. | No | String up to 50 characters |
| Acceptor Relationship Reference | Used to identify multiple acceptors that roll up to a broader relationship. | No | |
| Acceptor Type | The type of acceptor. | Yes | Set to one of the possible selections: Biller, Merchant, Seller, Sponsored Merchant, Supplier, Wallet |
| Business Entity Type | The type of business | Yes | Set to one of the possible selections: Association, Cooperative, Corporation, Government, LLC, LLP, Partnership, Sole Proprietor, Other |
| Business Name | The descriptive name for the organization that is different from its legal entity name. Also known as “Doing Business As” (DBA), “trade name”, “assumed name”, or “fictitious name”. | Yes | Must be less than 22 characters in length. |
| Default Merchant Category Code | The default merchant category code for the acceptor. | Conditional | Required when multiple MerchantCategories are specified Must be a valid MCC Must be one of the values in the MerchantCategoryCode list |
| Merchant Categories | List of unique ISO four digit values used to classify merchants and their transactions into specific categories based on the type of business, trade or services supplied. | Yes | MCC code(s) must be valid |
| Is Known Acceptor | Indicates the acceptor is a known trusted acceptor. | Yes | Set to true when the acceptor is known and trusted. |
| Is Processing Statement | An indicator informing Tesouro when processing statements require review by the underwriter. | Yes | Set to true when processing statements require review. |
| Legal Entity Name | The official, registered name of a business that appears on legal documents, and used to identify the company legally by the government. | Yes | Can’t be empty or contain only whitespace Must be the owner’s name when Business Entity Type = ‘Sole Proprietor’ |
| Service Telephone Number | The telephone number that is provided on the billing statement for service inquiries. | Yes | Must be in a valid format (ex. 111-222-3333) |
| Tax Identification Number Type | Type of tax identification number. | Yes | Set to one of the possible selections: EIN, SSN, TIN |
| Tax Identification Number | The tax identification number of the legal entity. | Yes | Must be set to a valid SSN or TIN. |
| Sponsor Bank ID | The unique identifier for the sponsor bank. | Yes | |
| Bin Group ID | The unique identifier for the set of bins from the sponsor bank to use. | Yes | |
| Transactor Type I Override | This overrides the transactor’s type when supplied. | No | Set to one of the possible selections: BPSP, CBPS, DWO, ISO, Marketplace, Payment Facilitator |
| Transactor Type II | The name of the referral partner. | No | |
| Transactor Type III | Identifies any Gateways, POS software, or Fulfillment partners. | No | |
| Website | The website address | No |
Legal address
The physical location that the acceptor uses to identify itself for legal purposes.
| Field Name | Description | Mandatory? | Validation Criteria |
|---|---|---|---|
| Address 1 | The first line of the address. | Yes | A string up to 100 characters. |
| Address 2 | The second line of the address. | No | A string up to 100 characters. |
| Address 3 | The third line of the address. | No | A string up to 100 characters. |
| City | City, town, or village. | Yes | A string up to 100 characters. |
| State | State or province. | Yes | US states must be in their 2 character format defined here https://about.usps.com/who/profile/history/state-abbreviations.htm |
| Postal Code | A set of specific numbers, and sometimes letters, that help postal services deliver mail. | Yes | A string up to 15 characters. |
| Country | The ISO 3166-1 three-letter country code associated with the address. | Yes | Must be USA |
| Is Legal Address Same As Business Address | Provides the ability to copy the legal address as the business address. | No | The Boolean scalar type represents true or false. |
Business address
The physical location that the acceptor uses to identify itself for operational and communication purposes.
| Field Name | Description | Mandatory? | Validation Criteria |
|---|---|---|---|
| Address 1 | The first line of the address. | Yes | A string up to 100 characters. |
| Address 2 | The second line of the address. | No | A string up to 100 characters. |
| Address 3 | The third line of the address. | No | A string up to 100 characters. |
| City | City, town, or village. | Yes | A string up to 100 characters. |
| State | State or province. | Yes | US states must be in their 2 character format defined here https://about.usps.com/who/profile/history/state-abbreviations.htm |
| Postal Code | A set of specific numbers, and sometimes letters, that help postal services deliver mail. | Yes | A string up to 15 characters. |
| Country Code | The ISO 3166-1 three-letter country code associated with the address. | Yes | Must be USA |
Processing activity (card)
| Field Name | Description | Mandatory? | Validation Criteria |
|---|---|---|---|
| Average Monthly Sales | The average gross sales amount. | Yes | |
| Average Ticket | The average amount of a transaction. | Yes | |
| Card Present Mix | The approximate mix of card present (CP) transactions. | Yes | Formatted as a decimal., e.g., If CP transactions make up 20% of total volume, input as 0.2. |
| Card Not Present Mix | The approximate mix of card-not-present (CNP) transactions. | Yes | Formatted as a decimal., e.g., If CNP transactions make up 80% of total volume, input as 0.8. |
| Chargeback Rate | The approximate rate of chargebacks. | Yes | Must be greater than 0 and less than or equal to 100. Formatted as a decimal., e.g., If the chargeback rate is 0.25%, input as 0.0025 |
| Refund Rate | The approximate rate of refunds. | Yes | Must be greater than 0 and less than or equal to 100. Formatted as a decimal., e.g., If the refund rate is 10%, input as 0.1. |
| Currency | The currency specified on the transaction requests, in ISO 4217 alpha currency code format. | Yes | An ISO 4217 alpha currency code defined here https://en.wikipedia.org/wiki/ISO_4217 |
| Highest Ticket Amount | The highest amount of a transaction. | Yes | The Decimal scalar type represents a decimal floating-point number. |
Processing activity (bank transfer)
| Field Name | Description | Mandatory? | Validation Criteria |
|---|---|---|---|
| Annual Bank Transfer Volume | The average annual bank transfer amount. | Conditional | Required if Bank Transfer service is enabled Should be greater than maximum daily bank transfer amount |
| Average Bank Transfer Ticket | The average bank transfer ticket amount. | Conditional | Required if Bank Transfer service is enabled Should be greater than 0 |
| Bank Transfer Highest Ticket Amount | The highest bank transfer ticket amount. | Conditional | Required if Bank Transfer service is enabled Should be greater than average bank transfer ticket amount |
| Bank Transfer Return Rate | The approximate rate of returns | Conditional | Required if Bank Transfer service is enabled Should be greater than the unauthorized return rate Formatted as a decimal., e.g., If the chargeback rate is 0.25%, input as 0.0025 |
| Bank Transfer Unauthorized Return Rate | The approximate rate of unauthorized returns. | Conditional | Required if Bank Transfer service is enabled Formatted as a decimal., e.g., If the chargeback rate is 0.25%, input as 0.0025 |
| Max Daily Bank Transfer Total Amount | The maximum daily bank transfer total amount | Conditional | Required if Bank Transfer service is enabled Should be greater than the highest bank transfer ticket amount |
| Daily Bank Transfer Limit Amount | The daily amount limit for bank transfers. | Conditional | Required when the Bank Transfer service is enabled The Decimal scalar type represents a decimal floating-point number. |
Stakeholder details
| Field Name | Description | Mandatory? | Validation Criteria |
|---|---|---|---|
| Stakeholder Role | Indicates the role(s) of the identified stakeholder | Yes | Set to one or more of the possible selections: Authorized, Company, Control Person, Guarantor, Owner, Primary Contact A Sole Proprietor cannot have a “Company” listed as a stakeholder A Sole Proprietor must only have a single owner |
| First Name | The person’s first name. | Yes | |
| Last Name | The person’s last name. | Yes | |
| Middle Name | The person’s middle name. | No | |
| Post Nominal | The person’s name post nominal. | No | |
| Salutation | The person’s salutation. | No | |
| Suffix | The person’s name suffix. | No | |
| Legal Entity Name | The official, registered name of the company stakeholder that appears on legal documents, and used to identify the company legally by the government. | Conditional | Required if Stakeholder Role is Company |
| Ownership Percentage | The approximate ownership of the Acceptor that this owner holds. | Conditional | Required if Stakeholder Role is Owner A percentage, formatted as a decimal. e.g., 5.00% will be formatted as 0.05 |
| Personal Identification Number Type | Type of personal identification number. | Conditional | Required if Stakeholder Role is Owner, Control Person, or Guarantor Set to one of the following selections: ITIN, Passport Number, SSN |
| Personal Identification Number | The personal identification number of the stakeholder. | Conditional | Required if Stakeholder Role is Owner, Control Person, or Guarantor |
| Date of Birth | Birth date of the stakeholder. | Yes | Can’t be in the future |
| Email Address | Email address of the stakeholder. | Yes | Must be in a valid format (ex. test@gmail.com) |
| Telephone Number | Telephone number of the stakeholder. | Yes | Must be in a valid format (ex. 111-222-3333) |
| Address 1 | The first line of the address. | Conditional | Required if Stakeholder Role is Owner, Control Person, or Guarantor A string up to 100 characters. |
| Address 2 | The second line of the address. | No | A string up to 100 characters. |
| Address 3 | The third line of the address. | No | A string up to 100 characters. |
| City | City, town, or village. | Conditional | Required if Stakeholder Role is Owner, Control Person, or Guarantor A string up to 100 characters. |
| State | State or province. | Conditional | Required if Stakeholder Role is Owner, Control Person, or Guarantor US states must be in their 2 character format defined here https://about.usps.com/who/profile/history/state-abbreviations.htm |
| Postal Code | A set of specific numbers, and sometimes letters, that help postal services deliver mail. | Conditional | Required if Stakeholder Role is Owner, Control Person, or Guarantor A string up to 15 characters. |
| Country Code | The ISO 3166-1 three-letter country code associated with the address. | Conditional | Required if Stakeholder Role is Owner, Control Person, or Guarantor USA |
| IP Address | The IP address of the stakeholder. | No |
Billing and funding
| Field Name | Description | Mandatory? | Validation Criteria |
|---|---|---|---|
| Billing Profile ID | Id of the Billing Profile. | Yes | |
| Allocation Overrides | Provides the ability to specify custom fee amounts or rates for specific allocations. | No | |
| Billing Descriptor Name | The billing descriptor name. | Yes | Must be less than 22 characters in length. |
| Billing Descriptor Service Fee Name | The billing descriptor service fee name. | No | |
| Financial Institution Name | Name of the institution where the bank account is held. | Yes | |
| Name on Account | The name on the bank account. | Yes | must be less than or equal to 22 characters in length. Only letters A–Z, a-z, numbers 0–9, space, and &, -, ., / are allowed. |
| Account Owner Type | The type of the account owner. | Yes | Set to one of the possible selections: Consumer, Corporate |
| Bank Account Type | The type of the bank account | Yes | Set to one of the possible selections: Checking, Savings |
| Routing Number | The routing number of the bank account. | Yes | 9 digits |
| Account Number | The bank account number. | Yes | |
| Bank Account Fees Settlements | Defines allocations for the bank account. | Yes | Set to one of the possible selections: Fees Only, Settlement Only, Settlements and Fees |
| Acceptor Cutoff Time | The acceptor’s end-of-day time. | Yes | The LocalTime scalar type is a local time string (i.e., with no associated timezone) in 24-hr HH:mm:ss. |
| Timezone | The time zone of the acceptor, standardized by the Internet Assigned Numbers Authority (IANA). | Yes | Set to one of the possible selections: AMERICA_CHICAGO, AMERICA_DENVER, AMERICA_LOS_ANGELES, AMERICA_NEW_YORK |
Services
| Field Name | Description | Mandatory? | Validation Criteria |
|---|---|---|---|
| Visa Enable | Indicator to enable the service | Yes | When set to true, the partner is instructing Tesouro to enable the service. |
| Mastercard Enable | Indicator to enable the service | Yes | When set to true, the partner is instructing Tesouro to enable the service. |
| American Express OptBlue Enable | Indicator to enable the service | Yes | When set to true, the partner is instructing Tesouro to enable the service. |
| American Express Direct Enable | Indicator to enable the service | Yes | When set to true, the partner is instructing Tesouro to enable the service. |
| Service Establishment Number | The Service Establishment (SE) Number is a unique identifier assigned to the Acceptor for identification within the American Express network. | Conditional | Required when the Amex program is Direct. |
| Discover Acquired Enable | Indicator to enable the service | Yes | When set to true, the partner is instructing Tesouro to enable the service. |
| Discover Retained Enable | Indicator to enable the service | Yes | When set to true, the partner is instructing Tesouro to enable the service. |
| Discover Merchant Number | A unique identifier assigned to the Acceptor for identification within the Discover network. | Conditional | Required when the Discover program is Retained. |
| Bank Transfers Enable | Indicator to enable the service | Yes | When set to true, the partner is instructing Tesouro to enable the service. |
| Account Updater Enable | Indicator to enable the service | Yes | When set to true, the partner is instructing Tesouro to enable the service. |