EdgePay Developer Tools

Full Payment API Table

🚧

N O T E:

ITEMS IN Bold are required.
All others are Conditional or Optional based on your use and need.


Here is the Full API List for the Payment Interface:

Field Name

Max Size

Attribute

Notes

merchantID

19

N

Required - Unique ID assigned by EdgePay**

terminalID

19

N

Required - Unique ID also assigned by EdgePay

sID

15

N

Required for PayFac - Unique ID also assigned by EdgePay

cardNumber

19

N

Conditional - Supply this if card entered manually

cardExpirationDate

4

N

Conditional - Provide if cardNumber is used (MMYY)

trackData

39

AN

Conditional - Track1 or Track2 unencrypted Swipe or EMV

tokenID

16

N

Conditional - May supply in place of trackData or cardNumber from previous request

token

3

yes

For the Tokenization Services the API allows you to request a token,
(replacement value), for both credit cards or bank accounts that you can
store for future payment uses.

paymentDataInput

14

AN

Required - Defines the point of sale card enter mode:

  • Phone
  • Mail
  • Internet
  • Swipe

amount

12

N

Required - Total amount to charge with or without decimal. All minor units after decimal. No decimal amount is processed as major units (dollars, euros, etc.)

acctSplits

Array

Settlement Split Account and amount that funds will be settled to

currencyCode

3

N

Optional = Assumes USD unless otherwise specified

customerName

30

ANS

Conditional - Required for eCheck. Optional for all other transactions.
Allowable Special Characters & /. ( ) - , ''

customerNumber

17

AN

Conditional – Customer Order Number, see below for use. Required for Recurring Payment Customer

processor

10

AN

Future use

billingAddress

200

AN

Conditional - Not required but may improve interchange rate for phone, mail, internet, or manual entry.
Allowable Special Characters # . , ; : ''' °

billingCity

50

AN

same as billingAddress
Allowable Special Characters - , . ; ''' & / . ( )

billingState

2

A

same as billing Address

billingZip

10

AN

Required - same as billing Address "-" Allowed

cvv2

4

N

Optional - Security code from Card

merchantField1

200

AN

Optional - Reporting

merchantField2

200

AN

Optional - Reporting

posData

Optional description for eCheck

goodsOrServices

10

AN

Optional Description

memberUsername

60

AN

Optional - Recurring Payment Manager Customer

memberPassword

60

AN

Optional - Recurring Payment Manager Customer

siteUrl

100

AN

Optional - Recurring Payment Manager Customer

affiliate

12

ANS

Optional - Recurring Payment Manager Customer

cardholderIPAddress

39

ANS

Optional – Enhanced Fraud Management Service IPv6 supported

eMailAddress

128

ANS

Customer’s email address

softDescriptor

25

AN

Text that will appear on the cardholder's statement that describes the purchase.