Parameter

Description

Type

Req

organization_id

The identification number of the associated organization. For example, org_5551236.

string

R

location_id

The identification number of the associated location. For example, loc_1234568.

string

R

customer_token

A unique string used to represent a customer. For example, cst_SoGUG6mcLUS1nVzYBIbk3g. [max length = 26]

string

R

customer_id

A merchant-defined string used to identify the customer. [max length = 15]

string

O

default_paymethod_token

The customer's default paymethod token. The system returns this token when creating a customer with a paymethod. [max length = 26]

string

O

default_billing_address_token

A unique string used to represent the customer's default billing address. The system returns this token when creating a customer with a billing address. [max length = 26]

string

O

default_shipping_address_token

A unique string used to represent a customer's default shipping address. This system returns this token when creating a customer with a shipping address. [max length = 26]

string

O

status

Use one of the following values:

active
suspended

string

O

first_name

The first name of the customer. NOTE: To ensure the customer name properly displays for token transactions, include the addresses.first_name and addresses.last_name parameters in addition to the first_name and last_name parameters. [max length = 50]

string

R

last_name

The last name of the customer. NOTE: To ensure the customer name properly displays for token transactions, include the addresses.first_name and addresses.last_name parameters in addition to the first_name and last_name parameters. [max length = 50]

string

R

company_name

The company name of the customer. [max length = 50]

string

O

display_name

Displays the first_name + last_name parameters if the company_name parameter is null. [max length = 100]

string

O

created_date

The date and time when the customer record was created. This parameter is return only.

datetime

--

updated_date

The date and time when the customer record was updated. This parameter is return only.

datetime

--

deleted_date

The date and time when the customer record was deleted. This parameter is return only.

datetime

--

paymethod

The Paymethod Object

object

O

paymethod.organization_id

d
The identification number of the associated organization. For example, org_5551236.

string

R

paymethod.location_id

The identification number of the associated location. For example, loc_1234568.

string

R

paymethod.customer_token

A unique string used to represent a customer. For example, cst_SoGUG6mcLUS1nVzYBIbk3g. NOTE: When a merchant passes a customer token with a transaction, Forte ignores any other customer data in favor of the default data stored with the token. [max length = 26]

string

O

paymethod.paymethod_token

A unique string used to represent a payment method. For example,mth_1578436587. [max length = 26]

string

O

paymethod.label

A friendly, customer-defined name for the payment method. For example, "Moms Credit Card," "Work Credit Card," "Visa - 1234," etc. [max length = 50]

string

R

paymethod.card

The Card Object

object

O

paymethod.card.card_type

The type of credit card [max length = 6]. Options for this field include the following:

visa
mast
amex
disc
dine
jcb

string

R

paymethod.card.name_on_card

The name printed on the on the credit card [max length = 50]. This field is required when creating a new record or creating a permanent token from a one-time token.

string

R

paymethod.card.account_number

The card number. This field is required when creating a new record and can only contain digits. [max length = 16]

string

O

paymethod.card.expire_month

The expiration month. This field is required when creating a new record and must be a valid future date [max length = 2].

string

O

paymethod.card.expire_year

The expiration year. This field is required when creating a new record and must be a valid future date. [max length = 4]

string

O

paymethod.card.card_verification_value

The card verification number. Forte does not store this field with the paymethod token, but echoes it back. [max length = 4]

string

O

paymethod.card.procurement_card

Indicates whether or not this is a procurement card transaction. Accepted values are either true or false. For procurement card transactions, merchants must pass the customer_accounting_code field in the card object and the sales_tax_amount field in the transaction object.

Bool

O

paymethod.card.customer_accounting_code

Lists the procurement card accounting code. Forte does not save this information if the merchant is creating a paymethod. [max length = 17]

string

O

paymethod.card.one_time_token

A single use token generated by Forte.js (e.g., ott_g7vnjqikszabzynu6eowbq). [max length = 26]

string

O

paymethod.echeck

The eCheck Object

object

O

paymethod.echeck.account_holder

The name of the account owner. This field is required when creating or updating a new record. [max length = 50]

string

R

paymethod.echeck.account_number

The DDA or eCheck account number. This field is required when creating or updating a new record and can only contain digits. [max length = 17]

string

O

paymethod.echeck.routing_number

The transit routing number. 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

paymethod.echeck.account_type

Use one of the following values for this parameter:

checking
savings

string

O

paymethod.echeck.sec_code

Use one of the following values for this standard-entry class code: ARC, CCD, CIE, CTX, POP, POS, PPD, RCK, TEL, WEB.

string

O

paymethod.notes

A short description of the paymethod. [max length = 50]

string

O

paymethod.vendor

The vendor Object

object

O

paymethod.vendor.vendor_type

The supported vendor types include the following.

PayPal

string

R

paymethod.vendor.vendor_billing_agreement_token

The ID of PayPal billing agreement token

string

R

paymethod.vendor.vendor_billing_agreement_id

The ID of PayPal billing agreement

string

_

addresses

An array of Address Objects.

object

O

addresses.address_token

A unique string used to represent an address. For example, add_tq0hemmmtf-zsxgq689rew. [max length = 26]

string

R

addresses.customer_token

A unique string used to represent a customer. For example, cst_SoGUG6mcLUS1nVzYBIbk3g. [max length = 26]

string

R

addresses.organization_id

The identification number of the associated organization. For example, org_5551236.

string

R

addresses.location_id

The identification number of the associated location. For example, loc_1234568.

string

R

addresses.first_name

The first name of the user associated with this billing or shipping address [max length = 25]. NOTE: The first_name and last_name parameters are required for billing addresses when creating transactions without tokens. For token transactions, add these parameters to dispay the customer name with the transaction.

string

R

addresses.last_name

The last name of the user associated with this billing or shipping address [max length = 25]. NOTE: The first_name and last_name parameters are required for billing addresses when creating transactions without tokens. For token transactions, add these parameters to dispay the customer name with the transaction.

string

R

addresses.company_name

The name of the company associated with this billing or shipping address [max length = 20]. NOTE: The company_name parameter is required for billing addresses when creating transactions without tokens.

string

R

addresses.phone

The phone number associated with this billing or shipping address. This field supports both U.S. and Canadian phone numbers. [max length = 15]

string

O

addresses.email

The email address associated with this billing or shipping address [max length = 50]

string

O

addresses.label

A label that succinctly identifies the address. For example, "Work" or "Home." [max length = 50]

string

O

addresses.address_type

The type of address. Use one of the following values:

- default_billing - The default billing address
- default_shipping - The default shipping address
- none - The address is not a default address
- both - The address is both a default shipping address and a default billing address

string

O

addresses.shipping_address_type

Indicates whether the address is a residential or commercial address.

string

R

addresses.physical_address

The Physical Address Object.

object

R

addresses.physical_address.street_line1

The first line of the street address [max length = 35]

string

O

addresses.physical_address.street_line2

The second line of the street address [max length = 35]

string

O

addresses.physical_address.locality

Locality or city/town/village [max length = 25]

string

O

addresses.physical_address.region

Region or state/province. This field supports both U.S. and Canadian regions. [max length = 2]

string

O

addresses.physical_address.postal_code

Postal Code [max length = 15]. This field supports both U.S. and Canadian postal codes.

string

O