Predefined keywords in extended data for payment instructions

The predefined keywords that payment plug-ins can receive in extended data associated with a payment instruction are as shown. An individual plug-in can require more or fewer keywords for a given payment protocol.

-------------------------------------------------------------------------------

Optional parameter for all payment methods

-------------------------------------------------------------------------------

order_id - the order unique identifier

rma_id - the return merchandise authorization identifier

-------------------------------------------------------------------------------

Credit Card specific

-------------------------------------------------------------------------------

payment_method = [ brand ]

account - the credit card number

expire_year - the expiration year of the account

expire_month - the expiration month of the account

expire_day - the expiration day of the account

billto_firstname - the account holder first name

billto_middlename - the account holder middle name

billto_lastname - the account holder last name

billto_address1 - the bill to street address 1

billto_address2 - the bill to street address 2

billto_address3 - the bill to street address 3

billto_city - the bill to city

billto_stateprovidence - the bill to state or providence

billto_zipcode - the bill to zipcode

billto_country - the bill to country (ISO 3166 numeric code)

billto_phone_number - the bill to phone number

cc_brand - the credit card brand

cc_cvc - the card verification code

cc_nameoncard - the name on the card (cardholder)

CAVV - Cardholder Authentication Verification Value

XID - Transaction Identifier

-------------------------------------------------------------------------------

Electronic Check specific

-------------------------------------------------------------------------------

payment_method = check

account - the gift certificate/card (stored value) number

billto_firstname - the account holder first name

billto_middlename - the account holder middle name

billto_lastname - the account holder last name

billto_address1 - the bill to street address 1

billto_address2 - the bill to street address 2

billto_address3 - the bill to street address 3

billto_city - the bill to city

billto_stateprovidence - the bill to state or providence

billto_zipcode - the bill to zipcode

billto_country - the bill to country (ISO 3166 numeric code)

billto_phone_number - the bill to phone number

check_routing_number - the unique identifier of the bank;

in US, the American Bankers Association (ABA) routing number

check_number - the check number

-------------------------------------------------------------------------------

Gift Certificates (GCt), Gift Cards (GCd) and Stored value (SV) cards in general

-------------------------------------------------------------------------------

payment_method = [ storedValue | giftCertificate | giftCard ]

account - the gift certificate/card (stored value) number

expire_year - the expiration year of the account

expire_month - the expiration month of the account

expire_day - the expiration day of the account

sv_issue_year - the year the card/certificate was issued

sv_issue_month - the month the card/certificate was issued

sv_issue_day - the month the card/certificate was issued

sv_issuer - the name of the company/organization issuing the card/certificate

-------------------------------------------------------------------------------

Cash on deliver (COD) or Bill me later

-------------------------------------------------------------------------------

payment_method = [ COD | BillMe ]

billto_firstname - the account holder first name

billto_middlename - the account holder middle name

billto_lastname - the account holder last name

billto_address1 - the bill to street address 1

billto_address2 - the bill to street address 2

billto_address3 - the bill to street address 3

billto_city - the bill to city

billto_stateprovince - the bill to state or province

billto_zipcode - the bill to zipcode

billto_country - the bill to country (ISO 3166 numeric code)

billto_phone_number - the bill to phone number

-------------------------------------------------------------------------------

Credit Line or Line of Credit

-------------------------------------------------------------------------------

payment_method = creditLine

account - the credit line account