API BasicsPayment APIEmbedded PaymentsReporting & ToolsSupport GuidesBlueSnap.com
Top of Section

Retrieve

Retrieve is a request that gets details about a past transaction, such as the transaction type, amount, cardholder or vaulted shopper, credit card, processing info, and so on.

Note: If you are using the API + Hosted Page Hybrid solution, this can also return transactions created in Hosted Payment Pages.

Request Content

No content is required in the request body. Enter the relevant IDs in the request URL, as follows:

Retrieve based on Transaction ID

Enter the transaction-id into the web service URL, in the format:
services/2/transactions/{transaction-id}

For example:
services/2/transactions/1011582369

Retrieve based on Merchant Transaction ID and Merchant ID

Enter the merchant-transaction-id and merchant-id into the web service URL, in the format:
services/2/transactions/{merchant-transaction-id},{merchant-id}

For example:
services/2/transactions/3,456

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the retrieved card-transaction resource (see card-transaction).
If you passed metadata in the original transaction request, this metadata will also be retrieved.

Note: Non-reusable cards will not be returned as a payment method.

Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/transactions/1011582369 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

curl -v -X GET https://sandbox.bluesnap.com/services/2/transactions/3,456 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<card-transaction xmlns="http://ws.plimus.com">
  <card-transaction-type>AUTH_ONLY</card-transaction-type>
  <merchant-transaction-id>3</merchant-transaction-id>
  <transaction-id>1011582369</transaction-id>
  <soft-descriptor>BLS&#x2a;DescTest</soft-descriptor>
  <amount>11.00</amount>
  <usd-amount>11.00</usd-amount>
  <currency>USD</currency>
  <transaction-approval-date>10/01/2020</transaction-approval-date>
  <transaction-approval-time>10:19:21</transaction-approval-time>
  <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>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>

<?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>38500790</transaction-id>
  <soft-descriptor>BLS*DescTest</soft-descriptor>
  <amount>11.00</amount>
  <usd-amount>11.00</usd-amount>
  <currency>USD</currency>
  <transaction-approval-date>10/01/2020</transaction-approval-date>
  <transaction-approval-time>10:19:21</transaction-approval-time>
  <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>0026</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>shippingAmount</meta-key>
      <meta-value>10.00</meta-value>
      <meta-description>Shipping Amount</meta-description>
    </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>
  </transaction-meta-data>
  <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>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<card-transaction xmlns="http://ws.plimus.com">
  <card-transaction-type>REFUND</card-transaction-type>
  <merchant-transaction-id>1234567890123456</merchant-transaction-id>
  <transaction-id>38417916</transaction-id>
  <soft-descriptor>BLS&#x2a;DescTest1234567</soft-descriptor>
  <amount>99.99</amount>
  <usd-amount>117.46</usd-amount>
  <currency>EUR</currency>
  <transaction-approval-date>10/01/2020</transaction-approval-date>
  <transaction-approval-time>10:19:21</transaction-approval-time>
  <card-holder-info>
    <first-name>John</first-name>
    <last-name>Doe</last-name>
    <country>fr</country>
    <zip>756543</zip>
    <phone>1413555666</phone>
  </card-holder-info>
  <vaulted-shopper-id>19490030</vaulted-shopper-id>
  <credit-card>
    <card-last-four-digits>1111</card-last-four-digits>
    <card-type>VISA</card-type>
  </credit-card>
  <processing-info>
    <processing-status>SUCCESS</processing-status>
    <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>
  <refunds>
    <refund>
      <amount>55.55</amount>
      <currency>EUR</currency>
      <date>2020-10-13</date>
    </refund>
    <refund>
      <amount>44.44</amount>
      <currency>EUR</currency>
      <date>2020-10-05</date>
    </refund>
  </refunds>
</card-transaction>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<card-transaction xmlns="http://ws.plimus.com">
  <card-transaction-type>AUTH_ONLY</card-transaction-type>
  <vendor-info>
    <vendor-id>397808</vendor-id>
    <commission-percent>30</commission-percent>
  </vendor-info>
  <merchant-transaction-id>3</merchant-transaction-id>
  <transaction-id>1011582369</transaction-id>
  <soft-descriptor>BLS&#x2a;DescTest</soft-descriptor>
  <amount>11.00</amount>
  <usd-amount>11.00</usd-amount>
  <currency>USD</currency>
  <transaction-approval-date>10/01/2020</transaction-approval-date>
  <transaction-approval-time>10:19:21</transaction-approval-time>
  <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>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>