Field Definitions

Common Field and their definitions

address

data type	min length	max length
string	0	255

The customers address. e.g. 123 Customer Street.

amount

data type	min length	max length
decimal	0	9

The amount processed in the system for this transaction against this sid.

amounttotal

data type	min length	max length
decimal	0	-

The amounttotal field is the calculated total of the transaction based on all information sent in, the total value of the cart items, shipping, tax minus any coupon amount.

The amounttotal is always used displaying any all minor units. e.g. USD$17 is used as 17.00 JPY¥17 is used as 17

Calculating the amounttotal follows this pseudocode:

amounttotal = 0;

for each item in the cart {
    amounttotal = amounttotal + ( item.quantity * item.amount_unit);
}

amounttotal = amounttotal + (amount_shipping + amount_tax - amount_coupon);

card_ccv

data type	min length	max length
integer	3	6

The security code on the customers cards. Also known as, CCV, CVV, CVC and CSC. This is not the Card PIN.

card_exp_month

data type	min length	max length
integer	2	2

The expiry month for the customers card. Should be 0 filled. e.g. 1 (January) should be sent as 01. 2 should be sent as 02.

card_exp_year

data type	min length	max length
integer	2	2

The expiry year for the customers card. Should be 0 filled. And is only 2 digits long. e.g. 2001 should be 01. 2022 should be 22..

card_no

data type	min length	max length
integer	13	20

Also known as the PAN. This is the full credit card number. It should not have any punctuation or separators when sent. The system will not filter for any punctuation or separators and will just fail the transaction.

card_type

data type	min length	max length
string	0	255

This is the payment method. It should be indicative of the payment type.

e.g.

• visa

• mastercard

• bank

They paymethod should be provided to you at onboarding time. The payment methods available for your sid can also be retrieved using the rawfee API.

country

data type	min length	max length
string	3	3

The country code that belongs to the customers credit card. This should be the Alpha 3 ISO 3166 country code.

currency

data type	min length	max length
string	3	3

The 3 Alpha character ISO 4217 code for the currency.

email

data type	min length	max length
string	0	150

The customers email address.

firstname

data type	min length	max length
string	0	100

The customers first name.

hash

data type	min length	max length
string	32	32

The hash is a secure signature that is generated when you communicate with TxProcess. Every time you communicate with TxProcess and will create a Payment Record / Transaction in the system you will be required to create a hash to verify the contents of the transaction it self, and to complete your authentication with the system.

Generating the Hash

The hash is the md5 of

• sid

• timestamp

• amounttotal

• currency

• rcode

i.e. md5('22'.'1234568995265421'.'17.00'.'USD'.'222b6c')

lastname

data type	min length	max length
string	0	100

The customers lastname.

mobile

data type	min length	max length
string	0	25

The customers mobile number.

phone

data type	min length	max length
string	0	25

The customers land line phone number. Not their mobile phone number. For mobile phone number see mobile.

postcode

data type	min length	max length
string	0	16

The postcode / zip code of the customer.

rcode

data type	min length	max length
string	0	40

The rcode will be provided to you at onboarding. The rcode should never be sent in as plain text with the payment data. It is the equivalent to your password and should never be accessible / viewable online.

routing_no

data type	min length	max length
string	0	14

The routing or transit number, used for bank transfers.

ship_address

data type	min length	max length
string	0	255

The shipping address. e.g. 123 Customer Street.

ship_country

data type	min length	max length
string	3	3

The shipping country code. This should be the Alpha 3 ISO 3166 country code.

ship_postcode

data type	min length	max length
string	0	16

The shipping postcode / zip code of the customer.

ship_state

data type	min length	max length
string	0	32

The shipping state for the transaction.

ship_suburb_city

data type	min length	max length
string	0	60

The shipping suburb or city of the transaction.

sid

data type	min length	max length
string	0	11

The sid (Site ID) will be provided to you at onboarding.

state

data type	min length	max length
string	0	32

The customers billing state.

status

data type	min length	max length
string	0	10

The result of the transaction

suburb_city

data type	min length	max length
string	0	60

The billing suburb or city of the customer.

threeDSecure

data type	min length	max length
string	0	-

Expects be a JSON object with a collection of ThreeDSecure(3DS) fields and their values. This is for the Authorization transaction, after a 3DS Authentication transaction has already occurred. To complete a 3DS Authentication, please contact support and they will help guide you for your specific integration. The particular fields and their naming can be different depending on how the Authentication is done, and the payment processor being used.

tid

data type	min length	max length
string	0	255

The txid (transaction id) that the system generated for this transaction.

timestamp

data type	min length	max length
string	10	10

The timestamp is to be a Unix timestamp

tx_action

data type	min length	max length
string	0	15

the transaction type. e.g. PAYMENT or SETTLEMENT

txid

data type	min length	max length
string	16	16

The transaction id for this transaction. If this is the first in a series of transactions, this could be the same as the parent_txid . If it is not the first, there will be a parent_txid that will be used to group all of the series together.