{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/alt-transactions/:transaction-id","auth":"optional","examples":{"codes":[]},"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"","params":[{"name":"transaction-id","type":"string","default":"","desc":"transaction ID received in the response from BlueSnap","required":true,"in":"path","ref":"","_id":"56953ff3fe18811700c9bfcc"}]},"next":{"description":"","pages":[]},"title":"Retrieve ECP Transaction","type":"endpoint","slug":"retrieve-ecp-transaction","excerpt":"","body":"[block:html]\n{\n  \"html\": \"<script>\\n  // hide body textbox of API Explorer\\n $(document).ready(function() {\\n  $(\\\"textarea[placeholder='Body Content']\\\").hide();  \\n }); \\n</script>\"\n}\n[/block]\nThis request gets details about a past ECP transaction, such as the transaction ID, amount, currency, payer info or vaulted shopper, and so on.\n\n**Note**:  If you are using the [API + Hosted Page Hybrid solution](https://support.bluesnap.com/docs/hybrid-solution), this can also return transactions created in Hosted Payment Pages. \n<br />\n\n<a class=\"btn btn-success\" href=\"#section-api-explorer-for-request-based-on-transaction-id-\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\nNo content is required in the request body. Enter the relevant IDs in the request URL, as follows:\n\n**Retrieve based on Transaction ID**\nEnter the `transaction-id` into the web service URL, in the format:\n`services/2/alt-transactions/{transaction-id}`\n\nFor example:\n`services/2/transactions/38504790`\n\n**Retrieve based on Merchant Transaction ID and Merchant ID**\nEnter the `merchant-id` and `merchant-transaction-id` into the web service URL, in the format:\n`services/2/alt-transactions/{merchant-transaction-id},{merchant-id}`\n\nFor example:\n`services/2/alt-transactions/unique_001,395608`\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved `alt-transaction` resource (see [alt-transaction](doc:alt-transaction)).\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/alt-transactions/38504790 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve ECP Transaction Request: by Transaction ID\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/alt-transactions/unique_001,395608 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"by Merchant Transaction ID and Merchant ID\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <transaction-id>38504790</transaction-id>\\n  <soft-descriptor>ABC COMPANY</soft-descriptor>\\n  <amount>100</amount>\\n  <currency>USD</currency>\\n  <transaction-approval-date>10/01/2020</transaction-approval-date>\\n  <transaction-approval-time>10:19:21</transaction-approval-time>\\n  <payer-info>\\n    <first-name>John</first-name>\\n    <last-name>Doe</last-name>\\n    <zip>12345</zip>\\n    <phone>1234567890</phone>\\n  </payer-info>\\n  <ecp-transaction>\\n    <account-number>4099999992</account-number>\\n    <routing-number>011075150</routing-number>\\n    <account-type>CONSUMER_CHECKING</account-type>\\n  </ecp-transaction>\\n  <processing-info>\\n    <processing-status>SUCCESS</processing-status>\\n  </processing-info>\\n</alt-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"Retrieve ECP Transaction Response: 200 OK - by Transaction ID\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <merchant-transaction-id>unique_001</merchant-transaction-id>\\n  <transaction-id>38504788</transaction-id>\\n  <amount>100</amount>\\n  <currency>USD</currency>\\n  <transaction-approval-date>10/01/2020</transaction-approval-date>\\n  <transaction-approval-time>10:19:21</transaction-approval-time>\\n  <payer-info>\\n    <first-name>John</first-name>\\n    <last-name>Doe</last-name>\\n    <zip>12345</zip>\\n    <phone>1234567890</phone>\\n  </payer-info>\\n  <ecp-transaction>\\n    <account-number>4099999992</account-number>\\n    <routing-number>011075150</routing-number>\\n    <account-type>CONSUMER_CHECKING</account-type>\\n  </ecp-transaction>\\n  <processing-info>\\n    <processing-status>SUCCESS</processing-status>\\n  </processing-info>\\n</alt-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"- by Merchant Transaction ID and Merchant ID\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <merchant-transaction-id>456</merchant-transaction-id>\\n  <transaction-id>38418384</transaction-id>\\n  <vendor-info>\\n    <vendor-id>397808</vendor-id>\\n    <commission-percent>20</commission-percent>\\n  </vendor-info>\\n  <soft-descriptor>ABC COMPANY</soft-descriptor>\\n  <amount>50</amount>\\n  <currency>USD</currency>\\n  <transaction-approval-date>10/01/2020</transaction-approval-date>\\n  <transaction-approval-time>10:19:21</transaction-approval-time>\\n  <payer-info>\\n    <first-name>John</first-name>\\n    <last-name>Doe</last-name>\\n    <zip>12345</zip>\\n    <phone>1234567890</phone>\\n  </payer-info>\\n  <ecp-transaction>\\n    <account-number>4099999992</account-number>\\n    <routing-number>011075150</routing-number>\\n    <account-type>CONSUMER_CHECKING</account-type>\\n  </ecp-transaction>\\n  <processing-info>\\n    <processing-status>REFUNDED</processing-status>\\n  </processing-info>\\n  <refunds>\\n    <balance-amount>49.00</balance-amount>\\n    <vendor-balance-amount>9.80</vendor-balance-amount>\\n    <refund>\\n      <amount>1.00</amount>\\n      <vendor-amount>0.20</vendor-amount>\\n      <currency>USD</currency>\\n      <date>2020-010-29</date>\\n    </refund>\\n  </refunds>\\n</alt-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"- with vendor ID\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n    <transaction-id>38505332</transaction-id>\\n    <soft-descriptor>ABC COMPANY</soft-descriptor>\\n    <amount>100</amount>\\n    <currency>USD</currency>\\n    <payer-info>\\n        <first-name>John</first-name>\\n        <last-name>Doe</last-name>\\n        <zip>12345</zip>\\n        <phone>1234567890</phone>\\n    </payer-info>\\n    <vaulted-shopper-id>19570144</vaulted-shopper-id>\\n    <ecp-transaction>\\n        <account-type>CONSUMER_CHECKING</account-type>\\n        <public-account-number>99992</public-account-number>\\n        <public-routing-number>75150</public-routing-number>\\n    </ecp-transaction>\\n    <processing-info>\\n        <processing-status>PENDING</processing-status>\\n    </processing-info>\\n</alt-transaction>\\n\\n\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK API v3.0 - by Transaction ID\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"In API v3.0, the `<ecp-transaction>`  in the Response returns the private data.\",\n  \"title\": \"Note:\"\n}\n[/block]\n##API Explorer (for request based on Transaction ID)\nTo test out a call, enter an existing transaction ID in the `transaction-id` field. This automatically inserts the ID into the request URL. Leave the Body Content field empty.","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ff4b747849e1b03c5068495","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"ACH/ECP Transactions","slug":"ecp-transaction-service","order":3,"from_sync":false,"reference":true,"_id":"5ff4b747849e1b03c506840c","version":"5ff4b747849e1b03c50684c7","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2016-01-13T18:38:47.347Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.36.1 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ff4b747849e1b03c5068409","5ff4b747849e1b03c506840a","5ff4b747849e1b03c506840b","5ff4b747849e1b03c506840c","5ff4b747849e1b03c506840d","5ff4b747849e1b03c506840e","5ff4b747849e1b03c506840f","5ff4b747849e1b03c5068410","5ff4b747849e1b03c5068411","5ff4b747849e1b03c5068412","5ff4b747849e1b03c5068413","5ff4b747849e1b03c5068414","5ff4b747849e1b03c5068415","5ff4b747849e1b03c5068416","5ff4b747849e1b03c5068417","5ff4b747849e1b03c5068418","5ff4b747849e1b03c5068419","5ff4b747849e1b03c506841a","5ff4b747849e1b03c506841b","5ff4b747849e1b03c506841c"],"_id":"5ff4b747849e1b03c50684c7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5fd26704abd1b6004f12d72c","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-01-22T17:46:50.622Z","githubsync":"","__v":10}

Payment API (XML)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

iDEAL Transactions

Local Bank Transfer transactions

SEPA Direct Debit Transactions

Sofort Transactions

Batch Transactions

Refunds

Vaulted Shoppers

Subscriptions

Fraud Review

Marketplace

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

Mobile SDK

getRetrieve ECP Transaction

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

transaction-id:
required
string
transaction ID received in the response from BlueSnap

Documentation

This request gets details about a past ECP transaction, such as the transaction ID, amount, currency, payer info or vaulted shopper, and so on.

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

Try it in the API Explorer

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/alt-transactions/{transaction-id}

For example:
services/2/transactions/38504790

Retrieve based on Merchant Transaction ID and Merchant ID
Enter the merchant-id and merchant-transaction-id into the web service URL, in the format:
services/2/alt-transactions/{merchant-transaction-id},{merchant-id}

For example:
services/2/alt-transactions/unique_001,395608

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the retrieved alt-transaction resource (see alt-transaction).

Examples

Request Examples

Retrieve ECP Transaction Request: by Transaction ID
by Merchant Transaction ID and Merchant ID
curl -v -X GET https://sandbox.bluesnap.com/services/2/alt-transactions/38504790 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X GET https://sandbox.bluesnap.com/services/2/alt-transactions/unique_001,395608 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

Retrieve ECP Transaction Response: 200 OK - by Transaction ID
- by Merchant Transaction ID and Merchant ID
- with vendor ID
200 OK API v3.0 - by Transaction ID
<?xml version="1.0" encoding="UTF-8"?>
<alt-transaction xmlns="http://ws.plimus.com">
  <transaction-id>38504790</transaction-id>
  <soft-descriptor>ABC COMPANY</soft-descriptor>
  <amount>100</amount>
  <currency>USD</currency>
  <transaction-approval-date>10/01/2020</transaction-approval-date>
  <transaction-approval-time>10:19:21</transaction-approval-time>
  <payer-info>
    <first-name>John</first-name>
    <last-name>Doe</last-name>
    <zip>12345</zip>
    <phone>1234567890</phone>
  </payer-info>
  <ecp-transaction>
    <account-number>4099999992</account-number>
    <routing-number>011075150</routing-number>
    <account-type>CONSUMER_CHECKING</account-type>
  </ecp-transaction>
  <processing-info>
    <processing-status>SUCCESS</processing-status>
  </processing-info>
</alt-transaction>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
  <merchant-transaction-id>unique_001</merchant-transaction-id>
  <transaction-id>38504788</transaction-id>
  <amount>100</amount>
  <currency>USD</currency>
  <transaction-approval-date>10/01/2020</transaction-approval-date>
  <transaction-approval-time>10:19:21</transaction-approval-time>
  <payer-info>
    <first-name>John</first-name>
    <last-name>Doe</last-name>
    <zip>12345</zip>
    <phone>1234567890</phone>
  </payer-info>
  <ecp-transaction>
    <account-number>4099999992</account-number>
    <routing-number>011075150</routing-number>
    <account-type>CONSUMER_CHECKING</account-type>
  </ecp-transaction>
  <processing-info>
    <processing-status>SUCCESS</processing-status>
  </processing-info>
</alt-transaction>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
  <merchant-transaction-id>456</merchant-transaction-id>
  <transaction-id>38418384</transaction-id>
  <vendor-info>
    <vendor-id>397808</vendor-id>
    <commission-percent>20</commission-percent>
  </vendor-info>
  <soft-descriptor>ABC COMPANY</soft-descriptor>
  <amount>50</amount>
  <currency>USD</currency>
  <transaction-approval-date>10/01/2020</transaction-approval-date>
  <transaction-approval-time>10:19:21</transaction-approval-time>
  <payer-info>
    <first-name>John</first-name>
    <last-name>Doe</last-name>
    <zip>12345</zip>
    <phone>1234567890</phone>
  </payer-info>
  <ecp-transaction>
    <account-number>4099999992</account-number>
    <routing-number>011075150</routing-number>
    <account-type>CONSUMER_CHECKING</account-type>
  </ecp-transaction>
  <processing-info>
    <processing-status>REFUNDED</processing-status>
  </processing-info>
  <refunds>
    <balance-amount>49.00</balance-amount>
    <vendor-balance-amount>9.80</vendor-balance-amount>
    <refund>
      <amount>1.00</amount>
      <vendor-amount>0.20</vendor-amount>
      <currency>USD</currency>
      <date>2020-010-29</date>
    </refund>
  </refunds>
</alt-transaction>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <transaction-id>38505332</transaction-id>
    <soft-descriptor>ABC COMPANY</soft-descriptor>
    <amount>100</amount>
    <currency>USD</currency>
    <payer-info>
        <first-name>John</first-name>
        <last-name>Doe</last-name>
        <zip>12345</zip>
        <phone>1234567890</phone>
    </payer-info>
    <vaulted-shopper-id>19570144</vaulted-shopper-id>
    <ecp-transaction>
        <account-type>CONSUMER_CHECKING</account-type>
        <public-account-number>99992</public-account-number>
        <public-routing-number>75150</public-routing-number>
    </ecp-transaction>
    <processing-info>
        <processing-status>PENDING</processing-status>
    </processing-info>
</alt-transaction>

Note:

In API v3.0, the <ecp-transaction> in the Response returns the private data.

API Explorer (for request based on Transaction ID)

To test out a call, enter an existing transaction ID in the transaction-id field. This automatically inserts the ID into the request URL. Leave the Body Content field empty.

User Information

Try It Out

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