Back to Index

POST v1/CreditCardTransactions/{token}

Process a transaction against a credit card token

Request Information

URI Parameters

NameDescriptionTypeAdditional information
token

The CreditCard Token to run the transaction against

string

Required

version

string

None.

Body Parameters

The request body which describes the transaction

credit_card_token_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 or returned to the customer via this transaction.

decimal number

Required

type

The type of transaction to perform

string

Required

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

billing_name

The primary billing contact name. Billing_name on record will be used if one is not provided.

string

None.

billing_email_address

The email address for the primary billing contact. Email Address on record will be used if one is not provided.

string

None.

billing_phone_number

The phone number for the primary billing contact. Phone number on record will be used if one is not provided.

string

None.

billing_address

Address for the primary billing contact. Address on record will be used if one is not provided.

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

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",
  "billing_name": "sample string 3",
  "billing_email_address": "sample string 4",
  "billing_phone_number": "sample string 5",
  "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 6",
  "shipping_email_address": "sample string 7",
  "shipping_phone_number": "sample string 8",
  "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 9",
  "references": [
    {
      "name": "sample string 1",
      "value": "sample string 2"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2"
    }
  ],
  "application_name": "sample string 10",
  "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"
  ]
}