Auth Only

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.

Note that the payment method will not be stored.

Try it in the API Explorer

Request Content

card-transaction container    required, contains the following properties (refer to card-transaction):
     card-transaction-type string    required, value must be AUTH_ONLY
     merchant-transaction-id string    optional
     soft-descriptor string    optional
     descriptor-phone-number string    optional
     vendors-info container   optional    applicable if using marketplace vendor(s) (refer to vendors-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 for LatAm local processing (refer to card-holder-info)
     wallet-id long    required if using Masterpass or Visa Checkout
     wallet container    required if using Apple Pay or Google Pay™ (refer to wallet)
     transaction-fraud-info container    optional (refer to 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 (refer to credit-card)
     pf-token string    required if using Hosted Payment Fields or Secured Payment Collector
     three-d-secure     container    optional (refer to three-d-secure)
     transaction-meta-data container    optional (refer to transaction-meta-data)
     level-3-data container    optional (refer to level-3-data)
     store-card     boolean    optional (refer to card-transaction)

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains a card-transaction resource (refer to card-transaction) with the request properties plus these additions:
     transaction-id
     vaulted-shopper-id
     processing-info
     fraud-result-info if fraud prevention is enabled
     three-d-secure if sending 3D Secure authentication data
     vendor-info if using marketplace vendor(s)
     level-3-data if sending Level 2/3 data
     store-card if sending store card data

---

Examples

Request Examples

Auth Only Request: with fraud info

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>
   <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>02453</zip>
   </card-holder-info>
   <credit-card>
      <card-number>4263982640269299</card-number>
      <security-code>837</security-code>
      <expiration-month>02</expiration-month>
      <expiration-year>2023</expiration-year>
   </credit-card>
   <transaction-fraud-info>
      <fraud-session-id>1234</fraud-session-id>
      <shopper-ip-address>123.12.134.1</shopper-ip-address>
      <customer-id>121341</customer-id>
      <customer-creation-date>2021-08-05</customer-creation-date>
      <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>02453</zip>
      </shipping-contact-info>
   </transaction-fraud-info>
</card-transaction>'

with fraud info

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>
   <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>02453</zip>
   </card-holder-info>
   <credit-card>
      <card-number>4263982640269299</card-number>
      <security-code>837</security-code>
      <expiration-month>02</expiration-month>
      <expiration-year>2023</expiration-year>
   </credit-card>
   <transaction-fraud-info>
      <fraud-session-id>1234</fraud-session-id>
      <shopper-ip-address>123.12.134.1</shopper-ip-address>
      <customer-id>121341</customer-id>
      <customer-creation-date>2021-08-05</customer-creation-date>
      <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>02453</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>'

with vaulted shopper who has one card

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>
   <soft-descriptor>DescTest</soft-descriptor>
   <amount>11.00</amount>
   <currency>USD</currency>
   <vaulted-shopper-id>20781033</vaulted-shopper-id>
</card-transaction>'

with vaulted shopper and credit card specified

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>
   <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>'

with metadata

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>
   <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>02453</zip>
   </card-holder-info>
   <credit-card>
     <card-number>4263982640269299</card-number>
      <security-code>837</security-code>
      <expiration-month>02</expiration-month>
      <expiration-year>2023</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>'

with Merchant Transaction ID

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>
   <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>02453</zip>
   </card-holder-info>
   <credit-card>
     <card-number>4263982640269299</card-number>
      <security-code>837</security-code>
      <expiration-month>02</expiration-month>
      <expiration-year>2023</expiration-year>
   </credit-card>
</card-transaction>'

with wallet ID

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>
   <amount>11.00</amount>
   <currency>USD</currency>
   <wallet-id>21</wallet-id>
</card-transaction>'

with encrypted credit card

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>
   <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>02453</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>'

with Hosted Payment Fields token

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>
   <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>02453</zip>
   </card-holder-info>
   <pf-token>abcde12345**********</pf-token>
</card-transaction>'

with vendors info

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>
   <soft-descriptor>DescTest</soft-descriptor>
   <vendors-info>
     <vendor-info>
       <vendor-id>10398032</vendor-id>
     </vendor-info> 
   </vendors-info>
   <amount>11.00</amount>
   <currency>USD</currency>
   <card-holder-info>
      <first-name>Jane</first-name>
      <last-name>Shopper</last-name>
      <zip>02453</zip>
   </card-holder-info>
   <credit-card>
      <card-number>4263982640269299</card-number>
      <security-code>837</security-code>
      <expiration-month>02</expiration-month>
      <expiration-year>2023</expiration-year>
   </credit-card>
</card-transaction>'

with Apple Pay

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>
  <soft-descriptor>DescTest</soft-descriptor>
  <amount>11.00</amount>
  <currency>USD</currency>
   <wallet>
    <wallet-type>APPLE_PAY</wallet-type>
    <encoded-payment-token>ImRhdGEiOiJuY1AvRitIUy8zeG5bXhCMFd</encoded-payment-token>
  </wallet>
 </card-transaction>'

with vaulted shopper & CVV

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>
  <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>'

with vaulted shopper & new card

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>
   <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>2023</expiration-year>
   </credit-card>
</card-transaction>'

with store card approval

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>
   <soft-descriptor>DescTest</soft-descriptor>
   <amount>25.00</amount>
   <currency>USD</currency>
   <card-holder-info>
      <first-name>test first name</first-name>
      <last-name>test last name</last-name>
      <zip>02453</zip>
   </card-holder-info>
   <credit-card>
      <card-number>4111 1111 1111 1111</card-number>
      <security-code>111</security-code>
      <expiration-month>12</expiration-month>
      <expiration-year>2023</expiration-year>
   </credit-card>
   <store-card>true</store-card>
</card-transaction>'

with Google Pay

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>
  <soft-descriptor>DescTest</soft-descriptor>
  <amount>11.00</amount>
  <currency>USD</currency>
  <wallet>
    <wallet-type>GOOGLE_PAY</wallet-type>
    <encoded-payment-token>eyJwYXltZW50TWV0aG9kVG9rZW4iOnsidG99</encoded-payment-token>
  </wallet>
</card-transaction>'

Response Examples

200 OK - basic: with fraud info

<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <transaction-id>38488222</transaction-id>
   <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>02453</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>

with vaulted shopper (whether credit card was specified or not)

<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <transaction-id>38488224</transaction-id>
   <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>

with metadata

<card-transaction xmlns="http://ws.plimus.com">
    <card-transaction-type>AUTH_ONLY</card-transaction-type>
    <transaction-id>38497126</transaction-id>
    <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>02453</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>

with Merchant Transaction ID

<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>
   <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>02453</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>

with wallet ID

<card-transaction xmlns="http://ws.plimus.com">
  <card-transaction-type>AUTH_ONLY</card-transaction-type>
  <transaction-id>1011702615</transaction-id>
  <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>

with encrypted credit card

<card-transaction xmlns="http://ws.plimus.com">
    <card-transaction-type>AUTH_ONLY</card-transaction-type>
    <transaction-id>38504158</transaction-id>
    <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>02453</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>

with Hosted Payment Fields

<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <transaction-id>38486450</transaction-id>
   <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>02453</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>

with vendors info

<card-transaction xmlns="http://ws.plimus.com">
  <card-transaction-type>AUTH_ONLY</card-transaction-type>
  <vendor-info>
    <vendor-id>10398032</vendor-id>
    <commission-percent>20</commission-percent>
  </vendor-info>
  <vendors-info>
    <vendor-info>
      <vendor-id>10398032</vendor-id>
      <commission-percent>20</commission-percent>
    </vendor-info>
  </vendors-info>
  <transaction-id>1015600991</transaction-id>
  <soft-descriptor>BLS&#x2a;DescTest</soft-descriptor>
  <amount>11.00</amount>
  <currency>USD</currency>
  <card-holder-info>
    <first-name>Jane</first-name>
    <last-name>Shopper</last-name>
    <zip>02453</zip>
  </card-holder-info>
  <vaulted-shopper-id>22327427</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>GOLD</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>

with Apple Pay

<card-transaction xmlns="http://ws.plimus.com">
  <card-transaction-type>AUTH_ONLY</card-transaction-type>
  <transaction-id>38486450</transaction-id>
  <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>
    <tokenized-card>
      <dpan-expiration-month>7</dpan-expiration-month>
      <dpan-expiration-year>2019</dpan-expiration-year>
      <dpan-last-four-digits>0010</dpan-last-four-digits>
      <card-last-four-digits>1471</card-last-four-digits>
      <card-type>MASTERCARD</card-type>
      <card-sub-type>DEBIT</card-sub-type>
      <bin-category>CONSUMER</bin-category>
      <card-regulated>N</card-regulated>
      <issuing-country-code>us</issuing-country-code>
    </tokenized-card>
  </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>

with vaulted shopper & CVV

<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <transaction-id>38486450</transaction-id>
   <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>

with vaulted shopper & new card

<card-transaction xmlns="http://ws.plimus.com">
  <card-transaction-type>AUTH_ONLY</card-transaction-type>
  <transaction-id>1014303131</transaction-id>
  <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>

with store card approval

<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>AUTH_ONLY</card-transaction-type>
<transaction-id>1016888507</transaction-id>
<soft-descriptor>BLS&#x2a;DescTest</soft-descriptor>
<amount>25.00</amount>
<currency>USD</currency>
<card-holder-info>
<first-name>test first name</first-name>
<last-name>test last name</last-name>
<zip>02453</zip>
</card-holder-info>
<vaulted-shopper-id>22730367</vaulted-shopper-id>
<credit-card>
<card-last-four-digits>1111</card-last-four-digits>
<card-type>VISA</card-type>
<card-sub-type>CREDIT</card-sub-type>
</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>

with Google Pay

<card-transaction>
   <amount>11</amount>
   <cardHolderInfo>
      <firstName>test first name</firstName>
      <lastName>test last name</lastName>
      <zip>02453</zip>
   </cardHolderInfo>
   <cardTransactionType>AUTH_ONLY</cardTransactionType>
   <creditCard>
      <cardCategory>CLASSIC</cardCategory>
      <cardLastFourDigits>9299</cardLastFourDigits>
      <cardSubType>CREDIT</cardSubType>
      <cardType>VISA</cardType>
   </creditCard>
   <currency>USD</currency>
   <processingInfo>
      <processingStatus>success</processingStatus>
   </processingInfo>
   <softDescriptor>BLS&amp;#x2a;DescTest</softDescriptor>
   <transactionId>1012751937</transactionId>
   <vaultedShopperId>21289371</vaultedShopperId>
</card-transaction>

with Google Pay with tokenized card

<card-transaction>
   <amount>11</amount>
   <cardHolderInfo>
      <country>us</country>
      <firstName>test first name</firstName>
      <lastName>test last name</lastName>
      <zip>02453</zip>
   </cardHolderInfo>
   <cardTransactionType>AUTH_ONLY</cardTransactionType>
   <currency>USD</currency>
   <processingInfo>
      <processingStatus>success</processingStatus>
   </processingInfo>
   <softDescriptor>BLS&amp;#x2a;DescTest</softDescriptor>
   <transactionId>1012751937</transactionId>
   <vaultedShopperId>21289371</vaultedShopperId>
   <wallet>
      <billingContactInfo>
         <country>us</country>
         <firstName>test first name</firstName>
         <lastName>test last name</lastName>
         <zip>02453</zip>
      </billingContactInfo>
      <tokenizedCard>
         <cardLastFourDigits>1111</cardLastFourDigits>
         <cardSubType>CREDIT</cardSubType>
         <cardType>VISA</cardType>
         <dpanExpirationMonth>9</dpanExpirationMonth>
         <dpanExpirationYear>2025</dpanExpirationYear>
         <dpanLastFourDigits>2222</dpanLastFourDigits>
      </tokenizedCard>
      <walletType>GOOGLE_PAY</walletType>
   </wallet>
</card-transaction>

with Authorization Code

<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <transaction-id>38488222</transaction-id>
   <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>02453</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>
      <authorization-code>654321</authorization-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>

Back to Top

---

Example Descriptions

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. refer to transaction-fraud-info.

An additional example with Complete fraud info is above. Complete fraud info is supported only for merchants who have signed up for the Complete-level fraud service from BlueSnap. Refer to 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. Refer to 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, refer to :

• Masterpass Guide
• Visa Checkout Guide

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 Vendors Info

This example shows an Auth Only request with a marketplace vendor. If you are a Marketplace Merchant and you would like to link one or more vendors to the transaction in the authorization step, include vendors-info in the body. For more details, refer to the Marketplace Guide.

Auth Only with Apple Pay

This example shows an Auth Only request with Apple Pay. In the request, include wallet-type = APPLE_PAY and encoded-payment-token inside wallet. 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 that 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.

Auth Only with store card approval

This example shows an Auth Only request with the store-card value set. You will want to use this value to define if the shopper has approved storing their credit card information for future use. The default value is set to true. If set to false, the credit card data will not be stored.

Auth Only with Google Pay

This example shows an Auth Only request with Google Pay. In the request, include wallet-type = GOOGLE_PAY and encoded-payment-token inside wallet. Instructions on how to extract the encoded-payment-token can be found in the Google Pay Guide.

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.

XML

<card-transaction xmlns="http://ws.plimus.com">
   <card-transaction-type>AUTH_ONLY</card-transaction-type>
   <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>02453</zip>
  </card-holder-info>
   <credit-card>
      <card-number>4263982640269299</card-number>
      <security-code>837</security-code>
      <expiration-month>02</expiration-month>
      <expiration-year>2023</expiration-year>
   </credit-card>
</card-transaction>