Applications

The applications object enables Forte partners to create merchant applications and submit them automatically to Forte's Underwriting and decisioning queues. Partners can upload supporting documentation for applications using the documents object.

Applications Object

Parameter

Description

Type

Req

fee_id

The ID of the rate plan, which details the fee values that Forte will charge the merchant. [max length = 6]

string

R

source_ip

The IP Address from which the merchant is applying. [max length = 80]

string

R

annual_volume

The anticipated annual volume of the business. [max length = 10]

double

R

average_transaction_amount

The average transaction amount of the business. NOTE: When testing, use this parameter to test success and fail responses. Passing a value greater than 10,000 in this field will trigger an automatic decline in the test environment. [max length = 5]

double

R

market_type


The method by which the business captures the majority of its transactions. Options for this parameter include the following values:


- internet
- phone
- mail
- point_of_sale

string

R

t_and_c_version

The version of Forte's Terms and Conditions provided to the applying merchant. NOTE: This must match the version associated with the Rate Plan (fee_id).

string

R

t_and_c_time_stamp

The date and/or timestamp when the merchant agreed to Forte's Terms and Conditions. [max length = 20] NOTE: The value of this field can be up to one full day in the future. The following formats are supported:


- YYY/MM/DD, MMDDYYYY
- YYYY-MM-            DDTHH:MM:SSZ, YYYYMM-DDTHH:MM:SS

datetime

R

risk_session_id


A random unique code that partners generate on their client form and include in the API request call prior to sending the application (e.g., s3AH5fDIdXjI7y1disbZChw8Qrgl6Bz7uKZLjRrgNhYmu
WApi2FhdhB5wW4MgqknPHx1WR7s4RX1vWs).

The value of the risk_session_id parameter can be up to 128 characters long and can only consist of the following characters:


- Upper and lowercase English letters (a–z or A–Z)
- Digits (0–9)
- Underscore or hyphen (_ or -)



The script that generates the risk_session_id value must be embedded on a page where the user will be for five or more seconds. For profiling to properly occur, the session must run on the applicant's browser for a minimum of five seconds. Additionally, the applicant's browser or front-end software must have javascript enabled. See the note below. [max length = 128bytes]

string

R

maximum_transaction_amount

The maximum allowable amount for a credit card or ACH transaction.

double

O

average_payable_amount

The average amount the merchant disburses in credit transactions (e.g., refunds, payroll, commissions, etc). NOTE: If either the average_payable_amount,maximum_payable_amount, or the monthly_payable_volume parameters are passed, all three parameters become required.

double

C

maximum_payable_amount

The maximum amount the merchant would disburse in a credit transaction (e.g., refunds, payroll, commissions, etc.). NOTE: If either the average_payable_amount,maximum_payable_amount, or the monthly_payable_volume parameters are passed, all three parameters become required.

double

C

monthly_payable_volume

An estimate of the amount the merchant disburses in credit transactions each month (e.g., refunds, payroll, commissions, etc). NOTE: If either the average_payable_amount,maximum_payable_amount, or the monthly_payable_volume parameters are passed, all three parameters become required.

double

C

received_date

The date and time when the application was received.

datetime

--

updated_date

The date and time when the application was last updated.

datetime

--

sales_rep

The name or ID of the sales representative associated with this application.

string

--

location_id

The merchant's location ID that Forte created after enrolling the applicant.

string

--

status


The status of the application. Supported values include the following:


approved - Forte has approved the application and sent the merchant's data to the enrollment queue.
pending - Forte's Credit and Risk Team needs to review the application and may request additional documentation from the merchant.
declined - The application failed one or more automated underwriting checks and Forte has declined to move forward with the merchant. The reason for the decline displays in the decline_reason field.

• enrolled - Merchant has completed enrollment and is ready to process transactions.

• rejected - Forte is unable to verify the identity data of an application or cannot authenticate the banking data or signatures. The reason for the rejected status displays in the rejected_reason dield.

• recalled - The applicant has stopped responding to requests for information from Forte or the Partner. The reason for the recalled status displays in the recalled_reason field.


decline_reason field.

enrrolled -

string

--

decline_reason

The reason for a declined status. Supported values include the following:


- credit_locked
- ssn_mismatch
- tincheck_failure
- identity
- type_of_business
- credit
- reputation

string

--

applicant_organization

The Applicant Organization Object.

object

R

applicant_organization.legal_name

The legal name of the business. The value of this parameter must match the name associated with the merchant's Tax ID Number. [max length = 50].

string

R

applicant_organization.tax_id_number

The Tax ID Number of the business (e.g., TIN, EIN, SSN, etc.). The following formats are supported [max length = 30]:


SSN = XXXXXXXXX, XXX-XX-XXXX
ITIN = 9XXXXXXXX, 9XX-XX-XXXX
EIN = XXXXXXXXX, XX-XXXXXXX

string

R

applicant_organization.legal_structure


The ownership type of the business. Options for this parameter include the following values:


- c_corporation
- government
-  limited_liability_corporation
partnership_general_or_limited
- publicly_held_corporation
- s_corporation
- sole_proprietorship
- tax_exempt_or_non_profit_organization

string

R

applicant_organization.dba_name

The name of the business as it will appear on your customer's statements. The default value for this parameter is the DBA (Doing Business As) Name. [max length = 50].

string

R

applicant_organization.organization_id

The merchant organization ID that Forte created after enrolling the applicant.

string

--

applicant_organization.street_address1

The physical address of the business. This parameter cannot contain P.O. boxes, including paid mailbox services provided by companies like the UPS Store. [max length = 50]

string

R

applicant_organization.locality

The city where the business is located. [max length = 50]

string

R

applicant_organization.region

The state or province where the business is located. [max length = 2]

string

R

applicant_organization.postal_code


The zip/postal code of the business. The following formats are supported [max length = 15]:


XXXXX
XXXXX-XXXX

string

R

applicant_organization.customer_service_phone

The customer service phone number of the business. [max length = 12]

string

R

applicant_organization.website

The website of the business. The value of this parameter must be in www.yourcompanysite.com format. The www prefix is required. Slashes and underscore punctuation are allowed in the URL. [max length = 100]

string

R

applicant_organization.business_type

The type of business. See Forte's list of Business Classification Codes. [max length = 50]

string

R

applicant_organization.bank_account_type


The type of bank account. This bank account can only be a business checking or business savings account; it cannot be the applicant's personal checking or personal savings account. The following values are supported:


- checking
- savings

string

O

applicant_organization.bank_routing_number

The transit routing number (TRN) of the merchant's bank. This field supports both U.S. and Canadian routing numbers. NOTE: A Canadian routing number displayed on a check needs to be reformatted differently for electronic payments. If a check displays a routing number as BBBBB-AAA (where AAA indicates the Financial Institution and BBBBB is the branch), then the routing number must be changed to 0AAABBBBB to process the payment electronically. For example, if a check from an account issued by the Bank of Montreal showed the routing number 00011-001, then that number would need to be reformatted to 000100011 for the payment to be electronically processed. Click here for a directory of Canadian financial institutions. This field is required when creating or updating a new record and can only contain digits. [max length = 9].

string

R

applicant_organization.bank_account_number

The account number (i.e., DDA) of the applicant's business bank account. The value of this parameter can only contain digits. [max length = 17]

string

R

owner

The primary owner object. All applications must include at least one primary owner. This owner must be the controller of the business.

object

R

owner.percentage


Indicates the percentage of the business owned by the primary owner (i.e., maximum ownership percentage = 100). NOTES:


- The sum of owner.percentage, owner_2.percentage, owner_3.percentage, and owner_4.percentage cannot be greater than 100.
- This field is NOT required for the following legal structures:

  -  government
  -  sole_proprietorship
 - publicly_held_corporation

double

R

owner.title


The primary owner’s official title at the company. Supported values include the following:


ceo
cfo
coo
managing_member
general_partner
president
vice_president
treasurer
other

string

R

owner.first_name

The first name of the account owner. [max length = 50]

string

R

owner.last_name

The last name of the account owner. [max length = 50]

string

R

owner.street_address1

The home address of the account owner. [max length = 50]

string

R

owner.locality

The city of the account owner's home address. [max length = 50]

string

R

owner.region

The state or province of the account owner's home address. [max length = 2]

string

R

owner.postal_code

The zip/postal code of the account owner's home address. [max length = 15]

string

R

owner.country



The country code of the account owner's home address NOTE: This field is NOT required for the following legal structures:


government
sole_proprietorship
publicly_held_corporation



[max length = 3]

string

R

owner.citizenship



The country code of the account owner's country of citizenship. NOTE: This field is NOT required for the following legal structures:


government
sole_proprietorship
publicly_held_corporation



[max length=3]

string

R

owner.email_address

The business email of the account owner. This email address cannot be a generic email address or a distribution list. The value of this parameter must be in a valid email format (e.g., john.doe@email.com). [max length = 100]

string

R

owner.mobile_phone

The cell phone number of the account owner. The value of this parameter can be up to 15 characters (with country code).

string

R

owner.last4_ssn

The last four digits of the account owner's Social Security Number (SSN). [max length = 4]

string

R

owner.date_of_birth

The birth date of the account owner in YYYY/MM/DD format. [max length = 10]

date

R

owner_2

The secondary owner object.NOTE: This object is only required for American merchants with additional owner(s) who own at least 25% of the business. Addtionally, do not pass this object for merchants set up in the following legal structures:


government
sole_proprietorship
publicly_held_corporation

object

C

owner_2.percentage

Indicates the percentage of the business owned by the secondary owner. This value must be 25 or greater.

double

C

owner_2.first_name

The first name of the account owner. [max length = 50]

string

C

owner_2.last_name

The last name of the account owner. [max length = 50]

string

C

owner_2.street_address1

The home address of the account owner. [max length = 50]

string

C

owner_2.locality

The city of the account owner's home address. [max length = 50]

string

C

owner_2.region

The state or province of the account owner's home address. [max length = 2]

string

C

owner_2.postal_code

The zip/postal code of the account owner's home address. [max length = 15]

string

C

owner_2.country

The country code of the account owner's home address. [max length=3]

string

C

owner_2.citizenship

The country code of the account owner's country of citizenship. [max length=3]

string

C

owner_2.email_address

The business email of the account owner. This email address cannot be a generic email address or a distribution list. The value of this parameter must be in a valid email format (e.g., john.doe@email.com). [max length = 100]

string

C

owner_2.mobile_phone

The cell phone number of the account owner. The value of this parameter can be up to 15 characters (with country code).

string

C

owner_2.last4_ssn

The last four digits of the account owner's Social Security Number (SSN). [max length = 4]

string

C

owner_2.date_of_birth

The birth date of the account owner in YYYY/MM/DD format. [max length = 10]

date

C

owner_3


The tertiary owner object. NOTE: This object is only required for American merchants with additional owner(s) who own at least 25% of the business. Addtionally, do not pass this object for merchants set up in the following legal structures:


government
sole_proprietorship
publicly_held_corporation

object

C

owner_3.percentage

Indicates the percentage of the business owned by the tertiary owner. This value must be 25 or greater.

double

C

owner_3.first_name

The first name of the account owner. [max length = 50]

string

C

owner_3.last_name

The last name of the account owner. [max length = 50]

string

C

owner_3.street_address1

The home address of the account owner. [max length = 50]

string

C

owner_3.locality

The city of the account owner's home address. [max length = 50]

string

C

owner_3.region

The state or province of the account owner's home address. [max length = 2]

string

C

owner_3.postal_code

The zip/postal code of the account owner's home address. [max length = 15]

string

C

owner_3.country

The country code of the account owner's home address. [max length=3]

string

C

owner_3.citizenship

The country code of the account owner's country of citizenship. [max length=3]

string

C

owner_3.email_address

The business email of the account owner. This email address cannot be a generic email address or a distribution list. The value of this parameter must be in a valid email format (e.g., john.doe@email.com). [max length = 100]

string

C

owner_3.mobile_phone

The cell phone number of the account owner. The value of this parameter can be up to 15 characters (with country code).

string

C

owner_3.last4_ssn

The last four digits of the account owner's Social Security Number (SSN). [max length = 4]

string

C

owner_3.date_of_birth

The birth date of the account owner in YYYY/MM/DD format. [max length = 10]

date

C

owner_4


The quaternary owner object. NOTE: This object is only required for American merchants with additional owner(s) who own at least 25% of the business. Addtionally, do not pass this object for merchants set up in the following legal structures:


government
sole_proprietorship
publicly_held_corporation

object

C

owner_4.percentage

Indicates the percentage of the business owned by the quaternary owner. This value must be 25 or greater.

double

C

owner_4.first_name

The first name of the account owner. [max length = 50]

string

C

owner_4.last_name

The last name of the account owner. [max length = 50]

string

C

owner_4.street_address1

The home address of the account owner. [max length = 50]

string

C

owner_4.locality

The city of the account owner's home address. [max length = 50]

string

C

owner_4.region

The state or province of the account owner's home address. [max length = 2]

string

C

owner_4.postal_code

The zip/postal code of the account owner's home address. [max length = 15]

string

C

owner_4.country

The country code of the account owner's home address. [max length=3]

string

C

owner_4.citizenship

The country code of the account owner's country of citizenship. [max length=3]

string

C

owner_4.email_address

The business email of the account owner. This email address cannot be a generic email address or a distribution list. The value of this parameter must be in a valid email format (e.g., john.doe@email.com). [max length = 100]

string

C

owner_4.mobile_phone

The cell phone number of the account owner. The value of this parameter can be up to 15 characters (with country code).

string

C

owner_4.last4_ssn

The last four digits of the account owner's Social Security Number (SSN). [max length = 4]

string

C

owner_4.date_of_birth

The birth date of the account owner in YYYY/MM/DD format. [max length = 10]

date

C

gateway

The gateway object. Use for gateway-only merchant applications.

object

C

gateway.provider

The processor the gateway-only merchant will use. Supported options include the following:


vantiv
global
vital
firstdata
Elavon
Chase

string

C

gateway.bank_id_number

The banking ID associated with Vantiv, Global, or Vital merchants.

string

C

gateway.merchant_id

The merchant ID associated with Vantiv, Global, or FirstData merchants.

string

C

gateway.terminal_id

The terminal ID associated with Global, Vital, or FirstData merchants.

string

C

gateway.agent

The Agent number associated with Vital merchants.

string

C

gateway.chain

The Chain number associated with Vantiv or Vital merchants.

string

C

gateway.store

The Store number associated with Vantiv or Vital merchants.

string

C

gateway.terminal

The Terminal number associated with Vital merchants.

string

C

NOTE: The following PHP code sample uses the uniqid() function to generate the risk_session_id value:

				
					<html>
<body>
echo $a;
?>
<script data-minify="1" type="text/javascript" src="https://developers.forte.net/wp-content/cache/min/1/fp/tags.js?ver=1730215204" data-rocket-defer defer>
</script>
<noscript>
<iframe style="width: 100px; height: 100px; border: 0;position: absolute; top: -5000px;" src="https://img3.forte.net/tags?org_id=xdzpgyj7&session_id=<?php echo $a;?>&pageid=1">
</iframe>
</noscript>
<script>class RocketElementorAnimation{constructor(){this.deviceMode=document.createElement("span"),this.deviceMode.id="elementor-device-mode-wpr",this.deviceMode.setAttribute("class","elementor-screen-only"),document.body.appendChild(this.deviceMode)}_detectAnimations(){let t=getComputedStyle(this.deviceMode,":after").content.replace(/"/g,"");this.animationSettingKeys=this._listAnimationSettingsKeys(t),document.querySelectorAll(".elementor-invisible[data-settings]").forEach(t=>{const e=t.getBoundingClientRect();if(e.bottom>=0&&e.top<=window.innerHeight)try{this._animateElement(t)}catch(t){}})}_animateElement(t){const e=JSON.parse(t.dataset.settings),i=e._animation_delay||e.animation_delay||0,n=e[this.animationSettingKeys.find(t=>e[t])];if("none"===n)return void t.classList.remove("elementor-invisible");t.classList.remove(n),this.currentAnimation&&t.classList.remove(this.currentAnimation),this.currentAnimation=n;let s=setTimeout(()=>{t.classList.remove("elementor-invisible"),t.classList.add("animated",n),this._removeAnimationSettings(t,e)},i);window.addEventListener("rocket-startLoading",function(){clearTimeout(s)})}_listAnimationSettingsKeys(t="mobile"){const e=[""];switch(t){case"mobile":e.unshift("_mobile");case"tablet":e.unshift("_tablet");case"desktop":e.unshift("_desktop")}const i=[];return["animation","_animation"].forEach(t=>{e.forEach(e=>{i.push(t+e)})}),i}_removeAnimationSettings(t,e){this._listAnimationSettingsKeys().forEach(t=>delete e[t]),t.dataset.settings=JSON.stringify(e)}static run(){const t=new RocketElementorAnimation;requestAnimationFrame(t._detectAnimations.bind(t))}}document.addEventListener("DOMContentLoaded",RocketElementorAnimation.run);</script></body>
</html>

To add this parameter to the applications object, complete the following steps:

STEP 1: Generate a unique risk_session_id code that fulfills the formatting requirements described above by using the PHP code sample provided or an alternative method.

STEP 2: Add the generated value to the following script (i.e., in place of UNIQUE_SESSION_ID). This script can be executed only once by the applicant’s browser.

				
					<script data-minify="1" type="text/javascript" src="https://developers.forte.net/wp-content/cache/min/1/fp/tags.js?ver=1730215204" data-rocket-defer defer> 
</script> 
<noscript> 
<iframe style="width: 100px; height: 100px; border: 0;position: absolute; top: -5000px;" src="https://img3.forte.net/tags?org_id=xdzpgyj7&session_id=UNIQUE_SESSION_ID&pageid=1">
</iframe> 
</noscript>

STEP 3: When generating the applications POST request, assign the unique code value created in step 1 to the risk_session_id parameter.

STEP 4: Submit the application.

POST Application

				
					{{baseURI}}/organizations/org_{{organizationID}}/applications/

This URI creates the merchant application, routes the information to Forte’s Underwriting and decisioning queues, and returns one of the following status codes:

  • approved

  • pending

  • declined

  • enrolled

  • rejected

  • recalled

NOTE: The organization_id referenced in this URI must be the home_organization_id of the Partner.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}
 
Bodyraw
				
					{
       "fee_id": 1648,
       "source_ip":"55.5.55.555",
       "annual_volume":"100000", 
       "average_transaction_amount": "10000",
       "maximum_transaction_amount":"5000",
       "average_payable_amount":"2500",
       "maximum_payable_amount":"10000",
       "monthly_payable_volume":"1000",
       "market_type":"internet",
       "t_and_c_version" : "Tc1",
       "t_and_c_time_stamp": "4/3/2016",
       "risk_session_id":"s3AH5fDIdXjI7y1disbZChw8Qrgl6Bz7uKZLjRrgNhYmuWApi2FhdhB5wW4MgqknPHx1WR7s4RX1vWs",
       "applicant_organization": {
          "legal_name":"George McFly Enterprises",
          "tax_id_number":"123456789",
          "legal_structure":"partnership_general_or_limited",
          "dba_name":"GMF Enterprises",
          "street_address1":"503 DeLorean Way",
          "locality":"Hill Valley",
          "region":"CA",
          "postal_code":"95420-4344",
          "customer_service_phone":"5555236987",
          "website":"www.GMFEnterprises.com",
          "business_type":"A10100",
          "bank_routing_number":"211170101",
          "bank_account_number":"121245611",
          "bank_account_type":"checking"
       },
       "owner": {
          "first_name":"George",
          "last_name":"McFly",
          "title:"ceo",
          "street_address1":"49 Great Scott! Drive",
          "locality":"Hill Valley", 
          "region":"CA",
          "postal_code":"95420-4345",
          "country": "USA",
          "citizenship": "USA",
          "email_address":"george.mcfly@GMFEnterprises.com",
          "mobile_phone":"214-448-5393",
          "last4_ssn":"6789",
          "date_of_birth":"3/3/1938",
          "percentage":"40"
       },
       "owner_2": {
          "first_name":"Marty",
          "last_name":"McFly",
          "street_address1":"52 Great Scott! Drive",
          "locality":"Hill Valley", 
          "region":"CA",
          "postal_code":"95420-4345",
          "country": "USA",
          "citizenship": "USA",
          "email_address":"martin.mcfly@GMFEnterprises.com",
          "mobile_phone":"972-712-3019",
          "last4_ssn":"5896",
          "date_of_birth":"11/3/1969",
          "percentage":"30"
       },
       "owner_3": {
          "first_name":"Jennifer",
          "last_name":"McFly",
          "street_address1":"54 Great Scott! Drive",
          "locality":"Hill Valley", 
          "region":"CA",
          "postal_code":"95420-4345",
          "country": "USA",
          "citizenship": "USA",
          "email_address":"j.mcfly@GMFEnterprises.com",
          "mobile_phone":"469-222-0608",
          "last4_ssn":"4455",
          "date_of_birth":"8/31/1969",
          "percentage":"30"
       }
}

Example Request

				
					curl --location -g '{{baseURI}}/v3/organizations/org_{{organizationID}}/applications/' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
       "fee_id": 1648,
       "source_ip":"55.5.55.555",
       "annual_volume":"100000", 
       "average_transaction_amount": "10000",
       "maximum_transaction_amount":"5000",
       "average_payable_amount":"2500",
       "maximum_payable_amount":"10000",
       "monthly_payable_volume":"1000",
       "market_type":"internet",
       "t_and_c_version" : "Tc1",
       "t_and_c_time_stamp": "4/3/2016",
       "risk_session_id":"s3AH5fDIdXjI7y1disbZChw8Qrgl6Bz7uKZLjRrgNhYmuWApi2FhdhB5wW4MgqknPHx1WR7s4RX1vWs",
       "applicant_organization": {
          "legal_name":"George McFly Enterprises",
          "tax_id_number":"123456789",
          "legal_structure":"partnership_general_or_limited",
          "dba_name":"GMF Enterprises",
          "street_address1":"503 DeLorean Way",
          "locality":"Hill Valley",
          "region":"CA",
          "postal_code":"95420-4344",
          "customer_service_phone":"5555236987",
          "website":"www.GMFEnterprises.com",
          "business_type":"A10100",
          "bank_routing_number":"211170101",
          "bank_account_number":"121245611",
          "bank_account_type":"checking"
       },
       "owner": {
          "first_name":"George",
          "last_name":"McFly",
          "title":"ceo",
          "street_address1":"49 Great Scott! Drive",
          "locality":"Hill Valley", 
          "region":"CA",
          "postal_code":"95420-4345",
          "country": "USA",
          "citizenship": "USA",
          "email_address":"george.mcfly@GMFEnterprises.com",
          "mobile_phone":"214-448-5393",
          "last4_ssn":"6789",
          "date_of_birth":"3/3/1938",
          "percentage":"40"
       },
       "owner_2": {
          "first_name":"Marty",
          "last_name":"McFly",
          "street_address1":"52 Great Scott! Drive",
          "locality":"Hill Valley", 
          "region":"CA",
          "postal_code":"95420-4345",
          "country": "USA",
          "citizenship": "USA",
          "email_address":"martin.mcfly@GMFEnterprises.com",
          "mobile_phone":"972-712-3019",
          "last4_ssn":"5896",
          "date_of_birth":"11/3/1969",
          "percentage":"30"
       },
       "owner_3": {
          "first_name":"Jennifer",
          "last_name":"McFly",
          "street_address1":"54 Great Scott! Drive",
          "locality":"Hill Valley", 
          "region":"CA",
          "postal_code":"95420-4345",
          "country": "USA",
          "citizenship": "USA",
          "email_address":"j.mcfly@GMFEnterprises.com",
          "mobile_phone":"469-222-0608",
          "last4_ssn":"4455",
          "date_of_birth":"8/31/1969",
          "percentage":"30"
       }
}   '

Example Response

Edit Content 
				
					{
  "authorization_amount": 102.45,
  "order_number": "ORD123",
  "vendor": {
    "vendor_type": "paypal",
    "vendor_approval_url": "https://www.sandbox.paypal.com/checkoutnow?token=4FY371515P9080118",
    "vendor_account_email": "it@pp3.com",
    "vendor_order_number": "4FY371515P9080118",
    "vendor_order_status": "PAYER_ACTION_REQUIRED"
  },
  "shipping_address": {
    "first_name": "Emmett",
    "last_name": "Brown",
    "physical_address": {
      "street_line1": "SA Line 1",
      "street_line2": "SA Line 2",
      "locality": "Allen",
      "region": "TX",
      "postal_code": "560018",
      "country": "US"
    }
  },
  "response": {
    "environment": "live",
    "response_desc": "Create Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/organizations/org_334316/locations/loc_192642/vendors/ven_2TXS88UYGN8LE/orders/4FY371515P9080118"
  }
}
Edit Content
Headers (1)
Content-Type
 

application/json

POST Gateway-Only Application

				
					{{baseURI}}/organizations/org_{{organizationID}}/applications/

This URI creates an application for gateway-only merchants and places it into an approved status.

NOTE: The organization_id referenced in this URI must be the home_organization_id of the Partner.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}
 
Bodyraw
				
					{
       "fee_id": 1648,
       "source_ip":"55.5.55.555",
       "annual_volume":"100000", 
       "average_transaction_amount": "10000",
       "maximum_transaction_amount":"5000",
       "average_payable_amount":"2500",
       "maximum_payable_amount":"10000",
       "monthly_payable_volume":"1000",
       "market_type":"internet",
       "t_and_c_version" : "Tc1",
       "t_and_c_time_stamp": "4/3/2016",
       "risk_session_id":"s%3AH5fDIdXjI7y1disbZChw8Qrgl6Bz7uKZ.LjRrgNhYmuWApi%2FhdhB5wW4MgqknPHx1WR7s4RX1vWs",
       "applicant_organization": {
          "legal_name":"George McFly Enterprises",
          "tax_id_number":"123456789",
          "legal_structure":"partnership_general_or_limited",
          "dba_name":"GMF Enterprises",
          "street_address1":"503 DeLorean Way",
          "locality":"Hill Valley",
          "region":"CA",
          "postal_code":"95420-4344",
          "customer_service_phone":"5555236987",
          "website":"www.GMFEnterprises.com",
          "business_type":"A10100",
          "bank_routing_number":"211170101",
          "bank_account_number":"121245611",
          "bank_account_type":"checking"
       },
       "owner": {
          "first_name":"George",
          "last_name":"McFly",
          "street_address1":"49 Great Scott! Drive",
          "locality":"Hill Valley", 
          "region":"CA",
          "postal_code":"95420-4345",
          "country": "USA",
          "citizenship": "USA",
          "email_address":"george.mcfly@GMFEnterprises.com",
          "mobile_phone":"214-448-5393",
          "last4_ssn":"6789",
          "date_of_birth":"3/3/1938",
          "percentage":"40"
       },
       "owner_2": {
          "first_name":"Marty",
          "last_name":"McFly",
          "street_address1":"52 Great Scott! Drive",
          "locality":"Hill Valley", 
          "region":"CA",
          "postal_code":"95420-4345",
          "country": "USA",
          "citizenship": "USA",
          "email_address":"martin.mcfly@GMFEnterprises.com",
          "mobile_phone":"972-712-3019",
          "last4_ssn":"5896",
          "date_of_birth":"11/3/1969",
          "percentage":"30"
       },
       "owner_3": {
          "first_name":"Jennifer",
          "last_name":"McFly",
          "street_address1":"54 Great Scott! Drive",
          "locality":"Hill Valley", 
          "region":"CA",
          "postal_code":"95420-4345",
          "country": "USA",
          "citizenship": "USA",
          "email_address":"j.mcfly@GMFEnterprises.com",
          "mobile_phone":"469-222-0608",
          "last4_ssn":"4455",
          "date_of_birth":"8/31/1969",
          "percentage":"30"
       },
       "gateway": {
    	  "provider": "firstdata",
    	  "bank_id_number": "",
    	  "merchant_id": "987456321",
    	  "terminal_id": "123456789",
    	  "agent": "",
    	  "chain": "",
    	  "store": "",
    	  "terminal": ""
    	}
}

Example Request

				
					curl --location -g '{{baseURI}}/v3/organizations/org_{{organizationID}}/applications/' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
       "fee_id": 1648,
       "source_ip":"55.5.55.555",
       "annual_volume":"100000", 
       "average_transaction_amount": "10000",
       "maximum_transaction_amount":"5000",
       "average_payable_amount":"2500",
       "maximum_payable_amount":"10000",
       "monthly_payable_volume":"1000",
       "market_type":"internet",
       "t_and_c_version" : "Tc1",
       "t_and_c_time_stamp": "4/3/2016",
       "risk_session_id":"s%3AH5fDIdXjI7y1disbZChw8Qrgl6Bz7uKZ.LjRrgNhYmuWApi%2FhdhB5wW4MgqknPHx1WR7s4RX1vWs",
       "applicant_organization": {
          "legal_name":"George McFly Enterprises",
          "tax_id_number":"123456789",
          "legal_structure":"partnership_general_or_limited",
          "dba_name":"GMF Enterprises",
          "street_address1":"503 DeLorean Way",
          "locality":"Hill Valley",
          "region":"CA",
          "postal_code":"95420-4344",
          "customer_service_phone":"5555236987",
          "website":"www.GMFEnterprises.com",
          "business_type":"A10100",
          "bank_routing_number":"211170101",
          "bank_account_number":"121245611",
          "bank_account_type":"checking"
       },
       "owner": {
          "first_name":"George",
          "last_name":"McFly",
          "street_address1":"49 Great Scott! Drive",
          "locality":"Hill Valley", 
          "region":"CA",
          "postal_code":"95420-4345",
          "country": "USA",
          "citizenship": "USA",
          "email_address":"george.mcfly@GMFEnterprises.com",
          "mobile_phone":"214-448-5393",
          "last4_ssn":"6789",
          "date_of_birth":"3/3/1938",
          "percentage":"40"
       },
       "owner_2": {
          "first_name":"Marty",
          "last_name":"McFly",
          "street_address1":"52 Great Scott! Drive",
          "locality":"Hill Valley", 
          "region":"CA",
          "postal_code":"95420-4345",
          "country": "USA",
          "citizenship": "USA",
          "email_address":"martin.mcfly@GMFEnterprises.com",
          "mobile_phone":"972-712-3019",
          "last4_ssn":"5896",
          "date_of_birth":"11/3/1969",
          "percentage":"30"
       },
       "owner_3": {
          "first_name":"Jennifer",
          "last_name":"McFly",
          "street_address1":"54 Great Scott! Drive",
          "locality":"Hill Valley", 
          "region":"CA",
          "postal_code":"95420-4345",
          "country": "USA",
          "citizenship": "USA",
          "email_address":"j.mcfly@GMFEnterprises.com",
          "mobile_phone":"469-222-0608",
          "last4_ssn":"4455",
          "date_of_birth":"8/31/1969",
          "percentage":"30"
       }
}   '

Example Response

Edit Content 
				
					{
  "application_id": "app_133180",
  "fee_id": "1648",
  "status": "pending",
  "annual_volume": 100000,
  "average_transaction_amount": 10000,
  "maximum_transaction_amount": 5000,
  "monthly_payable_volume": 1000,
  "average_payable_amount": 2500,
  "maximum_payable_amount": 10000,
  "source_ip": "55.5.55.555",
  "t_and_c_version": "Tc1",
  "t_and_c_time_stamp": "2016-04-03T00:00:00",
  "market_type": "internet",
  "risk_session_id": "s%3AH5fDIdXjI7y1disbZChw8Qrgl6Bz7uKZ.LjRrgNhYmuWApi%2FhdhB5wW4MgqknPHx1WR7s4RX1vWs",
  "applicant_organization": {
    "dba_name": "GMF Enterprises",
    "legal_name": "George McFly Enterprises",
    "street_address1": "503 DeLorean Way",
    "locality": "Hill Valley",
    "region": "CA",
    "postal_code": "95420-4344",
    "country": "US",
    "website": "www.GMFEnterprises.com",
    "customer_service_phone": "555-523-6987",
    "legal_structure": "partnership_general_or_limited",
    "business_type": "A10100",
    "bank_routing_number": "211170101",
    "bank_account_type": "checking"
  },
  "owner": {
    "first_name": "George",
    "last_name": "McFly",
    "last4_ssn": "6789",
    "date_of_birth": "1938-03-03T00:00:00",
    "email_address": "george.mcfly@GMFEnterprises.com",
    "mobile_phone": "214-448-5393",
    "street_address1": "49 Great Scott! Drive",
    "locality": "Hill Valley",
    "region": "CA",
    "postal_code": "95420-4345",
    "country": "USA",
    "citizenship": "US",
    "percentage": 40
  },
  "owner_2": {
    "first_name": "Marty",
    "last_name": "McFly",
    "last4_ssn": "5896",
    "date_of_birth": "1969-11-03T00:00:00",
    "email_address": "martin.mcfly@GMFEnterprises.com",
    "mobile_phone": "972-712-3019",
    "street_address1": "52 Great Scott! Drive",
    "locality": "Hill Valley",
    "region": "CA",
    "postal_code": "95420-4345",
    "country": "US",
    "citizenship": "US",
    "percentage": 30
  },
  "owner_3": {
    "first_name": "Jennifer",
    "last_name": "McFly",
    "last4_ssn": "4455",
    "date_of_birth": "1969-08-31T00:00:00",
    "email_address": "j.mcfly@GMFEnterprises.com",
    "mobile_phone": "469-222-0608",
    "street_address1": "54 Great Scott! Drive",
    "locality": "Hill Valley",
    "region": "CA",
    "postal_code": "95420-4345",
    "country": "US",
    "citizenship": "US",
    "percentage": 30
  },
  "gateway": {
    "provider": "firstdata",
    "bank_id_number": "",
    "merchant_id": "987456321",
    "terminal_id": "123456789",
    "agent": "",
    "chain": "",
    "store": "",
    "terminal": ""
  },
  "response": {
    "environment": "live",
    "response_desc": "Application submitted is pending review."
  },
  "links": {
    "documents": "https://api-live-testlan.4ta.com/v3/applications/app_133180/documents",
    "self": "https://api-live-testlan.4ta.com/v3/applications/app_133180"
  }
}
Edit Content
Headers (13)
Cache-Control

no-cache Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds

Connection

keep-alive Options that are desired for the connection
Content-Length

2231 The length of the response body in octets (8-bit bytes)

 

content-type

application/json; charset=utf-8 The mime type of this content

date

Wed, 08 Aug 2018 16:51:28 GMT The date and time that the message was sent

expires

-1 Gives the date/time after which the response is considered stale

pragma

no-cache Implementation-specific headers that may have various effects anywhere along the request-response chain.

server

A name for the server

GET All Applications for an Organization

				
					{{baseURI}}/organizations/org_{{organizationID}}/applications?filter=start_received_date+eq+'2017-01-01'+and+end_received_date+eq+'2017-06-30'

This URI returns all applications submitted by the partner organization, including their current status. Supported statuses include the following:

  • `approved` – Forte has approved the application and sent the merchant’s data to the enrollment queue.

  • `pending` – Forte’s Credit and Risk Team needs to review the application and may request additional documentation from the merchant.

  • `declined` – The application failed one or more automated underwriting checks and Forte has declined to move forward with the merchant. The reason for the decline displays in the `decline_reason` field.

  • `enrolled` – Merchant has completed enrollment and is ready to process transactions.

  • `rejected` – Forte is unable to verify the identity data of an application or cannot authenticate the banking data or signatures. The reason for the rejected status displays in the reject_reason field.

  • `recalled` – The applicant has stopped responding to requests for information from Forte or the Partner. The reason for the recalled status displays in the recalled_reason field.

To narrow your search data using specific criteria, use the following filter parameters:

  • start_updated_date / end_updated_date

  • start_received_date / end_received_date

  • status

NOTES: The organization_id referenced in this URI must be the home_organization_id of the partner.

Please note that sending a request at the partner (org) level may result in a large data set and may cause timeout errors depending on the request. We recommend sending your GET request at the Merchant (Organization) level.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}
 
PARAMS
 
filter                   start_received_date+eq+’2017-01-01’+and+end_received_date+eq+’2017-06-30′

Example Request

				
					curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/applications?filter=start_received_date%2Beq%2B%272017-01-01%27%2Band%2Bend_received_date%2Beq%2B%272017-06-30%27' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'

Example Response

Edit Content 
				
					{
  "number_results": 2,
  "search_criteria": {
    "page_size": 50,
    "page_index": 0,
    "home_organization_id": "org_334316",
    "resource_specific": {
      "start_received_date": "2017-01-01T00:00:00",
      "end_received_date": "2017-06-30T00:00:00"
    }
  },
  "results": [
    {
      "application_id": "app_111234",
      "location_id": "loc_123000",
      "status": "declined",
      "decline_reason": "reputation",
      "fee_id": "8258",
      "source_ip": "55.5.55.555",
      "annual_volume": 100000,
      "average_transaction_amount": 10000,
      "average_payable_amount": 1000,
      "maximum_payable_amount": 6000,
      "monthly_payable_volume": 600,
      "market_type": "internet",
      "t_and_c_version": "Tc1",
      "t_and_c_time_stamp": "2/3/2017",
      "risk_session_id": "s%3AH5fDIdXjI7y1disbZChw8Qrgl6Bz7uKZ.LjRrgNhYmuWApi%2FhdhB5wW4MgqknPHx1WR7s4RX1vWs",
      "applicant_organization": {
        "organization_id": "org_123456",
        "legal_name": "Biff Tannen Innovations",
        "legal_structure": "sole_proprietorship",
        "dba_name": "BTI",
        "street_address1": "503 DeLorean Way",
        "locality": "Hill Valley",
        "region": "CA",
        "postal_code": "95420-4344",
        "customer_service_phone": "5555236987",
        "website": "www.BTInnovations.com",
        "business_type": "A10100",
        "bank_routing_number": "211170101",
        "bank_account_type": "checking"
      },
      "received_date": "2017-02-03T09:22:34.63",
      "updated_date:": "2017-02-05T03:14:43.72",
      "sales_rep": "JohnnyBGoode",
      "fee_plan": "gold",
      "owner": {
        "first_name": "Biff",
        "last_name": "Tannen",
        "street_address1": "49 Great Scott! Drive",
        "locality": "Hill Valley",
        "region": "CA",
        "postal_code": "95420-4345",
        "country": "USA",
        "citizenship": "USA",
        "email_address": "b.tannen@BTInnovations.com",
        "mobile_phone": "5555698965",
        "date_of_birth": "3/3/1968",
        "percentage": 100
      },
      "links": {
        "documents": "https://api.forte.net/v3/applications/app_111234/documents",
        "self": "https://api.forte.net/v3/applications/app_111234"
      }
    },
    {
      "application_id": "app_998877",
      "location_id": "loc_456789",
      "status": "approved",
      "fee_id": "14081",
      "source_ip": "55.5.55.555",
      "annual_volume": 100000,
      "average_transaction_amount": 10000,
      "average_payable_amount": 2500,
      "maximum_payable_amount": 10000,
      "monthly_payable_volume": 1000,
      "market_type": "internet",
      "t_and_c_version": "Tc1",
      "t_and_c_time_stamp": "5/25/2017",
      "risk_session_id": "s%3AH5fDIdXjI7y1disbZChw8Qrgl6Bz7uKZ.LjRrgNhYmuWApi%2FhdhB5wW4MgqknPHx1WR7s4RX1vWs",
      "applicant_organization": {
        "organization_id": "org_987654",
        "legal_name": "George McFly Enterprises",
        "legal_structure": "sole_proprietorship",
        "dba_name": "GMF Enterprises",
        "street_address1": "503 DeLorean Way",
        "locality": "Hill Valley",
        "region": "CA",
        "postal_code": "95420-4344",
        "customer_service_phone": "5555236987",
        "website": "www.GMFEnterprises.com",
        "business_type": "A10100",
        "bank_routing_number": "211170101",
        "bank_account_type": "checking"
      },
      "received_date": "2017-05-25T05:29:48.62",
      "updated_date:": "2017-05-27T03:22:14.31",
      "sales_rep": "JohnnyBGoode",
      "fee_plan": "gold",
      "owner": {
        "first_name": "George",
        "last_name": "McFly",
        "street_address1": "49 Great Scott! Drive",
        "locality": "Hill Valley",
        "region": "CA",
        "postal_code": "95420-4345",
        "country": "USA",
        "citizenship": "USA",
        "email_address": "george.mcfly@GMFEnterprises.com",
        "mobile_phone": "5555698965",
        "date_of_birth": "3/3/1938",
        "percentage": 100
      },
      "links": {
        "documents": "https://api.forte.net/v3/applications/app_998877/documents",
        "self": "https://api.forte.net/v3/applications/app_998877"
      }
    }
  ],
  "response": {
    "environment": "live",
    "response_desc": "Get Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/applications/?filter=start_received_date+eq+%272017-01-01%27+and+end_received_date+eq+%272017-06-30%27"
  }
}
Edit Content
Headers (12)

cache-control

no-cache

connection

keep-alive

content-type

application/json; charset=utf-8

date

Wed, 25 Oct 2017 18:56:50 GMT

expires

-1

pragma

no-cache

server

Microsoft-IIS/8.5

transfer-encoding

chunked

x-aspnet-version

4.0.30319

x-cdn

Incapsula

x-iinfo

3-15010348-15010351 NNNN CT(33 75 0) RT(1508957810297 39) q(0 0 1 0) r(2 2) U16

x-powered-by

ASP.NET

GET Applications by ID

				
					{{baseURI}}/organizations/org_{{organizationID}}/applications/app_{{applicationID}}

This URI returns a specific application submitted by the partner using the application_id. NOTE: The organization_id referenced in this URI must be the home_organization_id of the partner.
Applications can have the following statuses:

  • `approved` – Forte has approved the application and sent the merchant’s data to the enrollment queue.

  • `pending` – Forte’s Credit and Risk Team needs to review the application and may request additional documentation from the merchant.

  • `declined` – The application failed one or more automated underwriting checks and Forte has declined to move forward with the merchant. The reason for the decline displays in the `decline_reason` field.

  • `enrolled` – Merchant has completed enrollment and is ready to process transactions.

  • `rejected` – Forte is unable to verify the identity data of an application or cannot authenticate the banking data or signatures. The reason for the rejected status displays in the reject_reason field.

  • `recalled` – The applicant has stopped responding to requests for information from Forte or the Partner. The reason for the recalled status displays in the recalled_reason field.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}

Example Request

				
					curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/applications/app_{{applicationID}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'

Example Response

Edit Content 
				
					 {
  "authorization_amount": 102.45,
  "order_number": "ORD123",
  "vendor": {
    "vendor_type": "paypal",
    "vendor_approval_url": "https://www.sandbox.paypal.com/checkoutnow?token=49D016001T440021E",
    "vendor_account_email": "it@pp3.com",
    "vendor_order_number": "49D016001T440021E",
    "vendor_order_status": "PAYER_ACTION_REQUIRED"
  },
  "response": {
    "environment": "live",
    "response_desc": "Create Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/organizations/org_334316/locations/loc_192642/vendors/ven_2TXS88UYGN8LE/orders/49D016001T440021E"
  }
}
Edit Content
Headers (12)

cache-control

no-cache

connection

keep-alive

content-type

application/json; charset=utf-8

date

Wed, 25 Oct 2017 19:03:26 GMT

expires

-1

pragma

no-cache

server

Microsoft-IIS/8.5

transfer-encoding

chunked

x-aspnet-version

4.0.30319

x-cdn

Incapsula

x-iinfo

7-16959006-16959017 NNNN CT(35 71 0) RT(1508958206196 41) q(0 0 1 -1) r(1 1) U16

x-powered-by

ASP.NET
On this page