{"_id":"59a45d447ee621000fc9d3e2","category":{"_id":"59a45d447ee621000fc9d3b9","version":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-10-15T15:28:41.796Z","from_sync":false,"order":1,"slug":"payment-transaction-service","title":"Card Transactions"},"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"version":{"_id":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:13:23.840Z","releaseDate":"2017-08-28T18:13:23.840Z","categories":["59a45d447ee621000fc9d3b8","59a45d447ee621000fc9d3b9","59a45d447ee621000fc9d3ba","59a45d447ee621000fc9d3bb","59a45d447ee621000fc9d3bc","59a45d447ee621000fc9d3bd","59a45d447ee621000fc9d3be","59a45d447ee621000fc9d3bf","59a45d447ee621000fc9d3c0","59a45d447ee621000fc9d3c1","59a45d447ee621000fc9d3c2","59a45d447ee621000fc9d3c3","59a45d447ee621000fc9d3c4","59a45d447ee621000fc9d3c5","59a45d447ee621000fc9d3c6","59a45d447ee621000fc9d3c7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-19T00:49:48.003Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[{"language":"text","code":""}]},"settings":"","auth":"optional","params":[],"url":"/transactions"},"isReference":true,"order":2,"body":"Auth Only is a request to check whether a credit card is valid and has the funds to complete a specific transaction (i.e. purchase). It does not actually run the charge on the card, but does temporarily hold the funds aside. Note that each credit card company will only hold the authorization for a limited period (for example, 3-10 days, depending on the credit card scheme).\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"If you wish to check the validity of a card without authorizing any charge amount, simply enter **0** as the value for the `amount` property in this request.\",\n  \"title\": \"Zero value auth for card validity checks\"\n}\n[/block]\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\n`card-transaction` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, contains the following properties (see [card-transaction](doc:card-transaction)):\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`card-transaction-type` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, value must be **AUTH_ONLY**\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`merchant-transaction-id` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`recurring-transaction` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`soft-descriptor` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendor-info` *container*&nbsp;&nbsp;&nbsp;optional&nbsp;&nbsp;&nbsp; applicable if using marketplace vendor (see [vendor-info](doc:vendor-info))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`amount` *decimal* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span> (use an amount of **0** to perform a card validation request)\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`currency` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vaulted-shopper-id` *integer* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required** if using a vaulted shopper</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`card-holder-info` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required** if sending card data or `pf-token` and shopper is new</span> (see [card-holder-info](doc:card-holder-info))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`wallet-id` *long* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required** if using MasterPass or Visa Checkout</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`wallet` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required** if using Apple Pay </span>&nbsp;&nbsp;&nbsp;&nbsp; (see [wallet](doc:wallet))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transaction-fraud-info` *container* &nbsp;&nbsp;&nbsp;optional (see [transaction-fraud-info](doc:transaction-fraud-info)) \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`credit-card` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required** if sending card or if vaulted shopper has multiple cards - do not include if using Hosted Payment Fields or `wallet`</span> (see [credit-card](doc:credit-card))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`pf-token` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required** if using [Hosted Payment Fields](/v4.0/docs/hosted-payment-fields)</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transaction-meta-data` *container* &nbsp;&nbsp;&nbsp;optional (see [transaction-meta-data](doc:transaction-meta-data)) \n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains a `card-transaction` resource (see [card-transaction](doc:card-transaction)) with the request properties plus these additions:\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transaction-id`\t\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vaulted-shopper-id`\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`processing-info`\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`fraud-result-info` if [fraud prevention](/v1.0/docs/fraud-prevention) is enabled\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendor-info` if using marketplace vendor\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <soft-descriptor>DescTest</soft-descriptor>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <card-holder-info>\\n      <first-name>test first name</first-name>\\n      <last-name>test last name</last-name>\\n      <zip>123456</zip>\\n   </card-holder-info>\\n   <credit-card>\\n      <card-number>4263982640269299</card-number>\\n      <security-code>837</security-code>\\n      <expiration-month>02</expiration-month>\\n      <expiration-year>2018</expiration-year>\\n   </credit-card>\\n   <transaction-fraud-info>\\n      <fraud-session-id>1234</fraud-session-id>\\n      <shopper-ip-address>123.12.134.1</shopper-ip-address>\\n      <company>BBBBB</company>\\n      <shipping-contact-info>\\n         <last-name>LL</last-name>\\n         <first-name>YY</first-name>\\n         <country>US</country>\\n         <state>AL</state>\\n         <city>Juneau</city>\\n         <address1>Address1</address1>\\n         <address2>Address2</address2>\\n         <zip>12345</zip>\\n      </shipping-contact-info>\\n   </transaction-fraud-info>\\n</card-transaction>\",\n      \"language\": \"curl\",\n      \"name\": \"Auth Only Request: basic with fraud info\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <soft-descriptor>DescTest</soft-descriptor>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <card-holder-info>\\n      <first-name>test first name</first-name>\\n      <last-name>test last name</last-name>\\n      <zip>123456</zip>\\n   </card-holder-info>\\n   <credit-card>\\n      <card-number>4263982640269299</card-number>\\n      <security-code>837</security-code>\\n      <expiration-month>02</expiration-month>\\n      <expiration-year>2018</expiration-year>\\n   </credit-card>\\n   <transaction-fraud-info>\\n      <fraud-session-id>1234</fraud-session-id>\\n      <shopper-ip-address>123.12.134.1</shopper-ip-address>\\n      <company>BBBBB</company>\\n      <shipping-contact-info>\\n         <last-name>LL</last-name>\\n         <first-name>YY</first-name>\\n         <country>US</country>\\n         <state>AL</state>\\n         <city>Juneau</city>\\n         <address1>Address1</address1>\\n         <address2>Address2</address2>\\n         <zip>12345</zip>\\n      </shipping-contact-info>\\n      <enterprise-site-id>DEFAULT</enterprise-site-id>\\n      <enterprise-udfs>\\n         <udf>\\n            <udf-name>ENT_UDF1</udf-name>\\n            <udf-value>aaa</udf-value>\\n         </udf>\\n         <udf>\\n            <udf-name>ENT_UDF2</udf-name>\\n            <udf-value>bbb</udf-value>\\n         </udf>\\n      </enterprise-udfs>\\n   </transaction-fraud-info>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with enterprise fraud info\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <soft-descriptor>DescTest</soft-descriptor>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <vaulted-shopper-id>20781033</vaulted-shopper-id>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with vaulted shopper who has one card\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <soft-descriptor>DescTest</soft-descriptor>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <vaulted-shopper-id>20769005</vaulted-shopper-id>\\n   <credit-card>\\n      <card-last-four-digits>9299</card-last-four-digits>\\n      <card-type>VISA</card-type>\\n   </credit-card>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with vaulted shopper and credit card specified\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <soft-descriptor>DescTest</soft-descriptor>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <card-holder-info>\\n      <first-name>test first name</first-name>\\n      <last-name>test last name</last-name>\\n      <zip>123456</zip>\\n   </card-holder-info>\\n   <credit-card>\\n     <card-number>4263982640269299</card-number>\\n      <security-code>837</security-code>\\n      <expiration-month>02</expiration-month>\\n      <expiration-year>2018</expiration-year>\\n   </credit-card>\\n   <transaction-meta-data>\\n      <meta-data>\\n         <meta-key>stateTaxAmount</meta-key>\\n         <meta-value>20.00</meta-value>\\n         <meta-description>State Tax Amount</meta-description>\\n      </meta-data>\\n      <meta-data>\\n         <meta-key>cityTaxAmount</meta-key>\\n         <meta-value>20.00</meta-value>\\n         <meta-description>City Tax Amount</meta-description>\\n      </meta-data>\\n      <meta-data>\\n         <meta-key>shippingAmount</meta-key>\\n         <meta-value>10.00</meta-value>\\n         <meta-description>Shipping Amount</meta-description>\\n      </meta-data>\\n   </transaction-meta-data>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with metadata\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <merchant-transaction-id>3</merchant-transaction-id>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <card-holder-info>\\n      <first-name>test first name</first-name>\\n      <last-name>test last name</last-name>\\n      <zip>123456</zip>\\n   </card-holder-info>\\n   <credit-card>\\n     <card-number>4263982640269299</card-number>\\n      <security-code>837</security-code>\\n      <expiration-month>02</expiration-month>\\n      <expiration-year>2018</expiration-year>\\n   </credit-card>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with Merchant Transaction ID\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <wallet-id>21</wallet-id>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with wallet ID\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <soft-descriptor>DescTest</soft-descriptor>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <card-holder-info>\\n      <first-name>test first name</first-name>\\n      <last-name>test last name</last-name>\\n      <zip>123456</zip>\\n   </card-holder-info>\\n   <credit-card>\\n      <encrypted-card-number>$bsjs_1_0_3$B23uuxq8drUwOYZm3wZi+Qm69V5GPEt8PEio+Edwcm8akczQSK7odgLQH/Au+VqOCsGspW1Q9mPyQIzGLSZLVToAQVfq5C1ld+2ogIIsDL32Hd6IojboLyVlYT1FvPQoDyz19K6N0CUHh5uk0kCLuHSUyjvoJH38ojHZifbJSm/7S5vAtiuC3BJt2z8k9nauQaAXkbyoAYwrS1yDpqOt2k2lGhKcmdQ4ImDR0RL8m8xig6sFrki9oqo3Mju/M5r7wXXVTf7TMtWiQbzdfREOxKUnviXJZpncdHqVjj5GvPYun2qgopKVKr8F5+yd19TVW2gvA1kXBkXonFL9159Gxg==$zckJgo2i8jXDiAHwVVHBKypXFnWqF2e+6luBkmtQQRKniDXyXaalRVKLtYscBaGd$W7Ojqk1Q2iOJVeGL39RAsZTtfup3f1deSzvxrvC9rXA=</encrypted-card-number>\\n      <encrypted-security-code>$bsjs_1_0_3$MB1nBpok/YkuWPG1/7e6dyFFhDPHB8p8E9Yo+0YHHV+xkHuzFKr02wAnE8PJ8QCzWH+2ctXy5FN6wLKjwFrfTOgy0BJ9k9+NDEe8mhsu66wMlyc3lnwrbvMRCWN1O+5gUNCFExj7B0mDtf4gtxecXs74KZ5l5dbpGWdKUk5i7OewWyTqsONbn9taLfVBOwuIOy2Jgi4fx+yB8Q05KdZeHSNSBJh8H/47AUNAn5dM+d9iO6yGQB3obzEzzR3UtHlkGR52ZsgbbFh0JMm9lBM2ClgYM8jvmQjS9HX2ojt1fkbhuPEb1IY/M498a+1wDPpI4aMfDxO1lSpJneRSpY5k4g==$XaKq1NbPcS0iHy9N9jHekEIByHYS4G3wJXlC9EQjAGM=$BJn6X6mBYGUo8Eoq4RQz69gsi4Azl8jT973mNpG9Yuo=</encrypted-security-code>\\n      <expiration-month>07</expiration-month>\\n      <expiration-year>2016</expiration-year>\\n   </credit-card>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with encrypted credit card\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <soft-descriptor>DescTest</soft-descriptor>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <card-holder-info>\\n      <first-name>test first name</first-name>\\n      <last-name>test last name</last-name>\\n      <zip>123456</zip>\\n   </card-holder-info>\\n   <pf-token>abcde12345**********</pf-token>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with Hosted Payment Fields token\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <soft-descriptor>DescTest</soft-descriptor>\\n   <vendor-info>\\n      <vendor-id>514147</vendor-id>\\n   </vendor-info> \\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <card-holder-info>\\n      <first-name>test first name</first-name>\\n      <last-name>test last name</last-name>\\n      <zip>123456</zip>\\n   </card-holder-info>\\n   <credit-card>\\n      <card-number>4263982640269299</card-number>\\n      <security-code>837</security-code>\\n      <expiration-month>02</expiration-month>\\n      <expiration-year>2018</expiration-year>\\n   </credit-card>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"basic with vendor info\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n  <recurring-transaction>ECOMMERCE</recurring-transaction>\\n  <soft-descriptor>DescTest</soft-descriptor>\\n  <amount>11.00</amount>\\n  <currency>USD</currency>\\n  <wallet>\\n    <apple-pay>\\n      <encoded-payment-token>ImRhdGEiOiJuY1AvRitIUy8zeG5bXhCMFd</encoded-payment-token>\\n    </apple-pay>\\t\\n  </wallet>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with Apple Pay\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n  <recurring-transaction>ECOMMERCE</recurring-transaction>\\n  <soft-descriptor>DescTest</soft-descriptor>\\n  <amount>11.00</amount>\\n  <currency>USD</currency>\\n  <vaulted-shopper-id>20769005</vaulted-shopper-id>\\n  <credit-card>\\n    <card-last-four-digits>9299</card-last-four-digits>\\n    <card-type>VISA</card-type>\\n    <security-code>837</security-code>\\n  </credit-card>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with vaulted shopper & CVV\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <soft-descriptor>DescTest</soft-descriptor>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <vaulted-shopper-id>20769005</vaulted-shopper-id>\\n   <credit-card>\\n      <card-number>4012000033330026</card-number>\\n      <security-code>111</security-code>\\n      <expiration-month>07</expiration-month>\\n      <expiration-year>2019</expiration-year>\\n   </credit-card>\\n</card-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with vaulted shopper & new card \"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/ 1.1 200 OK\\n\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <transaction-id>38488222</transaction-id>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <soft-descriptor>BLS*DescTest</soft-descriptor>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <vaulted-shopper-id>1234</vaulted-shopper-id>\\n   <card-holder-info>\\n     \\t<first-name>test first name</first-name>\\n     \\t<last-name>test last name</last-name>\\n     \\t<zip>123456</zip>\\n   </card-holder-info>\\n   <credit-card>\\n      <card-last-four-digits>9299</card-last-four-digits>\\n      <card-type>VISA</card-type>\\n      <card-sub-type>CREDIT</card-sub-type>\\n      <card-category>CLASSIC</card-category>\\n   </credit-card>\\n   <processing-info>\\n      <processing-status>success</processing-status>\\n      <cvv-response-code>MA</cvv-response-code>\\n      <avs-response-code-zip>M</avs-response-code-zip>\\n      <avs-response-code-address>M</avs-response-code-address>\\n      <avs-response-code-name>U</avs-response-code-name>\\n   </processing-info>\\n   <fraud-result-info>\\n      <device-data-collector>Y</device-data-collector>\\n   </fraud-result-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"Auth Only Response: 200 OK - basic with fraud info / enterprise fraud info\"\n    },\n    {\n      \"code\": \"HTTP/ 1.1 200 OK\\n\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <transaction-id>38488224</transaction-id>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <soft-descriptor>BLS*DescTest</soft-descriptor>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <vaulted-shopper-id>19549066</vaulted-shopper-id>\\n   <credit-card>\\n      <card-last-four-digits>9299</card-last-four-digits>\\n      <card-type>VISA</card-type>\\n      <card-sub-type>CREDIT</card-sub-type>\\n      <card-category>CLASSIC</card-category>\\n   </credit-card>\\n   <processing-info>\\n      <processing-status>success</processing-status>\\n      <avs-response-code-zip>M</avs-response-code-zip>\\n      <avs-response-code-address>M</avs-response-code-address>\\n      <avs-response-code-name>U</avs-response-code-name>\\n   </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - vaulted shopper (whether credit card was specified or not)\"\n    },\n    {\n      \"code\": \"HTTP/ 1.1 200 OK\\n\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n    <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n    <transaction-id>38497126</transaction-id>\\n    <recurring-transaction>ECOMMERCE</recurring-transaction>\\n    <soft-descriptor>BLS*DescTest</soft-descriptor>\\n    <amount>11.00</amount>\\n    <currency>USD</currency>\\n    <vaulted-shopper-id>1234</vaulted-shopper-id>\\n    <avs-response-code>G</avs-response-code>\\n    <card-holder-info>\\n        <first-name>test first name</first-name>\\n        <last-name>test last name</last-name>\\n      \\t<zip>123456</zip>\\n    </card-holder-info>\\n    <credit-card>\\n        <card-last-four-digits>9299</card-last-four-digits>\\n        <card-type>VISA</card-type>\\n        <card-sub-type>CREDIT</card-sub-type>\\n        <card-category>CLASSIC</card-category>\\n    </credit-card>\\n    <transaction-meta-data>\\n        <meta-data>\\n            <meta-key>stateTaxAmount</meta-key>\\n            <meta-value>20.00</meta-value>\\n            <meta-description>State Tax Amount</meta-description>\\n        </meta-data>\\n        <meta-data>\\n            <meta-key>cityTaxAmount</meta-key>\\n            <meta-value>20.00</meta-value>\\n            <meta-description>City Tax Amount</meta-description>\\n        </meta-data>\\n        <meta-data>\\n            <meta-key>shippingAmount</meta-key>\\n            <meta-value>10.00</meta-value>\\n            <meta-description>Shipping Amount</meta-description>\\n        </meta-data>\\n    </transaction-meta-data>\\n    <processing-info>\\n        <processing-status>success</processing-status>\\n        <cvv-response-code>MA</cvv-response-code>\\n        <avs-response-code-zip>U</avs-response-code-zip>\\n        <avs-response-code-address>U</avs-response-code-address>\\n        <avs-response-code-name>U</avs-response-code-name>\\n    </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - metadata\"\n    },\n    {\n      \"code\": \"HTTP/ 1.1 200 OK\\n\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <merchant-transaction-id>3</merchant-transaction-id>\\n   <transaction-id>38488150</transaction-id>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <vaulted-shopper-id>1234</vaulted-shopper-id>\\n   <card-holder-info>\\n     <first-name>test first name</first-name>\\n     <last-name>test last name</last-name>\\n     <zip>123456</zip>\\n   </card-holder-info>\\n   <credit-card>\\n      <card-last-four-digits>9299</card-last-four-digits>\\n      <card-type>VISA</card-type>\\n      <card-sub-type>CREDIT</card-sub-type>\\n      <card-category>CLASSIC</card-category>\\n   </credit-card>\\n   <processing-info>\\n      <processing-status>success</processing-status>\\n      <cvv-response-code>MA</cvv-response-code>\\n      <avs-response-code-zip>M</avs-response-code-zip>\\n      <avs-response-code-address>M</avs-response-code-address>\\n      <avs-response-code-name>U</avs-response-code-name>\\n   </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - Merchant Transaction ID\"\n    },\n    {\n      \"code\": \"HTTP/ 1.1 200 OK\\n\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n  <transaction-id>1011702615</transaction-id>\\n  <recurring-transaction>ECOMMERCE</recurring-transaction>\\n  <amount>11.00</amount>\\n  <currency>USD</currency>\\n  <vaulted-shopper-id>123</vaulted-shopper-id>\\n  <card-holder-info>\\n\\t  <first-name>test first name</first-name>\\n\\t  <last-name>test last name</last-name>\\n  </card-holder-info>\\n  <credit-card>\\n\\t  <card-last-four-digits>9299</card-last-four-digits>\\n\\t  <card-type>VISA</card-type>\\n\\t  <card-sub-type>CREDIT</card-sub-type>\\n    <card-category>CLASSIC</card-category>\\n  </credit-card>\\n  <processing-info>\\n\\t  <processing-status>success</processing-status>\\n\\t  <cvv-response-code>NC</cvv-response-code>\\n  </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - wallet ID\"\n    },\n    {\n      \"code\": \"HTTP/ 1.1 200 OK\\n\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n    <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n    <transaction-id>38504158</transaction-id>\\n    <recurring-transaction>ECOMMERCE</recurring-transaction>\\n    <soft-descriptor>BLS*DescTest</soft-descriptor>\\n    <amount>11.00</amount>\\n    <currency>USD</currency>\\n    <vaulted-shopper-id>1234</vaulted-shopper-id>\\n    <card-holder-info>\\n        <first-name>test first name</first-name>\\n        <last-name>test last name</last-name>\\n      \\t<zip>123456</zip>\\n    </card-holder-info>\\n    <credit-card>\\n        <card-last-four-digits>1111</card-last-four-digits>\\n        <card-type>VISA</card-type>\\n        <card-sub-type>CREDIT</card-sub-type>\\n        <card-category>CLASSIC</card-category>\\n    </credit-card>\\n    <processing-info>\\n        <processing-status>success</processing-status>\\n        <cvv-response-code>ND</cvv-response-code>\\n        <avs-response-code-zip>U</avs-response-code-zip>\\n        <avs-response-code-address>U</avs-response-code-address>\\n        <avs-response-code-name>U</avs-response-code-name>\\n    </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - encrypted credit card\"\n    },\n    {\n      \"code\": \"<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <transaction-id>38486450</transaction-id>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <soft-descriptor>BLS*DescTest</soft-descriptor>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <vaulted-shopper-id>1234</vaulted-shopper-id>\\n   <card-holder-info>\\n     <first-name>test first name</first-name>\\n     <last-name>test last name</last-name>\\n     <zip>123456</zip>\\n   </card-holder-info>\\n   <credit-card>\\n      <card-last-four-digits>9299</card-last-four-digits>\\n      <card-type>VISA</card-type>\\n      <card-sub-type>CREDIT</card-sub-type>\\n      <card-category>CLASSIC</card-category>\\n   </credit-card>\\n   <processing-info>\\n      <processing-status>success</processing-status>\\n      <cvv-response-code>MA</cvv-response-code>\\n      <avs-response-code-zip>M</avs-response-code-zip>\\n      <avs-response-code-address>M</avs-response-code-address>\\n      <avs-response-code-name>U</avs-response-code-name>\\n   </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - Hosted Payment Fields\"\n    },\n    {\n      \"code\": \"<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n\\t<card-transaction-type>AUTH_ONLY</card-transaction-type>\\n\\t<vendor-info>\\n\\t\\t<vendor-id>514147</vendor-id>\\n\\t\\t<commission-percent>20</commission-percent>\\n\\t</vendor-info>\\n\\t<transaction-id>1013344071</transaction-id>\\n\\t<recurring-transaction>ECOMMERCE</recurring-transaction>\\n\\t<soft-descriptor>BLS&#x2a;DescTest</soft-descriptor>\\n\\t<amount>11.00</amount>\\n\\t<currency>USD</currency>\\n\\t<card-holder-info>\\n\\t\\t<first-name>test first name</first-name>\\n\\t\\t<last-name>test last name</last-name>\\n\\t\\t<zip>123456</zip>\\n\\t</card-holder-info>\\n\\t<vaulted-shopper-id>21523967</vaulted-shopper-id>\\n\\t<credit-card>\\n\\t\\t<card-last-four-digits>9299</card-last-four-digits>\\n\\t\\t<card-type>VISA</card-type>\\n\\t\\t<card-sub-type>CREDIT</card-sub-type>\\n    <card-category>CLASSIC</card-category>\\n\\t</credit-card>\\n\\t<processing-info>\\n\\t\\t<processing-status>success</processing-status>\\n\\t\\t<cvv-response-code>MA</cvv-response-code>\\n\\t\\t<avs-response-code-zip>U</avs-response-code-zip>\\n\\t\\t<avs-response-code-address>U</avs-response-code-address>\\n\\t\\t<avs-response-code-name>U</avs-response-code-name>\\n\\t</processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - basic with vendor info\"\n    },\n    {\n      \"code\": \"<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n  <transaction-id>38486450</transaction-id>\\n  <recurring-transaction>ECOMMERCE</recurring-transaction>\\n  <soft-descriptor>BLS*DescTest</soft-descriptor>\\n  <amount>11.00</amount>\\n  <currency>USD</currency>\\n  <vaulted-shopper-id>1234</vaulted-shopper-id>\\n  <Wallet>\\n    <billing-contact-info>\\n      <first-name>John</first-name>\\n      <last-name>Doe</last-name>\\n      <address1>South St</address1>\\n      <city>Waltham</city>\\n      <state>MA</state>\\n      <zip>02453</zip>\\n    </billing-contact-info>\\n    <apple-pay>\\n      <card-last-four-digits>0492</card-last-four-digits>\\n      <card-type>VISA</card-type>\\n      <card-sub-type>DEBIT</card-sub-type>\\n      <dpan-last-four-digits>4109</dpan-last-four-digits>\\n      <dpan-expiration-month>11</dpan-expiration-month>\\n      <dpan-expiration-year>25</dpan-expiration-year>\\n    </apple-pay>\\t\\n  </Wallet>\\n  <processing-info>\\n    <processing-status>success</processing-status>\\n    <cvv-response-code>MA</cvv-response-code>\\n    <avs-response-code-zip>M</avs-response-code-zip>\\n    <avs-response-code-address>M</avs-response-code-address>\\n    <avs-response-code-name>U</avs-response-code-name>\\n  </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - Apple Pay\"\n    },\n    {\n      \"code\": \"<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <transaction-id>38486450</transaction-id>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <soft-descriptor>BLS*DescTest</soft-descriptor>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <vaulted-shopper-id>20769005</vaulted-shopper-id>\\n   <credit-card>\\n      <card-last-four-digits>9299</card-last-four-digits>\\n      <card-type>VISA</card-type>\\n      <card-sub-type>CREDIT</card-sub-type>\\n      <card-category>CLASSIC</card-category>\\n   </credit-card>\\n   <processing-info>\\n      <processing-status>success</processing-status>\\n      <cvv-response-code>MA</cvv-response-code>\\n      <avs-response-code-zip>M</avs-response-code-zip>\\n      <avs-response-code-address>M</avs-response-code-address>\\n      <avs-response-code-name>U</avs-response-code-name>\\n   </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - vaulted shopper & CVV\"\n    },\n    {\n      \"code\": \"<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n  <transaction-id>1014303131</transaction-id>\\n  <recurring-transaction>ECOMMERCE</recurring-transaction>\\n  <soft-descriptor>BLS&#x2a;DescTest</soft-descriptor>\\n  <amount>11.00</amount>\\n  <currency>USD</currency>\\n  <vaulted-shopper-id>20769005</vaulted-shopper-id>\\n  <credit-card>\\n      <card-last-four-digits>0026</card-last-four-digits>\\n      <card-type>VISA</card-type>\\n      <card-sub-type>CREDIT</card-sub-type>\\n      <card-category>CLASSIC</card-category>\\n  </credit-card>\\n  <processing-info>\\n      <processing-status>success</processing-status>\\n      <cvv-response-code>ND</cvv-response-code>\\n      <avs-response-code-zip>U</avs-response-code-zip>\\n      <avs-response-code-address>U</avs-response-code-address>\\n      <avs-response-code-name>U</avs-response-code-name>\\n  </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - with vaulted shopper & new card \"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##Example Descriptions\nFor details about the above examples, see:\n  * [Basic Auth Only with fraud info](#section-basic-auth-only-with-fraud-info)\n  * [Auth Only with vaulted shopper](#section-auth-only-with-vaulted-shopper)  \n  * [Auth Only with metadata](#section-auth-only-with-metadata) \n  * [Auth Only with Merchant Transaction ID](#section-auth-only-with-merchant-transaction-id) \n  * [Auth Only with wallet ID](#section-auth-only-with-wallet-id)\n  * [Auth Only with encrypted credit card](#section-auth-only-with-encrypted-credit-card) \n  * [Auth Only with Hosted Payment Fields token](#section-auth-only-with-hosted-payment-fields-token)\n  * [Auth Only with Vendor Info](#section-auth-only-with-vendor-info)\n  * [Auth Only with Apple Pay](#section-auth-only-with-apple-pay)\n  * [Auth Only with vaulted shopper & CVV](#section-auth-only-with-vaulted-shopper-cvv)\n  * [Auth only with vaulted shopper & new card](#section-auth-only-with-vaulted-shopper-new-card)\n\n###Basic Auth Only with fraud info\nThis example shows a basic Auth Only request, containing the minimum required fields for a one-time payment using a credit card. It includes the required fraud info in the`transaction-fraud-info` property within the [card-transaction](doc:card-transaction) resource in your Auth Only request. See [transaction-fraud-info](doc:transaction-fraud-info).\n\nAn additional example with enterprise fraud info is above. Enterprise fraud info is supported only for merchants who have signed up for the Enterprise-level fraud service from BlueSnap. See [Fraud prevention](/v1.0/docs/fraud-prevention).\n\n###Auth Only with vaulted shopper\nTo perform an Auth Only request with an existing vaulted shopper, you'll need to include the `vaulted-shopper-id` property within the [card-transaction](doc:card-transaction) resource in your request. When specifying a credit card for a vaulted shopper, you must include the `card-last-four-digits` and `card-type` properties within the [credit-card](doc:credit-card) resource.\n\nAbove are two vaulted shopper examples. The first is with a vaulted shopper who only has one credit card, so there is no need to specify which credit card to charge. The second is with a vaulted shopper who has multiple cards, so the request must indicate which card to charge.\n\n###Auth Only with metadata\nTo send metadata for the transaction, you'll need to include the `transaction-meta-data` property within the [card-transaction](doc:card-transaction) resource in your Auth Only request. You can include up to 20 metadata key-value pairs in each `transaction-meta-data` property. See [transaction-meta-data](doc:transaction-meta-data). \n\nAbove is an example of a request with metadata, including state tax, city tax, and the shipping amount.\n\n###Auth Only with Merchant Transaction ID\nYou may wish to assign your own ID to each transaction, for example in order to track the transactions in your own internal systems. To do this, you'll need to include the `merchant-transaction-id` property within the [card-transaction](doc:card-transaction) resource in your Auth Only request.\n\nAbove is an example of a request that includes a Merchant Transaction ID (MTI), along with the minimum required fields for a one-time payment using a credit card. \n\n###Auth Only with wallet ID\nIf the shopper is paying via a wallet (e.g. MasterPass or Visa Checkout), you can include the `wallet-id`in the request. For details, see:\n  * [MasterPass Guide](/v1.0/docs/masterpass)\n  * [Visa Checkout Guide](/v1.0/docs/visa-checkout)\n\nAbove is an example of a request with a MasterPass wallet.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"When you include the wallet ID in the request, a vaulted shopper will be automatically created and the vaulted shopper ID will be returned to you in the response.\\n\\nIf you prefer to save the wallet information in an existing shopper, it is recommended to instead send a [Create Vaulted Shopper](doc:create-vaulted-shopper) request with the wallet ID and then use that vaulted shopper in your Auth Only request.\",\n  \"title\": \"Note\"\n}\n[/block]\n###Auth Only with encrypted credit card\nYour [PCI compliance](/v1.0/docs/pci-compliance) requirements and API permission level may require that you send credit card data in encrypted format only. To do this, you'll need to include the`encrypted-card-number` and `encrypted-security-code` properties within the [card-transaction](doc:card-transaction) resource in your request.\n\nAbove is an example of a request with an encrypted credit card number.\n\n###Auth Only with Hosted Payment Fields token\nIf you are using BlueSnap's [Hosted Payment Fields](/v4.0/docs/hosted-payment-fields), you can process the shopper's payment using the information from the Hosted Payment Fields by including the token within the `pf-token` property in your request.\n\nAbove is an example of a request with the Hosted Payment Fields token.\n\nNote that the response will look like a regular response for a credit card, with the card's last four digits and card type.\n\n###Auth Only with Vendor Info\nThis example shows an Auth Only request for a marketplace vendor. If you are a marketplace merchant and would like to link a vendor to the transaction in the authorization step, you will include `vendor-info` in the body.\n\nIn the above request example, only the required `vendor-id` is included in the `vendor-info` container. By leaving out the `commission-percent` property, the transaction will default to the value set during the creation of the vendor. \n\nFor more information, check out the [Marketplace Guide](/v1.0/docs/processing-transactions#section-card-transactions). \n\n###Auth Only with Apple Pay \nThis example shows an Auth Only request with Apple Pay. In the request, include `encoded-payment-token` inside `wallet` > `apple-pay`. Instructions on how to extract the `encoded-payment-token` can be found in the [Apple Pay Guide](/v1.0/docs/apple-pay#section-implementing-apple-pay-in-your-website-or-ios-app). \n\n**Note**: To test Apple Pay, follow the steps in the [Apple Pay Guide](/v1.0/docs/apple-pay#section-implementing-apple-pay-in-your-website-or-ios-app). The API Explorer does not support Apple Pay testing. \n\n###Auth Only with vaulted shopper & CVV\nYou may wish to collect CVV on your checkout form from all your shoppers – even from returning shoppers. One reason you might choose to do this is because transactions with CVV generally result in higher success rates. \n\nAbove is an example of sending CVV in a transaction request involving a returning shopper. \nInclude `vaulted-shopper-id` and CVV in the request as in the example. \n\n###Auth Only with vaulted shopper & new card \nThis example shows an Auth Only request with a vaulted shopper and a new card. If you include `vaulted-shopper-id` and a new card in the request, the shopper's card will be charged and the card details will be added to the shopper. \n\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##API Explorer\nTo test out a call, enter the XML portion of the request below and then click **Try it!**\n\n**Tip:** Copy the XML portion from one of the example requests above, or use the XML code below as a starting point. You can enter different parameters and test credit card numbers to see how your test scenario would work. *The request headers, including authorization, are already built in for you in this test area, so you should not include them here.*\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>AUTH_ONLY</card-transaction-type>\\n   <recurring-transaction>ECOMMERCE</recurring-transaction>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <card-holder-info>\\n     <first-name>test first name</first-name>\\n     <last-name>test last name</last-name>\\n     <zip>123456</zip>\\n  </card-holder-info>\\n   <credit-card>\\n      <card-number>4263982640269299</card-number>\\n      <security-code>837</security-code>\\n      <expiration-month>02</expiration-month>\\n      <expiration-year>2018</expiration-year>\\n   </credit-card>\\n</card-transaction>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"auth-only","type":"post","title":"Auth Only"}

Definition

{{ api_url }}{{ page_api_url }}

Documentation

Auth Only is a request to check whether a credit card is valid and has the funds to complete a specific transaction (i.e. purchase). It does not actually run the charge on the card, but does temporarily hold the funds aside. Note that each credit card company will only hold the authorization for a limited period (for example, 3-10 days, depending on the credit card scheme).

Zero value auth for card validity checks

If you wish to check the validity of a card without authorizing any charge amount, simply enter 0 as the value for the amount property in this request.

Try it in the API Explorer

Request Content

card-transaction container    required, contains the following properties (see card-transaction):
      card-transaction-type string    required, value must be AUTH_ONLY
      merchant-transaction-id string    optional
      recurring-transaction string    required
      soft-descriptor string    optional
      vendor-info container   optional    applicable if using marketplace vendor (see vendor-info)
      amount decimal    required (use an amount of 0 to perform a card validation request)
      currency string    required
      vaulted-shopper-id integer    required if using a vaulted shopper
      card-holder-info container    required if sending card data or pf-token and shopper is new (see card-holder-info)
      wallet-id long    required if using MasterPass or Visa Checkout
      wallet container    required if using Apple Pay      (see wallet)
      transaction-fraud-info container    optional (see transaction-fraud-info)
      credit-card container    required if sending card or if vaulted shopper has multiple cards - do not include if using Hosted Payment Fields or wallet (see credit-card)
      pf-token string    required if using Hosted Payment Fields
      transaction-meta-data container    optional (see transaction-meta-data)

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains a card-transaction resource (see card-transaction) with the request properties plus these additions:
      transaction-id
      vaulted-shopper-id
      processing-info
      fraud-result-info if fraud prevention is enabled
      vendor-info if using marketplace vendor


Examples

Request Examples

curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <soft-descriptor>DescTest</soft-descriptor>
   <amount>11.00</amount>
   <currency>USD</currency>
   <card-holder-info>
      <first-name>test first name</first-name>
      <last-name>test last name</last-name>
      <zip>123456</zip>
   </card-holder-info>
   <credit-card>
      <card-number>4263982640269299</card-number>
      <security-code>837</security-code>
      <expiration-month>02</expiration-month>
      <expiration-year>2018</expiration-year>
   </credit-card>
   <transaction-fraud-info>
      <fraud-session-id>1234</fraud-session-id>
      <shopper-ip-address>123.12.134.1</shopper-ip-address>
      <company>BBBBB</company>
      <shipping-contact-info>
         <last-name>LL</last-name>
         <first-name>YY</first-name>
         <country>US</country>
         <state>AL</state>
         <city>Juneau</city>
         <address1>Address1</address1>
         <address2>Address2</address2>
         <zip>12345</zip>
      </shipping-contact-info>
   </transaction-fraud-info>
</card-transaction>
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<?xml version="1.0" encoding="UTF-8"?>
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <soft-descriptor>DescTest</soft-descriptor>
   <amount>11.00</amount>
   <currency>USD</currency>
   <card-holder-info>
      <first-name>test first name</first-name>
      <last-name>test last name</last-name>
      <zip>123456</zip>
   </card-holder-info>
   <credit-card>
      <card-number>4263982640269299</card-number>
      <security-code>837</security-code>
      <expiration-month>02</expiration-month>
      <expiration-year>2018</expiration-year>
   </credit-card>
   <transaction-fraud-info>
      <fraud-session-id>1234</fraud-session-id>
      <shopper-ip-address>123.12.134.1</shopper-ip-address>
      <company>BBBBB</company>
      <shipping-contact-info>
         <last-name>LL</last-name>
         <first-name>YY</first-name>
         <country>US</country>
         <state>AL</state>
         <city>Juneau</city>
         <address1>Address1</address1>
         <address2>Address2</address2>
         <zip>12345</zip>
      </shipping-contact-info>
      <enterprise-site-id>DEFAULT</enterprise-site-id>
      <enterprise-udfs>
         <udf>
            <udf-name>ENT_UDF1</udf-name>
            <udf-value>aaa</udf-value>
         </udf>
         <udf>
            <udf-name>ENT_UDF2</udf-name>
            <udf-value>bbb</udf-value>
         </udf>
      </enterprise-udfs>
   </transaction-fraud-info>
</card-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <soft-descriptor>DescTest</soft-descriptor>
   <amount>11.00</amount>
   <currency>USD</currency>
   <vaulted-shopper-id>20781033</vaulted-shopper-id>
</card-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <soft-descriptor>DescTest</soft-descriptor>
   <amount>11.00</amount>
   <currency>USD</currency>
   <vaulted-shopper-id>20769005</vaulted-shopper-id>
   <credit-card>
      <card-last-four-digits>9299</card-last-four-digits>
      <card-type>VISA</card-type>
   </credit-card>
</card-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<?xml version="1.0" encoding="UTF-8"?>
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <soft-descriptor>DescTest</soft-descriptor>
   <amount>11.00</amount>
   <currency>USD</currency>
   <card-holder-info>
      <first-name>test first name</first-name>
      <last-name>test last name</last-name>
      <zip>123456</zip>
   </card-holder-info>
   <credit-card>
     <card-number>4263982640269299</card-number>
      <security-code>837</security-code>
      <expiration-month>02</expiration-month>
      <expiration-year>2018</expiration-year>
   </credit-card>
   <transaction-meta-data>
      <meta-data>
         <meta-key>stateTaxAmount</meta-key>
         <meta-value>20.00</meta-value>
         <meta-description>State Tax Amount</meta-description>
      </meta-data>
      <meta-data>
         <meta-key>cityTaxAmount</meta-key>
         <meta-value>20.00</meta-value>
         <meta-description>City Tax Amount</meta-description>
      </meta-data>
      <meta-data>
         <meta-key>shippingAmount</meta-key>
         <meta-value>10.00</meta-value>
         <meta-description>Shipping Amount</meta-description>
      </meta-data>
   </transaction-meta-data>
</card-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <merchant-transaction-id>3</merchant-transaction-id>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <amount>11.00</amount>
   <currency>USD</currency>
   <card-holder-info>
      <first-name>test first name</first-name>
      <last-name>test last name</last-name>
      <zip>123456</zip>
   </card-holder-info>
   <credit-card>
     <card-number>4263982640269299</card-number>
      <security-code>837</security-code>
      <expiration-month>02</expiration-month>
      <expiration-year>2018</expiration-year>
   </credit-card>
</card-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<?xml version="1.0" encoding="UTF-8"?>
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <amount>11.00</amount>
   <currency>USD</currency>
   <wallet-id>21</wallet-id>
</card-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<?xml version="1.0" encoding="UTF-8"?>
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <soft-descriptor>DescTest</soft-descriptor>
   <amount>11.00</amount>
   <currency>USD</currency>
   <card-holder-info>
      <first-name>test first name</first-name>
      <last-name>test last name</last-name>
      <zip>123456</zip>
   </card-holder-info>
   <credit-card>
      <encrypted-card-number>$bsjs_1_0_3$B23uuxq8drUwOYZm3wZi+Qm69V5GPEt8PEio+Edwcm8akczQSK7odgLQH/Au+VqOCsGspW1Q9mPyQIzGLSZLVToAQVfq5C1ld+2ogIIsDL32Hd6IojboLyVlYT1FvPQoDyz19K6N0CUHh5uk0kCLuHSUyjvoJH38ojHZifbJSm/7S5vAtiuC3BJt2z8k9nauQaAXkbyoAYwrS1yDpqOt2k2lGhKcmdQ4ImDR0RL8m8xig6sFrki9oqo3Mju/M5r7wXXVTf7TMtWiQbzdfREOxKUnviXJZpncdHqVjj5GvPYun2qgopKVKr8F5+yd19TVW2gvA1kXBkXonFL9159Gxg==$zckJgo2i8jXDiAHwVVHBKypXFnWqF2e+6luBkmtQQRKniDXyXaalRVKLtYscBaGd$W7Ojqk1Q2iOJVeGL39RAsZTtfup3f1deSzvxrvC9rXA=</encrypted-card-number>
      <encrypted-security-code>$bsjs_1_0_3$MB1nBpok/YkuWPG1/7e6dyFFhDPHB8p8E9Yo+0YHHV+xkHuzFKr02wAnE8PJ8QCzWH+2ctXy5FN6wLKjwFrfTOgy0BJ9k9+NDEe8mhsu66wMlyc3lnwrbvMRCWN1O+5gUNCFExj7B0mDtf4gtxecXs74KZ5l5dbpGWdKUk5i7OewWyTqsONbn9taLfVBOwuIOy2Jgi4fx+yB8Q05KdZeHSNSBJh8H/47AUNAn5dM+d9iO6yGQB3obzEzzR3UtHlkGR52ZsgbbFh0JMm9lBM2ClgYM8jvmQjS9HX2ojt1fkbhuPEb1IY/M498a+1wDPpI4aMfDxO1lSpJneRSpY5k4g==$XaKq1NbPcS0iHy9N9jHekEIByHYS4G3wJXlC9EQjAGM=$BJn6X6mBYGUo8Eoq4RQz69gsi4Azl8jT973mNpG9Yuo=</encrypted-security-code>
      <expiration-month>07</expiration-month>
      <expiration-year>2016</expiration-year>
   </credit-card>
</card-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<?xml version="1.0" encoding="UTF-8"?>
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <soft-descriptor>DescTest</soft-descriptor>
   <amount>11.00</amount>
   <currency>USD</currency>
   <card-holder-info>
      <first-name>test first name</first-name>
      <last-name>test last name</last-name>
      <zip>123456</zip>
   </card-holder-info>
   <pf-token>abcde12345**********</pf-token>
</card-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <soft-descriptor>DescTest</soft-descriptor>
   <vendor-info>
      <vendor-id>514147</vendor-id>
   </vendor-info> 
   <amount>11.00</amount>
   <currency>USD</currency>
   <card-holder-info>
      <first-name>test first name</first-name>
      <last-name>test last name</last-name>
      <zip>123456</zip>
   </card-holder-info>
   <credit-card>
      <card-number>4263982640269299</card-number>
      <security-code>837</security-code>
      <expiration-month>02</expiration-month>
      <expiration-year>2018</expiration-year>
   </credit-card>
</card-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
  <card-transaction-type>AUTH_ONLY</card-transaction-type>
  <recurring-transaction>ECOMMERCE</recurring-transaction>
  <soft-descriptor>DescTest</soft-descriptor>
  <amount>11.00</amount>
  <currency>USD</currency>
  <wallet>
    <apple-pay>
      <encoded-payment-token>ImRhdGEiOiJuY1AvRitIUy8zeG5bXhCMFd</encoded-payment-token>
    </apple-pay>	
  </wallet>
</card-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
  <card-transaction-type>AUTH_ONLY</card-transaction-type>
  <recurring-transaction>ECOMMERCE</recurring-transaction>
  <soft-descriptor>DescTest</soft-descriptor>
  <amount>11.00</amount>
  <currency>USD</currency>
  <vaulted-shopper-id>20769005</vaulted-shopper-id>
  <credit-card>
    <card-last-four-digits>9299</card-last-four-digits>
    <card-type>VISA</card-type>
    <security-code>837</security-code>
  </credit-card>
</card-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <soft-descriptor>DescTest</soft-descriptor>
   <amount>11.00</amount>
   <currency>USD</currency>
   <vaulted-shopper-id>20769005</vaulted-shopper-id>
   <credit-card>
      <card-number>4012000033330026</card-number>
      <security-code>111</security-code>
      <expiration-month>07</expiration-month>
      <expiration-year>2019</expiration-year>
   </credit-card>
</card-transaction>'

Response Examples

HTTP/ 1.1 200 OK

<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <transaction-id>38488222</transaction-id>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <soft-descriptor>BLS*DescTest</soft-descriptor>
   <amount>11.00</amount>
   <currency>USD</currency>
   <vaulted-shopper-id>1234</vaulted-shopper-id>
   <card-holder-info>
     	<first-name>test first name</first-name>
     	<last-name>test last name</last-name>
     	<zip>123456</zip>
   </card-holder-info>
   <credit-card>
      <card-last-four-digits>9299</card-last-four-digits>
      <card-type>VISA</card-type>
      <card-sub-type>CREDIT</card-sub-type>
      <card-category>CLASSIC</card-category>
   </credit-card>
   <processing-info>
      <processing-status>success</processing-status>
      <cvv-response-code>MA</cvv-response-code>
      <avs-response-code-zip>M</avs-response-code-zip>
      <avs-response-code-address>M</avs-response-code-address>
      <avs-response-code-name>U</avs-response-code-name>
   </processing-info>
   <fraud-result-info>
      <device-data-collector>Y</device-data-collector>
   </fraud-result-info>
</card-transaction>
HTTP/ 1.1 200 OK

<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <transaction-id>38488224</transaction-id>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <soft-descriptor>BLS*DescTest</soft-descriptor>
   <amount>11.00</amount>
   <currency>USD</currency>
   <vaulted-shopper-id>19549066</vaulted-shopper-id>
   <credit-card>
      <card-last-four-digits>9299</card-last-four-digits>
      <card-type>VISA</card-type>
      <card-sub-type>CREDIT</card-sub-type>
      <card-category>CLASSIC</card-category>
   </credit-card>
   <processing-info>
      <processing-status>success</processing-status>
      <avs-response-code-zip>M</avs-response-code-zip>
      <avs-response-code-address>M</avs-response-code-address>
      <avs-response-code-name>U</avs-response-code-name>
   </processing-info>
</card-transaction>
HTTP/ 1.1 200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<card-transaction xmlns="http://ws.plimus.com">
    <card-transaction-type>AUTH_ONLY</card-transaction-type>
    <transaction-id>38497126</transaction-id>
    <recurring-transaction>ECOMMERCE</recurring-transaction>
    <soft-descriptor>BLS*DescTest</soft-descriptor>
    <amount>11.00</amount>
    <currency>USD</currency>
    <vaulted-shopper-id>1234</vaulted-shopper-id>
    <avs-response-code>G</avs-response-code>
    <card-holder-info>
        <first-name>test first name</first-name>
        <last-name>test last name</last-name>
      	<zip>123456</zip>
    </card-holder-info>
    <credit-card>
        <card-last-four-digits>9299</card-last-four-digits>
        <card-type>VISA</card-type>
        <card-sub-type>CREDIT</card-sub-type>
        <card-category>CLASSIC</card-category>
    </credit-card>
    <transaction-meta-data>
        <meta-data>
            <meta-key>stateTaxAmount</meta-key>
            <meta-value>20.00</meta-value>
            <meta-description>State Tax Amount</meta-description>
        </meta-data>
        <meta-data>
            <meta-key>cityTaxAmount</meta-key>
            <meta-value>20.00</meta-value>
            <meta-description>City Tax Amount</meta-description>
        </meta-data>
        <meta-data>
            <meta-key>shippingAmount</meta-key>
            <meta-value>10.00</meta-value>
            <meta-description>Shipping Amount</meta-description>
        </meta-data>
    </transaction-meta-data>
    <processing-info>
        <processing-status>success</processing-status>
        <cvv-response-code>MA</cvv-response-code>
        <avs-response-code-zip>U</avs-response-code-zip>
        <avs-response-code-address>U</avs-response-code-address>
        <avs-response-code-name>U</avs-response-code-name>
    </processing-info>
</card-transaction>
HTTP/ 1.1 200 OK

<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <merchant-transaction-id>3</merchant-transaction-id>
   <transaction-id>38488150</transaction-id>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <amount>11.00</amount>
   <currency>USD</currency>
   <vaulted-shopper-id>1234</vaulted-shopper-id>
   <card-holder-info>
     <first-name>test first name</first-name>
     <last-name>test last name</last-name>
     <zip>123456</zip>
   </card-holder-info>
   <credit-card>
      <card-last-four-digits>9299</card-last-four-digits>
      <card-type>VISA</card-type>
      <card-sub-type>CREDIT</card-sub-type>
      <card-category>CLASSIC</card-category>
   </credit-card>
   <processing-info>
      <processing-status>success</processing-status>
      <cvv-response-code>MA</cvv-response-code>
      <avs-response-code-zip>M</avs-response-code-zip>
      <avs-response-code-address>M</avs-response-code-address>
      <avs-response-code-name>U</avs-response-code-name>
   </processing-info>
</card-transaction>
HTTP/ 1.1 200 OK

<card-transaction xmlns="http://ws.plimus.com">
  <card-transaction-type>AUTH_ONLY</card-transaction-type>
  <transaction-id>1011702615</transaction-id>
  <recurring-transaction>ECOMMERCE</recurring-transaction>
  <amount>11.00</amount>
  <currency>USD</currency>
  <vaulted-shopper-id>123</vaulted-shopper-id>
  <card-holder-info>
	  <first-name>test first name</first-name>
	  <last-name>test last name</last-name>
  </card-holder-info>
  <credit-card>
	  <card-last-four-digits>9299</card-last-four-digits>
	  <card-type>VISA</card-type>
	  <card-sub-type>CREDIT</card-sub-type>
    <card-category>CLASSIC</card-category>
  </credit-card>
  <processing-info>
	  <processing-status>success</processing-status>
	  <cvv-response-code>NC</cvv-response-code>
  </processing-info>
</card-transaction>
HTTP/ 1.1 200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<card-transaction xmlns="http://ws.plimus.com">
    <card-transaction-type>AUTH_ONLY</card-transaction-type>
    <transaction-id>38504158</transaction-id>
    <recurring-transaction>ECOMMERCE</recurring-transaction>
    <soft-descriptor>BLS*DescTest</soft-descriptor>
    <amount>11.00</amount>
    <currency>USD</currency>
    <vaulted-shopper-id>1234</vaulted-shopper-id>
    <card-holder-info>
        <first-name>test first name</first-name>
        <last-name>test last name</last-name>
      	<zip>123456</zip>
    </card-holder-info>
    <credit-card>
        <card-last-four-digits>1111</card-last-four-digits>
        <card-type>VISA</card-type>
        <card-sub-type>CREDIT</card-sub-type>
        <card-category>CLASSIC</card-category>
    </credit-card>
    <processing-info>
        <processing-status>success</processing-status>
        <cvv-response-code>ND</cvv-response-code>
        <avs-response-code-zip>U</avs-response-code-zip>
        <avs-response-code-address>U</avs-response-code-address>
        <avs-response-code-name>U</avs-response-code-name>
    </processing-info>
</card-transaction>
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <transaction-id>38486450</transaction-id>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <soft-descriptor>BLS*DescTest</soft-descriptor>
   <amount>11.00</amount>
   <currency>USD</currency>
   <vaulted-shopper-id>1234</vaulted-shopper-id>
   <card-holder-info>
     <first-name>test first name</first-name>
     <last-name>test last name</last-name>
     <zip>123456</zip>
   </card-holder-info>
   <credit-card>
      <card-last-four-digits>9299</card-last-four-digits>
      <card-type>VISA</card-type>
      <card-sub-type>CREDIT</card-sub-type>
      <card-category>CLASSIC</card-category>
   </credit-card>
   <processing-info>
      <processing-status>success</processing-status>
      <cvv-response-code>MA</cvv-response-code>
      <avs-response-code-zip>M</avs-response-code-zip>
      <avs-response-code-address>M</avs-response-code-address>
      <avs-response-code-name>U</avs-response-code-name>
   </processing-info>
</card-transaction>
<card-transaction xmlns="http://ws.plimus.com">
	<card-transaction-type>AUTH_ONLY</card-transaction-type>
	<vendor-info>
		<vendor-id>514147</vendor-id>
		<commission-percent>20</commission-percent>
	</vendor-info>
	<transaction-id>1013344071</transaction-id>
	<recurring-transaction>ECOMMERCE</recurring-transaction>
	<soft-descriptor>BLS&#x2a;DescTest</soft-descriptor>
	<amount>11.00</amount>
	<currency>USD</currency>
	<card-holder-info>
		<first-name>test first name</first-name>
		<last-name>test last name</last-name>
		<zip>123456</zip>
	</card-holder-info>
	<vaulted-shopper-id>21523967</vaulted-shopper-id>
	<credit-card>
		<card-last-four-digits>9299</card-last-four-digits>
		<card-type>VISA</card-type>
		<card-sub-type>CREDIT</card-sub-type>
    <card-category>CLASSIC</card-category>
	</credit-card>
	<processing-info>
		<processing-status>success</processing-status>
		<cvv-response-code>MA</cvv-response-code>
		<avs-response-code-zip>U</avs-response-code-zip>
		<avs-response-code-address>U</avs-response-code-address>
		<avs-response-code-name>U</avs-response-code-name>
	</processing-info>
</card-transaction>
<card-transaction xmlns="http://ws.plimus.com">
  <card-transaction-type>AUTH_ONLY</card-transaction-type>
  <transaction-id>38486450</transaction-id>
  <recurring-transaction>ECOMMERCE</recurring-transaction>
  <soft-descriptor>BLS*DescTest</soft-descriptor>
  <amount>11.00</amount>
  <currency>USD</currency>
  <vaulted-shopper-id>1234</vaulted-shopper-id>
  <Wallet>
    <billing-contact-info>
      <first-name>John</first-name>
      <last-name>Doe</last-name>
      <address1>South St</address1>
      <city>Waltham</city>
      <state>MA</state>
      <zip>02453</zip>
    </billing-contact-info>
    <apple-pay>
      <card-last-four-digits>0492</card-last-four-digits>
      <card-type>VISA</card-type>
      <card-sub-type>DEBIT</card-sub-type>
      <dpan-last-four-digits>4109</dpan-last-four-digits>
      <dpan-expiration-month>11</dpan-expiration-month>
      <dpan-expiration-year>25</dpan-expiration-year>
    </apple-pay>	
  </Wallet>
  <processing-info>
    <processing-status>success</processing-status>
    <cvv-response-code>MA</cvv-response-code>
    <avs-response-code-zip>M</avs-response-code-zip>
    <avs-response-code-address>M</avs-response-code-address>
    <avs-response-code-name>U</avs-response-code-name>
  </processing-info>
</card-transaction>
<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <transaction-id>38486450</transaction-id>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <soft-descriptor>BLS*DescTest</soft-descriptor>
   <amount>11.00</amount>
   <currency>USD</currency>
   <vaulted-shopper-id>20769005</vaulted-shopper-id>
   <credit-card>
      <card-last-four-digits>9299</card-last-four-digits>
      <card-type>VISA</card-type>
      <card-sub-type>CREDIT</card-sub-type>
      <card-category>CLASSIC</card-category>
   </credit-card>
   <processing-info>
      <processing-status>success</processing-status>
      <cvv-response-code>MA</cvv-response-code>
      <avs-response-code-zip>M</avs-response-code-zip>
      <avs-response-code-address>M</avs-response-code-address>
      <avs-response-code-name>U</avs-response-code-name>
   </processing-info>
</card-transaction>
<card-transaction xmlns="http://ws.plimus.com">
  <card-transaction-type>AUTH_ONLY</card-transaction-type>
  <transaction-id>1014303131</transaction-id>
  <recurring-transaction>ECOMMERCE</recurring-transaction>
  <soft-descriptor>BLS&#x2a;DescTest</soft-descriptor>
  <amount>11.00</amount>
  <currency>USD</currency>
  <vaulted-shopper-id>20769005</vaulted-shopper-id>
  <credit-card>
      <card-last-four-digits>0026</card-last-four-digits>
      <card-type>VISA</card-type>
      <card-sub-type>CREDIT</card-sub-type>
      <card-category>CLASSIC</card-category>
  </credit-card>
  <processing-info>
      <processing-status>success</processing-status>
      <cvv-response-code>ND</cvv-response-code>
      <avs-response-code-zip>U</avs-response-code-zip>
      <avs-response-code-address>U</avs-response-code-address>
      <avs-response-code-name>U</avs-response-code-name>
  </processing-info>
</card-transaction>

Back to Top


Example Descriptions

For details about the above examples, see:

Basic Auth Only with fraud info

This example shows a basic Auth Only request, containing the minimum required fields for a one-time payment using a credit card. It includes the required fraud info in thetransaction-fraud-info property within the card-transaction resource in your Auth Only request. See transaction-fraud-info.

An additional example with enterprise fraud info is above. Enterprise fraud info is supported only for merchants who have signed up for the Enterprise-level fraud service from BlueSnap. See Fraud prevention.

Auth Only with vaulted shopper

To perform an Auth Only request with an existing vaulted shopper, you'll need to include the vaulted-shopper-id property within the card-transaction resource in your request. When specifying a credit card for a vaulted shopper, you must include the card-last-four-digits and card-type properties within the credit-card resource.

Above are two vaulted shopper examples. The first is with a vaulted shopper who only has one credit card, so there is no need to specify which credit card to charge. The second is with a vaulted shopper who has multiple cards, so the request must indicate which card to charge.

Auth Only with metadata

To send metadata for the transaction, you'll need to include the transaction-meta-data property within the card-transaction resource in your Auth Only request. You can include up to 20 metadata key-value pairs in each transaction-meta-data property. See transaction-meta-data.

Above is an example of a request with metadata, including state tax, city tax, and the shipping amount.

Auth Only with Merchant Transaction ID

You may wish to assign your own ID to each transaction, for example in order to track the transactions in your own internal systems. To do this, you'll need to include the merchant-transaction-id property within the card-transaction resource in your Auth Only request.

Above is an example of a request that includes a Merchant Transaction ID (MTI), along with the minimum required fields for a one-time payment using a credit card.

Auth Only with wallet ID

If the shopper is paying via a wallet (e.g. MasterPass or Visa Checkout), you can include the wallet-idin the request. For details, see:

Above is an example of a request with a MasterPass wallet.

Note

When you include the wallet ID in the request, a vaulted shopper will be automatically created and the vaulted shopper ID will be returned to you in the response.

If you prefer to save the wallet information in an existing shopper, it is recommended to instead send a Create Vaulted Shopper request with the wallet ID and then use that vaulted shopper in your Auth Only request.

Auth Only with encrypted credit card

Your PCI compliance requirements and API permission level may require that you send credit card data in encrypted format only. To do this, you'll need to include theencrypted-card-number and encrypted-security-code properties within the card-transaction resource in your request.

Above is an example of a request with an encrypted credit card number.

Auth Only with Hosted Payment Fields token

If you are using BlueSnap's Hosted Payment Fields, you can process the shopper's payment using the information from the Hosted Payment Fields by including the token within the pf-token property in your request.

Above is an example of a request with the Hosted Payment Fields token.

Note that the response will look like a regular response for a credit card, with the card's last four digits and card type.

Auth Only with Vendor Info

This example shows an Auth Only request for a marketplace vendor. If you are a marketplace merchant and would like to link a vendor to the transaction in the authorization step, you will include vendor-info in the body.

In the above request example, only the required vendor-id is included in the vendor-info container. By leaving out the commission-percent property, the transaction will default to the value set during the creation of the vendor.

For more information, check out the Marketplace Guide.

Auth Only with Apple Pay

This example shows an Auth Only request with Apple Pay. In the request, include encoded-payment-token inside wallet > apple-pay. Instructions on how to extract the encoded-payment-token can be found in the Apple Pay Guide.

Note: To test Apple Pay, follow the steps in the Apple Pay Guide. The API Explorer does not support Apple Pay testing.

Auth Only with vaulted shopper & CVV

You may wish to collect CVV on your checkout form from all your shoppers – even from returning shoppers. One reason you might choose to do this is because transactions with CVV generally result in higher success rates.

Above is an example of sending CVV in a transaction request involving a returning shopper.
Include vaulted-shopper-id and CVV in the request as in the example.

Auth Only with vaulted shopper & new card

This example shows an Auth Only request with a vaulted shopper and a new card. If you include vaulted-shopper-id and a new card in the request, the shopper's card will be charged and the card details will be added to the shopper.



Back to Top


API Explorer

To test out a call, enter the XML portion of the request below and then click Try it!

Tip: Copy the XML portion from one of the example requests above, or use the XML code below as a starting point. You can enter different parameters and test credit card numbers to see how your test scenario would work. The request headers, including authorization, are already built in for you in this test area, so you should not include them here.

<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <recurring-transaction>ECOMMERCE</recurring-transaction>
   <amount>11.00</amount>
   <currency>USD</currency>
   <card-holder-info>
     <first-name>test first name</first-name>
     <last-name>test last name</last-name>
     <zip>123456</zip>
  </card-holder-info>
   <credit-card>
      <card-number>4263982640269299</card-number>
      <security-code>837</security-code>
      <expiration-month>02</expiration-month>
      <expiration-year>2018</expiration-year>
   </credit-card>
</card-transaction>

User Information

Try It Out


post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}