Back to Index

POST v1/CreditCardTransactions

Process a transaction against a credit card

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

The request body which describes the transaction

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.

Request Formats

application/json, text/json

Sample:
{
  "order_number": "sample string 1",
  "amount": 1.0,
  "type": "sample string 2",
  "name_on_card": "sample string 3",
  "card_number": 1,
  "expiry_month": "sample string 4",
  "expiry_year": "sample string 5",
  "card_security_code": "sample string 6",
  "card_present": true,
  "billing_name": "sample string 7",
  "billing_email_address": "sample string 8",
  "billing_phone_number": "sample string 9",
  "billing_address": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "province_state": "sample string 4",
    "country_code": "sample string 5",
    "postal_zip_code": "sample string 6"
  },
  "shipping_name": "sample string 10",
  "shipping_email_address": "sample string 11",
  "shipping_phone_number": "sample string 12",
  "shipping_address": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "province_state": "sample string 4",
    "country_code": "sample string 5",
    "postal_zip_code": "sample string 6"
  },
  "transaction_ref_code": "sample string 13",
  "device_data": {
    "manufacturer": "sample string 1",
    "model": "sample string 2",
    "serial": "sample string 3",
    "encrypted_data": "sample string 4"
  },
  "references": [
    {
      "name": "sample string 1",
      "value": "sample string 2"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2"
    }
  ],
  "application_name": "sample string 14",
  "language_code": "en"
}

Response Information

Resource Description

Result of the transaction

credit_card_transaction_response
NameDescriptionTypeAdditional information
address_verification_result

Result of the address verification process

string

None.

card_security_code_verification_result

Result of the card security code verification process

string

None.

transaction_ref_code

This field will return a value for any transaction that occurs, otherwise will be empty.

string

String length: inclusive between 0 and 36

success

True if successful, false otherwise

boolean

None.

message

The message related to the operation in the language specified by the request

string

None.

message_code

The code associated with the message

integer

None.

errors

List of validation errors that occured, otherwise empty

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "address_verification_result": "sample string 1",
  "card_security_code_verification_result": "sample string 2",
  "transaction_ref_code": "sample string 3",
  "success": true,
  "message": "sample string 5",
  "message_code": 6,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}