Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

- Transactions - The transactions file is the most important file. This holds information on all the individual transactions that have been issued against customer cards. It also contains data related to recurring continuity and upcoming billing dates as well was tracking numbers related to order shipments. - download sample file

Field Definitions:

Col

Name

Type

Required

Description

A

customerId

varchar(20)

Y

Your internal customer id for this customer

B

orderId

varchar(20)

Y

Your internal order id for the order associated with this transaction

C

dateCreated

datetime (YYYY-MM-DD HH:MM:SS)

Y

The timestamp of the transaction

D

campaignId

integer

Y

The CheckoutChamp campaignId that indicates which campaign to import this order into.

E

productId

integer

Y

The CheckoutChamp campaign productId that indicates which product within the campaign, the transaction was for. (Found on the campaign page)

F

isActiveRecurring

bit
0=false
1=true

Y

Whether this transaction was made on a currently active continuity product

G

nextBillDate

date (YYYY-MM-DD)

Y - IF isActiveRecurring=1

The next scheduled billing date for the active continuity product

H

paySource

ENUM (CREDITCARD, CHECK, or PREPAID)

Y

How the customer paid for the product

I

cardNumber

integer (max 19)

Y - IF paySource=CREDITCARD

Full credit card number used for payment

J

cardExpiryMonth

integer (MM)

Y - IF paySource=CREDITCARD

Month in which the card expires (must include leading zeros)

K

cardExpiryYear

integer (YYYY)

Y - IF paySource=CREDITCARD

Year in which the card expires (must be 4 digits)

L

achRoutingNumber

integer

Y - IF paySource=CHECK

Routing number of the customer's bank

M

achAccountNumber

integer

Y - if paySource=CHECK

Account number of the customer's bank account

N

achAccountType

ENUM
(SAVINGS or CHECKING)

Y - IF paySource=CHECK

Bank Account Type

O

merchantId

integer

Y

CheckoutChamp Id for the merchant account the transaction was billed against

P

merchantTxnId

varchar(30)

Y

transactionId returned by the merchant processor

Q

txnType

ENUM (SALE, AUTHORIZE, CAPTURE, REFUND)

Y

The type of transaction

R

subTotal

decimal

Y

product price before shipping and taxes applied

S

shipTotal

decimal

Y

shipping charged for the order

T

salesTax

decimal

Y

sales tax charged for the order

U

totalAmount

decimal

Y

Sum of salesTax / subTotal / shipTotal (Must add up correctly)

V

responseType

ENUM (SUCCESS or DECLINE)

Y

Result of the transaction, was it successful?

W

responseText

ENUM (SUCCESS or DECLINE)

Y

Any additional response information returned by the processor

X

authCode

varchar(20)

N

Authorization Code returned by the processor

Y

parentTxnId

varchar(30)

Y - IF txnType=REFUND or txnType=CAPTURE

The parent transaction against which a refund or capture transaction was run

Z

firstName

varchar(30)

Y

Customer's first name

AA

lastName

varchar(30)

Y

Customer's last name

AB

address1

varchar(30)

Y

Billing Address Line 1

AC

address2

varchar(30)

Y

Billing Address Line 2

AD

city

varchar(30)

Y

Billing Address City

AE

state

varchar(30)

Y - IF country=US or country=CA

Billing Address State

AF

country

char(2)
-standard ISO 2 country codes

Y

Billing Address Country

AG

postalCode

varchar(20)

Y

Billing Address Postal Code

AH

phoneNumber

numeric (no dashes or parentheses)

Y

Primary Phone number of customer

AI

homePhone

numeric (no dashes or parentheses)

N

Home telephone number

AJ

cellPhone

numeric (no dashes or parentheses)

N

Cellphone number

AK

workPhone

numeric (no dashes or parentheses)

N

Work telephone number

AL

emailAddress

emailAddress (must be valid format)

Y

Customer's email address

AM

billShipSame

bit
0=false
1=true

Y

Whether or not the shipping address is the same as the billing address

AN

shipFirstName

varchar(30)

N

Shipping First Name

AO

shipLastName

varchar(30)

N

Shipping Last Name

AP

shipAddress1

varchar(30)

Y - IF If billShipSame=0

Shipping Address Line 1

AOAQ

shipAddress2

varchar(30)

Y - IF If billShipSame=0

Shipping Address Line 2

APAR

shipCity

varchar(30)

Y - IF If billShipSame=0

Shipping Address City

AQAS

shipState

varchar(30)

Y - IF If country=US or country=CA

Shipping Address State

ARAT

shipCountry

char(2)
-standard ISO 2 country codes

Y - IF If billShipSame=0

Shipping Address Country

ASAU

shipPostalCode

varchar(20)

Y - IF If billShipSame=0

Shipping Address Postal Code

ATAV

affId

varchar(20)

N

CheckoutChamp affId

AUAW

subAffId

varchar(20)

N

Sub affiliate id associated with order

AVAX

shipDate

date (YYYY-MM-DD)

N

Date on which the order was shipped

AWAY

shipCarrier

varchar(20) (ex. USPS, FedEx, etc)

N

Carrier responsible for shipment

AXAZ

shipMethod

varchar(20)

N

Carrier's shipment method (ex. Express, 3-day Ground, etc)

AYBA

trackingNumber

varchar(20)

N

Order Tracking # assigned by the carrier

AZBB

isChargedback

Boolean('0' or '1')

N

Indicates that the specific transaction has been charged back by the card holder.

BABC

chargebackTotal

Decimal (xx.xx format)

Y-if isChargedback

The amount of the chargeback.

BBBD

chargebackDate

Date (YYYY-MM-DD)

Y-if isChargedback

The date on which the chargeback was issued.

BCBE

chargebackReasonCode

varchar(10)

Y-if isChargedback

Card issuer's chargeback code.

BDBF

externalToken

varchar(50)

N

A token identifying the customer payment source at the 3rd party gateway. This is commonly used to run existing rebills when the full card numbers are unavailable and when gateway-supported. -note: if provided, cardNumber column may be masked with either x's or asterisks.

BEBG

quantity

integer

N

The quantity of the product.  If not provided or not greater than 0, then it will be set to 1.

BFBH

variantDetailId

integer

N

The CheckoutChamp variantDetailId that indicates which variant of the product the transaction was for. (Found on the product page).  The variant must exist on the CheckoutChamp product.

BGBI

password

varchar(30)

N

membership password for a third-party site

...