Back to Index

PUT v1/CreditCards/{token}

Updates a credit card

Request Information

URI Parameters

NameDescriptionTypeAdditional information
token

The credit card token of the credit card to be updated

string

Required

version

string

None.

Body Parameters

The Credit Card Request containing the updated information for the credit card

credit_card_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

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. Not applicable for updates.

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. Not applicable for updates.

string

String length: inclusive between 3 and 4

billing_name

The primary billing contact name

string

None.

billing_email

The email address for the primary billing contact

string

None.

billing_phone

The phone number for the primary billing contact

string

None.

billing_address

Address for the primary billing contact

address

None.

references

Additional information to record with the credit card request

Collection of reference

None.

verify

Verify the credit card. Default is true. Not applicable for updates.

boolean

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",
  "name_on_card": "sample string 2",
  "card_number": 1,
  "expiry_month": "sample string 3",
  "expiry_year": "sample string 4",
  "card_security_code": "sample string 5",
  "billing_name": "sample string 6",
  "billing_email": "sample string 7",
  "billing_phone": "sample string 8",
  "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"
  },
  "references": [
    {
      "name": "sample string 1",
      "value": "sample string 2"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2"
    }
  ],
  "verify": true,
  "application_name": "sample string 10",
  "language_code": "en"
}

Response Information

Resource Description

A response indicating success or failure

credit_card_response
NameDescriptionTypeAdditional information
credit_card_token

The credit_card_token assigned to the newly created credit card

string

None.

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.

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:
{
  "credit_card_token": "sample string 1",
  "address_verification_result": "sample string 2",
  "card_security_code_verification_result": "sample string 3",
  "success": true,
  "message": "sample string 5",
  "message_code": 6,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}