{"_id":"5b8ec61584303f0003a11517","category":{"_id":"5b8ec61584303f0003a11508","version":"5b8ec61584303f0003a1159b","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5b8ec61584303f0003a1159b","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5b1973ec0059c20003083ec0","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5b8ec61584303f0003a114fc","5b8ec61584303f0003a114fd","5b8ec61584303f0003a114fe","5b8ec61584303f0003a114ff","5b8ec61584303f0003a11500","5b8ec61584303f0003a11501","5b8ec61584303f0003a11502","5b8ec61584303f0003a11503","5b8ec61584303f0003a11504","5b8ec61584303f0003a11505","5b8ec61584303f0003a11506","5b8ec61584303f0003a11507","5b8ec61584303f0003a11508","5b8ec61584303f0003a11509","5b8ec61584303f0003a1150a","5b8ec61584303f0003a1150b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.27 Release","version_clean":"8976.0.0-XML","version":"8976-XML"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-15T19:23:06.210Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`card-transaction-type`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nREFUND\",\n    \"2-0\": \"`merchant-transaction-id`\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"Merchant's unique ID for a new transaction. Between 1 - 50 characters.\",\n    \"2-1\": \"*string*\",\n    \"1-0\": \"`transaction-id`\",\n    \"1-1\": \"*string*\",\n    \"1-3\": \"BlueSnap identifier for the transaction.\",\n    \"2-4\": \"A container of card-transaction properties.\\nThis property may appear more than once within the given resource.\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"**Required**\",\n    \"1-2\": \"**Required** in CAPTURE,  AUTH_REVERSAL, and REFUND\\n\\nNot relevant for AUTH_ONLY and AUTH_CAPTURE\",\n    \"3-0\": \"`soft-descriptor`\",\n    \"5-0\": \"`amount`\",\n    \"3-3\": \"Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.\",\n    \"3-1\": \"*string*\",\n    \"6-0\": \"`currency`\",\n    \"5-1\": \"*decimal*\",\n    \"7-0\": \"`vaulted-shopper-id`\",\n    \"6-1\": \"*string*\",\n    \"7-1\": \"*integer*\",\n    \"8-0\": \"`card-holder-info`\",\n    \"10-0\": \"`transaction-fraud-info`\",\n    \"11-0\": \"`credit-card`\",\n    \"14-0\": \"`transaction-meta-data`\",\n    \"5-3\": \"Amount to be charged in the transaction, including decimal points.\",\n    \"3-2\": \"Optional\",\n    \"5-2\": \"**Required** in AUTH_ONLY, AUTH_CAPTURE, and REFUND\\n\\nOptional in CAPTURE\\n\\nNot relevant for AUTH_REVERSAL\",\n    \"6-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"7-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if using a vaulted shopper*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"8-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if sending card data (including encrypted data) or `pf-token` and shopper is new*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"8-3\": \"Container of [card-holder-info](doc:card-holder-info) properties.\",\n    \"6-3\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n    \"7-3\": \"ID of an existing vaulted shopper.\",\n    \"10-3\": \"Container of [transaction-fraud-info](doc:transaction-fraud-info) properties.\",\n    \"11-3\": \"Container of [credit-card](doc:credit-card) properties.\",\n    \"14-3\": \"Container of [transaction-meta-data](doc:transaction-meta-data) properties.\",\n    \"10-2\": \"Optional\",\n    \"11-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if sending card data or if `vaulted-shopper-id` is sent and the vaulted shopper has more than one credit card*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"14-2\": \"Optional\",\n    \"8-1\": \"*container*\",\n    \"10-1\": \"*container*\",\n    \"11-1\": \"*container*\",\n    \"14-1\": \"*container*\",\n    \"12-0\": \"`pf-token`\",\n    \"12-1\": \"*string*\",\n    \"12-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if using [Hosted Payment Fields](/v8976-Tools/docs/hosted-payment-fields) or [Embedded Checkout](/v8976-Tools/docs/embedded-checkout)*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"12-3\": \"Hosted Payment Fields or Embedded Checkout token\",\n    \"9-0\": \"`wallet-id`\",\n    \"9-1\": \"*long*\",\n    \"9-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if using MasterPass or Visa Checkout*\\n\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"9-3\": \"ID of the wallet, obtained via the [Create Wallet](/v8976-Tools/docs/create-wallet) request.\",\n    \"15-0\": \"`wallet`\",\n    \"15-1\": \"*container*\",\n    \"15-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if using [Apple Pay](/v8976-Basics/docs/apple-pay) or [Google Pay™](/v8976-Basics/docs/google-pay)*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"15-3\": \"See [wallet](doc:wallet).\",\n    \"4-0\": \"`descriptor-phone-number`\",\n    \"4-1\": \"*string*\",\n    \"4-2\": \"Optional\",\n    \"4-3\": \"Merchant's support phone number that will appear on the shopper's credit card statement. Maximum 20 characters.\",\n    \"16-0\": \"`vendors-info`\",\n    \"16-1\": \"*container*\",\n    \"16-2\": \"*Relevant for Marketplaces*\\nOptional\",\n    \"16-3\": \"Container of [vendors-info](doc:vendors-info) properties.\",\n    \"13-0\": \"`three-d-secure`\",\n    \"13-1\": \"*container*\",\n    \"13-2\": \"Optional\",\n    \"13-3\": \"Container of [three-d-secure](doc:three-d-secure) properties.\",\n    \"17-0\": \"`level-3-data`\",\n    \"17-1\": \"*container*\",\n    \"17-2\": \"Optional\",\n    \"17-3\": \"Container of [level-3-data](doc:level-3-data) properties.\",\n    \"18-0\": \"`store-card`\",\n    \"18-1\": \"*boolean*\",\n    \"18-2\": \"Optional\",\n    \"18-3\": \"Indicates whether or not to store the shopper's payment data.\\n\\nPossible values:\\n**true (default)\\nfalse**\\n\\n**Note:** Not applicable when performing an Auth Only with an amount equal to zero.\\n\\nSee [Card on File Guide](doc:card-on-file-guide).\"\n  },\n  \"cols\": 4,\n  \"rows\": 19\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    \"0-0\": \"`card-transaction-type`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n    \"2-0\": \"`merchant-transaction-id`\",\n    \"2-2\": \"Merchant's unique ID for a new transaction. Between 1 - 50 characters.\",\n    \"2-3\": \"Merchant's unique ID for a new transaction. Length: 1..50\",\n    \"2-1\": \"*string*\",\n    \"1-0\": \"`transaction-id`\",\n    \"1-1\": \"*string*\",\n    \"1-3\": \"BlueSnap identifier for the transaction.\",\n    \"2-4\": \"A container of card-transaction properties.\\nThis property may appear more than once within the given resource.\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nREFUND\",\n    \"1-2\": \"BlueSnap identifier for the transaction.\",\n    \"3-0\": \"`soft-descriptor`\",\n    \"5-0\": \"`amount`\",\n    \"3-3\": \"Description of the transaction, which appears on the customer's credit card statement.\",\n    \"3-1\": \"*string*\",\n    \"6-0\": \"`currency`\",\n    \"5-1\": \"*decimal*\",\n    \"8-0\": \"`vaulted-shopper-id`\",\n    \"6-1\": \"*string*\",\n    \"8-1\": \"*integer*\",\n    \"9-0\": \"`card-holder-info`\",\n    \"10-0\": \"`credit-card`\",\n    \"12-0\": \"`transaction-meta-data`\",\n    \"5-3\": \"Amount to be charged in the transaction, including decimal points.\",\n    \"3-2\": \"Description of the transaction, which appears on the customer's credit card statement.\",\n    \"5-2\": \"Amount to be charged in the transaction, including decimal points.\",\n    \"6-2\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n    \"8-2\": \"ID of an existing vaulted shopper.\",\n    \"9-2\": \"Container of [card-holder-info](doc:card-holder-info) properties.\",\n    \"9-3\": \"Container of card-holder-info properties.\",\n    \"6-3\": \"Currency of the amount to be charged.\",\n    \"8-3\": \"ID of an existing vaulted shopper.\",\n    \"10-3\": \"Container of credit-card properties.\",\n    \"12-3\": \"Container of transaction-meta-data properties.\",\n    \"10-2\": \"Container of [credit-card](doc:credit-card) properties.\",\n    \"12-2\": \"Container of [transaction-meta-data](doc:transaction-meta-data) properties.\",\n    \"9-1\": \"container\",\n    \"10-1\": \"*container*\",\n    \"12-1\": \"*container*\",\n    \"13-0\": \"`processing-info`\",\n    \"13-1\": \"*container*\",\n    \"13-3\": \"A container of processing-info properties.\",\n    \"13-2\": \"Container of [processing-info](doc:processing-info) properties.\",\n    \"14-2\": \"Container of [fraud-result-info](doc:fraud-result-info) properties.\",\n    \"14-0\": \"`fraud-result-info`\",\n    \"14-1\": \"*container*\",\n    \"16-0\": \"`refunds`\",\n    \"16-1\": \"*container*\",\n    \"16-2\": \"Container of [refunds](doc:refunds) properties.\",\n    \"17-0\": \"`wallet`\",\n    \"17-1\": \"*container*\",\n    \"17-2\": \"Container of Apple Pay or Google Pay [wallet](doc:wallet) properties.\",\n    \"4-1\": \"*string*\",\n    \"4-0\": \"`descriptor-phone-number`\",\n    \"4-2\": \"Merchant's support phone number that will appear on the shopper's credit card statement.\",\n    \"18-0\": \"`vendors-info`\",\n    \"18-1\": \"*container*\",\n    \"18-2\": \"Container of [vendors-info](doc:vendors-info) properties.\",\n    \"15-0\": \"`chargebacks`\",\n    \"15-1\": \"*container*\",\n    \"15-2\": \"Container of [chargebacks](doc:chargebacks) properties.\",\n    \"19-0\": \"`level-3-data`\",\n    \"19-1\": \"*container*\",\n    \"19-2\": \"Container of [level-3-data](doc:level-3-data) properties.\",\n    \"11-0\": \"`three-d-secure`\",\n    \"11-1\": \"*container*\",\n    \"11-2\": \"Container of [three-d-secure](doc:three-d-secure) properties.\",\n    \"7-0\": \"`open-to-capture`\",\n    \"7-1\": \"*decimal*\",\n    \"7-2\": \"Remaining authorization amount available for capture.\",\n    \"20-2\": \"Indicates if the shopper provided permissions to store their payment data.\\n\\nPossible values:\\n**true (default)\\nfalse**\\n\\n**Note:** Not applicable when performing an Auth Only with an amount equal to zero.\\n\\nSee [Card on File Guide](doc:card-on-file-guide).\",\n    \"20-0\": \"`store-card`\",\n    \"20-1\": \"*boolean*\"\n  },\n  \"cols\": 3,\n  \"rows\": 21\n}\n[/block]","excerpt":"Contains the information required to process a credit card transaction","slug":"card-transaction","type":"basic","title":"card-transaction"}

card-transaction

Contains the information required to process a credit card transaction

Request

Property Name
Type
Required
Description

card-transaction-type

string

Required

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

transaction-id

string

Required in CAPTURE, AUTH_REVERSAL, and REFUND

Not relevant for AUTH_ONLY and AUTH_CAPTURE

BlueSnap identifier for the transaction.

merchant-transaction-id

string

Optional

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

soft-descriptor

string

Optional

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

descriptor-phone-number

string

Optional

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

amount

decimal

Required in AUTH_ONLY, AUTH_CAPTURE, and REFUND

Optional in CAPTURE

Not relevant for AUTH_REVERSAL

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

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.

vaulted-shopper-id

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.

card-holder-info

container

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

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND

Container of card-holder-info properties.

wallet-id

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.

transaction-fraud-info

container

Optional

Container of transaction-fraud-info properties.

credit-card

container

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

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND

Container of credit-card properties.

pf-token

string

Required in AUTH_ONLY and AUTH_CAPTURE if using Hosted Payment Fields or Embedded Checkout

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND

Hosted Payment Fields or Embedded Checkout token

three-d-secure

container

Optional

Container of three-d-secure properties.

transaction-meta-data

container

Optional

Container of transaction-meta-data properties.

wallet

container

Required in AUTH_ONLY and AUTH_CAPTURE if using Apple Pay or Google Pay™

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND

See wallet.

vendors-info

container

Relevant for Marketplaces
Optional

Container of vendors-info properties.

level-3-data

container

Optional

Container of level-3-data properties.

store-card

boolean

Optional

Indicates whether or not to store the shopper's payment data.

Possible values:
true (default)
false

Note: Not applicable when performing an Auth Only with an amount equal to zero.

See Card on File Guide.

Response

Property Name
Type
Description

card-transaction-type

string

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

transaction-id

string

BlueSnap identifier for the transaction.

merchant-transaction-id

string

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

soft-descriptor

string

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

descriptor-phone-number

string

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

amount

decimal

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

currency

string

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

open-to-capture

decimal

Remaining authorization amount available for capture.

vaulted-shopper-id

integer

ID of an existing vaulted shopper.

card-holder-info

container

Container of card-holder-info properties.

credit-card

container

Container of credit-card properties.

three-d-secure

container

Container of three-d-secure properties.

transaction-meta-data

container

Container of transaction-meta-data properties.

processing-info

container

Container of processing-info properties.

fraud-result-info

container

Container of fraud-result-info properties.

chargebacks

container

Container of chargebacks properties.

refunds

container

Container of refunds properties.

wallet

container

Container of Apple Pay or Google Pay wallet properties.

vendors-info

container

Container of vendors-info properties.

level-3-data

container

Container of level-3-data properties.

store-card

boolean

Indicates if the shopper provided permissions to store their payment data.

Possible values:
true (default)
false

Note: Not applicable when performing an Auth Only with an amount equal to zero.

See Card on File Guide.