NameDescriptionTypeAdditional information
WorkOrderId

Represents the Id of the work order to attach a successful payment to

 integer

Minimum value: 1
CompanyId

Represents the Id of the company the payment will be placed for.

 integer

Required

Minimum value: 1
ExpiryDate

Expiration date of the credit card. Only month and year are used.

 date

Required
BillingAddress

The billing address of the credit card being validated.
Testing conditions.
AVS rejection codes in test environment:

CodeMeaning
AStreet Address matches, Zip code does not
WZip code matches, Street Address does not
Z5 digit ZIP code match only
NNo Address or ZIP Code match
UAddress information is unavailable for that account number, or the card issuer does not support AVS.
RSystem unavailable, retry later
SService not supported
QBill to address did not pass edit checks
5Cardholder name incorrect, billing address and postal code match
6Cardholder name incorrect, billing postal code matches
7Cardholder name incorrect, billing address matches
8Cardholder name, billing address and postal code are all incorrect

 Address

Required
CardHolderName

The name on the card.

 string

Required

String length: inclusive between 1 and 30
CardNumber

The account number on the credit card. Must be a valid AMEX, Visa, MC, or Discover account number
Testing conditions.

 string

Required
Cvv2

The CVV2 code for the credit card.
Testing conditions.
CVV2 rejection codes in test environment:

First CharacterResponse
2CVV2 does not match
3Card expiration not provided for card does not have valid CVD code

 string

Required

String length: inclusive between 1 and 4
PhoneNumber

PhoneNumber associated with the credit card

 string

Required

Must be an acceptably formed phone number

String length: inclusive between 0 and 14
PhoneType

Type of phone number provided

 PhoneType

Required
EmailAddress

Email address of the person responsible for the credit card.

 string

Required

String length: inclusive between 0 and 30
CurrencyCode

What currency to make the charge in.

 string

Required
Username

Name of user authorizing the charge

 string

Required

String length: inclusive between 1 and 100
ChargeAmountNatural

Amount to charge on the card in CurrencyCode currency.
Testing conditions.

 decimal number

Required

Range: inclusive between 0.01 and 999999.99
SecurityKey

Security key for this transaction. Base64 encoding of the MD5 hash of "UserName:PrivateKey:MMddyyyy" in UTF8.

  • UserName is your username that you log into the API with.
  • Contact an administrator for your private key.
  • MMddyyyy is DateTime.UtcNow.Date formatted with MMddyyyy.

"WEB-API-USER:WEB-API-SECRET:08092017" would result in "YnQXrdS22L03ftjKHaExBg==" for a SecurityKey.

 string

Required