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.


πŸ“˜

Tip

You can test out a request that hits our sandbox in real-time. Follow the instructions here to use the "Try It!" feature on the right side.

Request Content

card-transaction container Β Β Β required, contains the following properties (refer to card-transaction):

Property

Type

Required

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)

πŸ“˜

Note

Non-reusable cards cannot be used as a payment method.

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:

Property

Included if

transaction-id

vaulted-shopper-id

processing-info

if fraud prevention is enabled

fraud-result-info

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

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

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

πŸ“˜

Note

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

πŸ“˜

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.

Back to Top


API Explorer

To test out a basic API request, click the "Try It!" button in the right-hand column to test using the default, pre-populated sample values. To test with your own values, edit the parameter fields below. You'll see them populate in the right-hand column and you can click the "Try It!" button to submit your test request and see a response.

Language
Authentication
Header
Click Try It! to start a request and see the response here!