credit_card_transaction_request

NameDescriptionTypeAdditional information
order_number

Recommended: Order number provided by the source system, otherwise one will be automatically generated

string

String length: inclusive between 0 and 50

amount

Total amount to be charged to the customer via this transaction

decimal number

None.

type

The type of transaction to perform

string

Required

Matching regular expression pattern: VERIFY|PURCHASE|RETURN|AUTHORIZE|COMPLETE

name_on_card

The name of the card owner as it appears on the credit card

string

String length: inclusive between 2 and 26

card_number

The credit card number as it appears on the card

integer

None.

expiry_month

The credit card expiration month in two-digit format (e.g. 09 for September)

string

String length: inclusive between 2 and 2

expiry_year

The credit card expiration year in two-digit format (e.g. 08 for 2008)

string

String length: inclusive between 2 and 2

card_security_code

The 3 or 4 digit CVV2/CVC2/CID

string

String length: inclusive between 3 and 4

card_present

Specify whether the card is physically presented at the time of the transaction

boolean

None.

billing_name

The primary billing contact name

string

None.

billing_email_address

The email address for the primary billing contact

string

None.

billing_phone_number

The phone number for the primary billing contact

string

None.

billing_address

Address for the primary billing contact

address

None.

shipping_name

The name of the shipping contact

string

None.

shipping_email_address

This email address for the shipping contact

string

None.

shipping_phone_number

The phone number for the shipping contact

string

None.

shipping_address

The address for the shipping contact

address

None.

transaction_ref_code

The transaction reference code provided during the original pre-authorization. Required for types "RETURN|AUTHORIZE|COMPLETE"

string

String length: inclusive between 36 and 36

device_data

Optional: Device data is sent when a transaction is processed via a hardware device

device_data

None.

references

Additional information to record with the transaction request

Collection of reference

None.

application_name

The name of the calling application

string

Required

String length: inclusive between 0 and 128

language_code

Determines the Language of the response data. 2 Character ISO LanguageCode. Supported language codes are: 'en' (English), 'fr' (French). Default is 'en'.

string

None.