NameDescriptionTypeAdditional information
CustomerCCId

The Customer_CC_Id from the AR_Customer_CC table

integer

None.

CustomerId

The Customer_Id foreign key from the AR_Customer_CC table; must reference a record in the AR_Customer

integer

Required

CardType

The type of Credit Card; possible values: AMER, DISC, MAST, VISA; required for POST/PUT

string

Max length: 4

Min length: 4

String length: inclusive between 0 and 4

CardTypeLong

string

None.

CardNumber

Pass in only if not using tokenization (value will come back encrypted on GET)

string

String length: inclusive between 0 and 16

ExpirationMonth

2-digit Expiration Month

string

Max length: 2

Min length: 2

String length: inclusive between 0 and 2

ExpirationYear

2-digit Expiration Year

string

Max length: 2

Min length: 2

String length: inclusive between 0 and 2

ExpirationDate

Read-only, formatted as: MM / YY

string

None.

AccountName

Name on the account

string

String length: inclusive between 0 and 22

PaymentMethodId

foreign key from AR_Payment_Method; do not set explicitly (will be determined from CardType)

integer

None.

CustomerAddress

Street of address associated with the credit card

string

String length: inclusive between 0 and 35

CustomerZip

Zip code of the address associated with the credit card

string

String length: inclusive between 0 and 10

SecurityCode

3-digit security code on the back of the card

string

String length: inclusive between 0 and 8

UsedForAutoProcess

This credit card should be used for Recurring Auto Processing; defaults to false if not supplied

boolean

None.

AutoPay

Display only; Y if UsedForAutoProcess = true

string

String length: inclusive between 0 and 1

AutoProcessDay

Day of month to auto-process payment; required if UsedForAutoProcess is true

integer

None.

LastFour

Last 4 digit of the credit card number

string

String length: inclusive between 0 and 4

ACHDirectToken

the token returned from Forte

string

String length: inclusive between 0 and 50

UsedForNonRecurAuto

This credit card should be used for Non-Recurring Auto Processing; defaults to false if not supplied

boolean

None.

UsedForInitialPmt

Set to true only to designate this credit card in conjunction with an initial ACH payment

boolean

None.

CustomerBillId

Optional - pass in the CustomerBillId this is tied to; defaults to 1 if not supplied

integer

None.

ChangeExistingEFTDay

Optional - set true on PUT to update the Hold Date for any unsubmitted EFT transactions using this Credit Card to a new AutoProcessDay (same month only)

boolean

None.

VoidExistingEFTs

Optional - set true on PUT to void any existing unsubmitted EFT transactions using this Credit Card; if true, do not pass in ReplaceEFTsForCustomerBankID or ReplaceEFTsForCustomerCCID

boolean

None.

VoidExistingEFTsReason

string

String length: inclusive between 0 and 50

ReplaceEFTsForCustomerBankID

Optional - pass in an existing CustomerBankID that this payment method is replacing; the system will void any pending ACH transactions for that CustomerBankID (unsubmitted only), and replace them with this new Credit Card; if set, do not set VoidExistingEFTs to true

integer

None.

ReplaceEFTsForCustomerCCID

Optional - pass in an existing CustomerCCID that this payment method is replacing; the system will void any pending ACH transactions for that CustomerCCID (unsubmitted only), and replace them with this new Credit Card; if set, do not set VoidExistingEFTs to true

integer

None.

ReplaceExistingEFTsReason

specify the Void reason for replacing existing ACH entries; automatically set if blank

string

String length: inclusive between 0 and 50

PrintCycleInvoices

Print Cycle Invoices in AR_Customer table

boolean

None.