Create ECP Transaction

The Create ECP Transaction request performs a transaction (purchase) using the ACH/ECP payment method. For more information about this payment method, see ACH/ECP.

👍

Prerequisite: Enable the ECP payment method in your account

In the Merchant Portal, go to Checkout Page > Payment Methods and select Show in the menu next to the ECP payment method. Click Submit to save your change.


❗️

Important

The API Explorer Try It! feature does not currently send XML requests to our sandbox environment.

For request and response examples, refer to the Examples section.

Request Content

Send an alt-transaction object with the following:

PropertyTypeRequired
amountdecimalrequired
authorized-by-shopperbooleanrequired, value must be true
currencystringrequired
ecp-transactioncontainerrequired if pf-token is not sent (see ecp-transaction)
merchant-transaction-idstringoptional
payer-infocontainerrequired if vaulted-shopper-id is not sent (see payer-info)
pf-tokenstringrequired if using Secured Payment Collector
product-descriptionstringoptional
soft-descriptorstringoptional
tax-referencestringoptional
transaction-fraud-infocontaineroptional (see transaction-fraud-info)
transaction-meta-datacontaineroptional (see transaction-meta-data)
vaulted-shopper-idintegerrequired if payer-info is not sent
vendors-infocontainerrequired if using marketplace vendor(s) (see vendors-info)

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains an alt-transaction resource (see alt-transaction) with the request properties plus these additions:

PropertyNotes
fraud-result-info
processing-info
transaction-id
vaulted-shopper-id
vendors-info

Back to Top


Examples

Request Examples

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<alt-transaction xmlns="http://ws.plimus.com">
   <soft-descriptor>ABC COMPANY</soft-descriptor>
   <amount>100.00</amount>
   <currency>USD</currency>
   <payer-info>
      <first-name>John</first-name>
      <last-name>Doe</last-name>
      <zip>02453</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>
   <authorized-by-shopper>true</authorized-by-shopper>
   <transaction-fraud-info>
      <fraud-session-id>1234</fraud-session>
      <customer-id>121341</customer-id>
      <customer-creation-date>2021-08-05</customer-creation-date>
   </transaction-fraud-info>
</alt-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<?xml version="1.0" encoding="UTF-8"?>
<alt-transaction xmlns="http://ws.plimus.com">
   <soft-descriptor>ABC COMPANY</soft-descriptor>
   <amount>100.00</amount>
   <currency>USD</currency>
   <vaulted-shopper-id>19563598</vaulted-shopper-id>
   <ecp-transaction />
   <authorized-by-shopper>true</authorized-by-shopper>
</alt-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<?xml version="1.0" encoding="UTF-8"?>
<alt-transaction xmlns="http://ws.plimus.com">
   <merchant-transaction-id>unique_001</merchant-transaction-id>
   <amount>100.00</amount>
   <currency>USD</currency>
   <payer-info>
      <first-name>John</first-name>
      <last-name>Doe</last-name>
      <zip>02453</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>
   <authorized-by-shopper>true</authorized-by-shopper>
</alt-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<alt-transaction xmlns="http://ws.plimus.com">
   <soft-descriptor>ABC COMPANY</soft-descriptor>
   <vendors-info>
     <vendor-info>
       <vendor-id>10398032</vendor-id>
     </vendor-info>
   </vendors-info>
   <amount>100.00</amount>
   <currency>USD</currency>
   <payer-info>
      <first-name>John</first-name>
      <last-name>Doe</last-name>
      <zip>02453</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>
   <authorized-by-shopper>true</authorized-by-shopper>
</alt-transaction>'
<?xml version="1.0" encoding="UTF-8"?>
<alt-transaction xmlns="http://ws.plimus.com">
   <soft-descriptor>ABC COMPANY</soft-descriptor>
   <amount>100.00</amount>
   <currency>USD</currency>
   <vaulted-shopper-id>19569774</vaulted-shopper-id>
   <ecp-transaction>
        <account-type>CONSUMER_SAVINGS</account-type>
        <public-account-number>99993</public-account-number>
        <public-routing-number>75151</public-routing-number>
   </ecp-transaction>
   <authorized-by-shopper>true</authorized-by-shopper>
</alt-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<alt-transaction xmlns="http://ws.plimus.com">
  <pf-token>eba795a8ec2a8e7754afe7a69b0a0869fba0e6daec01e2d81e1ccbb6771c24ab_</pf-token>
  <soft-descriptor>ABC COMPANY</soft-descriptor>
  <amount>100.00</amount>
  <currency>USD</currency>
  <payer-info>
    <first-name>John</first-name>
    <last-name>Doe</last-name>
    <zip>02453</zip>
    <phone>1234567890</phone>
  </payer-info>
  <authorized-by-shopper>true</authorized-by-shopper>
</alt-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<alt-transaction xmlns="http://ws.plimus.com">
   <soft-descriptor>ABC COMPANY</soft-descriptor>
   <amount>120.50</amount>
   <currency>USD</currency>
    <tax-reference>048deff0-a285-47e1-bc39-42f79bf0095b</tax-reference>
   <payer-info>
      <first-name>John</first-name>
      <last-name>Doe</last-name>
      <zip>02453</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>
   <authorized-by-shopper>true</authorized-by-shopper>
</alt-transaction>'

Response Examples

<?xml version="1.0" encoding="UTF-8"?>
<alt-transaction xmlns="http://ws.plimus.com">
   <transaction-id>38504784</transaction-id>
   <soft-descriptor>ABC COMPANY</soft-descriptor>
   <amount>100.00</amount>
   <currency>USD</currency>
   <payer-info>
      <first-name>John</first-name>
      <last-name>Doe</last-name>
      <zip>02453</zip>
      <phone>1234567890</phone>
   </payer-info>
  <vaulted-shopper-id>21614931</vaulted-shopper-id>
   <ecp-transaction>
      <account-number>4099999992</account-number>
      <routing-number>011075150</routing-number>
      <account-type>CONSUMER_CHECKING</account-type>
   </ecp-transaction>
   <processing-info>
      <processing-status>PENDING</processing-status>
      <transaction-region>US</transaction-region>
   </processing-info>
  <fraud-result-info/>
</alt-transaction>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <transaction-id>38503224</transaction-id>
    <soft-descriptor>ABC COMPANY</soft-descriptor>
    <amount>1.00</amount>
    <currency>USD</currency>
    <vaulted-shopper-id>19568536</vaulted-shopper-id>
    <ecp-transaction>
        <account-number>4099999992</account-number>
        <routing-number>011075150</routing-number>
        <account-type>CONSUMER_CHECKING</account-type>
    </ecp-transaction>
    <processing-info>
        <processing-status>PENDING</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.00</amount>
    <currency>USD</currency>
    <payer-info>
        <first-name>John</first-name>
        <last-name>Doe</last-name>
        <zip>02453</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>PENDING</processing-status>
    </processing-info>
</alt-transaction>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
  <transaction-id>1015601047</transaction-id>
  <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>
  <soft-descriptor>ABC COMPANY</soft-descriptor>
  <amount>100.00</amount>
  <currency>USD</currency>
  <payer-info>
    <first-name>John</first-name>
    <last-name>Doe</last-name>
    <zip>02453</zip>
    <phone>1234567890</phone>
  </payer-info>
  <vaulted-shopper-id>22327453</vaulted-shopper-id>
  <ecp-transaction>
    <account-number>4099999992</account-number>
    <routing-number>011075150</routing-number>
    <account-type>CONSUMER_CHECKING</account-type>
  </ecp-transaction>
  <processing-info>
    <processing-status>PENDING</processing-status>
  </processing-info>
</alt-transaction>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <transaction-id>38505326</transaction-id>
    <soft-descriptor>ABC COMPANY</soft-descriptor>
    <amount>100.00</amount>
    <currency>USD</currency>
    <payer-info>
        <first-name>John</first-name>
        <last-name>Doe</last-name>
        <zip>02453</zip>
        <phone>1234567890</phone>
    </payer-info>
    <vaulted-shopper-id>19570138</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>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <transaction-id>38504834</transaction-id>
    <soft-descriptor>ABC COMPANY</soft-descriptor>
    <amount>100.00</amount>
    <currency>USD</currency>
    <vaulted-shopper-id>19569774</vaulted-shopper-id>
    <ecp-transaction>
        <public-account-number>99993</public-account-number>
        <public-routing-number>75151</public-routing-number>
        <account-type>CONSUMER_SAVINGS</account-type>
    </ecp-transaction>
    <processing-info>
        <processing-status>PENDING</processing-status>
    </processing-info>
</alt-transaction>

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
Authorization
Header
Click Try It! to start a request and see the response here!