{"_id":"59dfa5868b51880010b74afe","category":{"_id":"59dfa5828b51880010b74ac2","version":"59dfa5828b51880010b74ab6","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":11,"slug":"resources","title":"JSON Objects"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"_id":"59dfa5828b51880010b74ab6","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-10-12T17:25:22.850Z","releaseDate":"2017-10-12T17:25:22.850Z","categories":["59dfa5828b51880010b74ab7","59dfa5828b51880010b74ab8","59dfa5828b51880010b74ab9","59dfa5828b51880010b74aba","59dfa5828b51880010b74abb","59dfa5828b51880010b74abc","59dfa5828b51880010b74abd","59dfa5828b51880010b74abe","59dfa5828b51880010b74abf","59dfa5828b51880010b74ac0","59dfa5828b51880010b74ac1","59dfa5828b51880010b74ac2","59dfa5828b51880010b74ac3","59dfa5828b51880010b74ac4","59dfa5828b51880010b74ac5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.23 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-15T19:23:06.210Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"11-0\": \"`cardTransactionType`\",\n    \"11-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"11-3\": \"Defines the type of transaction. \\nPossible values: \\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nREFUND\",\n    \"h-4\": \"Description\",\n    \"11-2\": \"**Required**\",\n    \"13-0\": \"`pfToken`\",\n    \"13-1\": \"*string*\",\n    \"13-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if using [Hosted Payment Fields](/v4.0/docs/hosted-payment-fields)*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"13-3\": \"Hosted Payment Fields token.\",\n    \"12-0\": \"`transactionMetaData`\",\n    \"12-1\": \"*object*\",\n    \"12-2\": \"Optional\",\n    \"12-3\": \"See [transactionMetaData](doc:transaction-meta-data).\",\n    \"1-0\": \"`amount`\",\n    \"1-1\": \"*decimal*\",\n    \"1-2\": \"**Required** in AUTH_ONLY, AUTH_CAPTURE, and REFUND\\n\\nNot relevant for CAPTURE and AUTH_REVERSAL\",\n    \"1-3\": \"Amount to be charged in the transaction, including decimal points.\",\n    \"3-0\": \"`recurringTransaction`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"3-3\": \"Enter **ECOMMERCE**. For recurring transactions, see the [Subscriptions Guide](doc:subscription-management).\",\n    \"4-0\": \"`merchantTransactionId`\",\n    \"4-1\": \"*string*\",\n    \"4-2\": \"Optional\",\n    \"4-3\": \"Merchant's unique ID for a new transaction. Between 1-50 characters.\",\n    \"5-0\": \"`softDescriptor`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Optional\",\n    \"5-3\": \"Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.\",\n    \"7-0\": \"`cardHolderInfo`\",\n    \"7-1\": \"*object*\",\n    \"7-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if sending card data (including encrypted data) or `pfToken` and shopper is new*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"7-3\": \"See [cardHolderInfo](doc:card-holder-info).\",\n    \"8-0\": \"`currency`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"8-3\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/v1.0/docs/currency-codes).\",\n    \"10-0\": \"`creditCard`\",\n    \"10-1\": \"*object*\",\n    \"10-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if sending card data or if `vaultedShopperId` is sent and the vaulted shopper has more than one credit card*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND.\",\n    \"10-3\": \"See [creditCard](doc:credit-card).\",\n    \"9-0\": \"`transactionFraudInfo`\",\n    \"9-1\": \"*object*\",\n    \"9-2\": \"Optional\",\n    \"9-3\": \"See [transactionFraudInfo](doc:transaction-fraud-info).\",\n    \"2-0\": \"`vaultedShopperId`\",\n    \"2-1\": \"*integer*\",\n    \"2-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if using a vaulted shopper*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"2-3\": \"ID of an existing vaulted shopper.\",\n    \"0-0\": \"`walletId`\",\n    \"0-1\": \"*long*\",\n    \"0-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if using MasterPass or Visa Checkout*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"0-3\": \"ID of the wallet, obtained via the [Create Wallet](/v4.0/docs/create-wallet) request.\",\n    \"14-0\": \"`transactionId`\",\n    \"14-1\": \"*string*\",\n    \"14-2\": \"**Required** in CAPTURE,  AUTH_REVERSAL, and REFUND\\n\\nNot relevant for AUTH_ONLY and AUTH_CAPTURE\",\n    \"14-3\": \"BlueSnap identifier for the transaction.\",\n    \"15-0\": \"`wallet`\",\n    \"15-1\": \"*object*\",\n    \"15-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if using Apple Pay*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"15-3\": \"See [wallet](doc:wallet).\",\n    \"16-0\": \"`vendorInfo`\",\n    \"16-1\": \"*object*\",\n    \"16-2\": \"*Relevant for Marketplaces*\\nOptional\",\n    \"16-3\": \"See [vendorInfo](doc:vendorinfo-1)\",\n    \"6-0\": \"`descriptorPhoneNumber`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"Optional\",\n    \"6-3\": \"Merchant's support phone number that will appear on the shopper's credit card statement. Maximum 20 characters.\"\n  },\n  \"cols\": 4,\n  \"rows\": 17\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"11-0\": \"`cardTransactionType`\",\n    \"11-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"11-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n    \"13-0\": \"`transactionId`\",\n    \"13-1\": \"*string*\",\n    \"13-3\": \"BlueSnap identifier for the transaction.\",\n    \"h-4\": \"Description\",\n    \"11-2\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nREFUND\",\n    \"13-2\": \"BlueSnap identifier for the transaction.\",\n    \"0-0\": \"`amount`\",\n    \"0-1\": \"*decimal*\",\n    \"0-2\": \"Amount to be charged in the transaction, including decimal points.\",\n    \"1-0\": \"`vaultedShopperId`\",\n    \"1-1\": \"*integer*\",\n    \"1-2\": \"ID of an existing vaulted shopper.\",\n    \"2-0\": \"`recurringTransaction`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Enter ECOMMERCE for a one-time transaction or RECURRING for a recurring transaction.\",\n    \"3-0\": \"`merchantTransactionId`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"Merchant's unique ID for a new transaction.\",\n    \"4-0\": \"`processingInfo`\",\n    \"4-1\": \"*object*\",\n    \"4-2\": \"See [processingInfo](doc:processing-info).\",\n    \"5-0\": \"`softDescriptor`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Description of the transaction, which appears on the customer's credit card statement.\",\n    \"7-0\": \"`cardHolderInfo`\",\n    \"7-1\": \"*object*\",\n    \"7-2\": \"See [cardHolderInfo](doc:card-holder-info).\",\n    \"8-0\": \"`currency`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/v1.0/docs/currency-codes).\",\n    \"10-0\": \"`creditCard`\",\n    \"10-1\": \"*object*\",\n    \"10-2\": \"See [creditCard](doc:credit-card).\",\n    \"12-0\": \"`transactionMetaData`\",\n    \"12-1\": \"*object*\",\n    \"12-2\": \"See [transactionMetaData](doc:transaction-meta-data).\",\n    \"9-0\": \"`fraudResultInfo`\",\n    \"9-1\": \"*object*\",\n    \"9-2\": \"See [fraudResultInfo](doc:fraud-result-info).\",\n    \"14-2\": \"See [refunds](doc:refunds).\",\n    \"14-1\": \"*object*\",\n    \"14-0\": \"`refunds`\",\n    \"15-0\": \"`wallet`\",\n    \"15-1\": \"*object*\",\n    \"15-2\": \"See [wallet](doc:wallet).\",\n    \"16-0\": \"`vendorInfo`\",\n    \"16-1\": \"*object*\",\n    \"16-2\": \"See [vendorInfo](doc:vendorinfo-1)\",\n    \"6-0\": \"`descriptorPhoneNumber`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"Merchant's support phone number that will appear on the shopper's credit card statement.\"\n  },\n  \"cols\": 3,\n  \"rows\": 17\n}\n[/block]","excerpt":"Contains the information required to process a credit card transaction","slug":"card-transaction","type":"basic","title":"cardTransaction"}

cardTransaction

Contains the information required to process a credit card transaction

Request

Property Name
Type
Required
Description

walletId

long

Required in AUTH_ONLY and AUTH_CAPTURE if using MasterPass or Visa Checkout

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND

ID of the wallet, obtained via the Create Wallet request.

amount

decimal

Required in AUTH_ONLY, AUTH_CAPTURE, and REFUND

Not relevant for CAPTURE and AUTH_REVERSAL

Amount to be charged in the transaction, including decimal points.

vaultedShopperId

integer

Required in AUTH_ONLY and AUTH_CAPTURE if using a vaulted shopper

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND

ID of an existing vaulted shopper.

recurringTransaction

string

Required in AUTH_ONLY and AUTH_CAPTURE

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND

Enter ECOMMERCE. For recurring transactions, see the Subscriptions Guide.

merchantTransactionId

string

Optional

Merchant's unique ID for a new transaction. Between 1-50 characters.

softDescriptor

string

Optional

Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.

descriptorPhoneNumber

string

Optional

Merchant's support phone number that will appear on the shopper's credit card statement. Maximum 20 characters.

cardHolderInfo

object

Required in AUTH_ONLY and AUTH_CAPTURE if sending card data (including encrypted data) or pfToken and shopper is new

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND

currency

string

Required in AUTH_ONLY and AUTH_CAPTURE

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND

Currency code (ISO 4217) of the amount to be charged. See Currency codes.

transactionFraudInfo

object

Optional

creditCard

object

Required in AUTH_ONLY and AUTH_CAPTURE if sending card data or if vaultedShopperId is sent and the vaulted shopper has more than one credit card

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND.

cardTransactionType

string

Required

Defines the type of transaction.
Possible values:
AUTH_ONLY
AUTH_CAPTURE
CAPTURE
AUTH_REVERSAL
REFUND

transactionMetaData

object

Optional

pfToken

string

Required in AUTH_ONLY and AUTH_CAPTURE if using Hosted Payment Fields

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND

Hosted Payment Fields token.

transactionId

string

Required in CAPTURE, AUTH_REVERSAL, and REFUND

Not relevant for AUTH_ONLY and AUTH_CAPTURE

BlueSnap identifier for the transaction.

wallet

object

Required in AUTH_ONLY and AUTH_CAPTURE if using Apple Pay

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND

See wallet.

vendorInfo

object

Relevant for Marketplaces
Optional

Response

Property Name
Type
Description

amount

decimal

Amount to be charged in the transaction, including decimal points.

vaultedShopperId

integer

ID of an existing vaulted shopper.

recurringTransaction

string

Enter ECOMMERCE for a one-time transaction or RECURRING for a recurring transaction.

merchantTransactionId

string

Merchant's unique ID for a new transaction.

processingInfo

object

softDescriptor

string

Description of the transaction, which appears on the customer's credit card statement.

descriptorPhoneNumber

string

Merchant's support phone number that will appear on the shopper's credit card statement.

cardHolderInfo

object

currency

string

Currency code (ISO 4217) of the amount to be charged. See Currency codes.

fraudResultInfo

object

creditCard

object

cardTransactionType

string

Defines the type of transaction. Values can be:
AUTH_ONLY
AUTH_CAPTURE
CAPTURE
AUTH_REVERSAL
REFUND

transactionMetaData

object

transactionId

string

BlueSnap identifier for the transaction.

refunds

object

See refunds.

wallet

object

See wallet.

vendorInfo

object