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

paymethod_token

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

string

O

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

customer_id

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

string

O

is_default

Indicates whether or not a payment method is the Default Payment Method for a customer. This parameter only displays for GET requests.

string

--

billing_address_token

A unique string used to represent the billing address associated with this payment method. For example, add_tq0hemmmtf-zsxgq689rew.

string

O

notes

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

string

O

card

The Card Object

object

O

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

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

card.last_4_account_number

The last four digits of the redacted account number. This field is return only. [max length = 4]

object

--

card.account_number

The card number. This field is required when creating a new record and can only contain digits. Forte echoes this parameter in the card.masked_account_number response parameter. [max length = 16]

string

O

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

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

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

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.

string

O

card.one_time_token

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

string

O

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

card.au_code

Indicates the type of changes Account Updater found for the card associated with that payment token. This parameter supports the following values:

new - New Account Number
closed - Account Closed
expiry - Expiration Date Updated
updated - Card Information Updated by Issuer

This parameter is return only for GET requests. For more information about Account Updater, contact Customer Service.

string

O

card.suppress_account_updater

A Boolean flag indicating whether or not Forte should run monthly Account Updater services on the paymethod token associated to this credit card. Account Updater subscription required. The following values are supported:

true - This paymethod token will not be included in the monthly Account Updater services.
false - This paymethod token will be included in the monthly Account Updater services. This is the default value.

bool

O

card.au_updated_date

The date and timestamp when the token was last updated by Forte's Account Updater services. This parameter is return only for GET requests.

datetime

O

card.au_description

A concise description of what update was performed on the credit card associated with the payment token. The following options are supported:

"New account number"
"Account closed"
"Expiration date updated"
"Card information updated by issuer"

This parameter is return only for GET requests.

O

echeck

The eCheck Object

object

O

echeck.account_holder

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

string

O

echeck.last_4_account_number

The last four digits of the redacted account number. This field is return only. [max length = 4]

string

--

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. Forte echoes this parameter in the echeck.masked_account_number response parameter. [max length = 17]

string

O

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

O

echeck.account_type

Use one of the following values for this parameter:

Checking
Savings

string

O

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

R

echeck.one_time_token

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

string

O

vendor

The vendor Object

object

O

vendor.vendor_type

The supported vendor types include the following:

PayPal

string

R

vendor.vendor_billing_agreement_token

The ID of PayPal billing agreement token.

string

R

vendor.vendor_billing_agreement_id

The ID of PayPal billing agreement

string