{"_id":"59df6a523b756800107b2035","category":{"_id":"59df6a523b756800107b2022","version":"59df6a523b756800107b201e","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-13T18:38:47.347Z","from_sync":false,"order":3,"slug":"ecp-transaction-service","title":"ACH/ECP Transactions"},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"59df6a523b756800107b201e","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-10-12T13:12:50.128Z","releaseDate":"2017-10-12T13:12:50.128Z","categories":["59df6a523b756800107b201f","59df6a523b756800107b2020","59df6a523b756800107b2021","59df6a523b756800107b2022","59df6a523b756800107b2023","59df6a523b756800107b2024","59df6a523b756800107b2025","59df6a523b756800107b2026","59df6a523b756800107b2027","59df6a523b756800107b2028","59df6a523b756800107b2029","59df6a523b756800107b202a","59df6a523b756800107b202b","59df6a523b756800107b202c","59df6a523b756800107b202d","59df6a523b756800107b202e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.23 Release","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-22T17:46:32.268Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[{"code":"","language":"text"}]},"settings":"","auth":"optional","params":[],"url":"/alt-transactions"},"isReference":true,"order":0,"body":"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](/v1.0/docs/ach-ecp).\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"In the BlueSnap Merchant Console, go to **Checkout Page > Payment Methods** and select **Show** in the menu next to the **ECP** payment method. Click **Submit** to save your change.\",\n  \"title\": \"Prerequisite: Enable the ECP payment method in your account\"\n}\n[/block]\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\n\n`alt-transaction` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F38A00\">**required**</span>, contains the following properties (see [alt-transaction](doc:alt-transaction)):\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`merchant-transaction-id` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`soft-descriptor` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`amount` *decimal* &nbsp;&nbsp;&nbsp;<span style=\"color:#F38A00\">**required**</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`currency` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F38A00\">**required**</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendor-info` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F38A00\">**required** if Marketplace vendors used</span> (see [vendor-info](doc:vendor-info))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`payer-info` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F38A00\">**required** if `vaulted-shopper-id` is not sent</span> (see [payer-info](doc:payer-info))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vaulted-shopper-id` *integer* &nbsp;&nbsp;&nbsp;<span style=\"color:#F38A00\">**required** if `payer-info` is not sent</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`ecp-transaction` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F38A00\">**required** for ECP transactions</span> (see [ecp-transaction](doc:ecp-transaction))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`authorized-by-shopper` *boolean* &nbsp;&nbsp;&nbsp;<span style=\"color:#F38A00\">**required**, value must be **true**</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transaction-meta-data` *container* &nbsp;&nbsp;&nbsp;optional (see [transaction-meta-data](doc:transaction-meta-data))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transaction-fraud-info` *container* &nbsp;&nbsp;&nbsp;optional (see [transaction-fraud-info](doc:transaction-fraud-info))\n\n##Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains an `alt-transaction` resource (see [alt-transaction](doc:alt-transaction)) with the request properties plus these additions:\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transaction-id`\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vaulted-shopper-id`\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`processing-info`\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`fraud-result-info`\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendor-info`\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <soft-descriptor>ABC COMPANY</soft-descriptor>\\n   <amount>100.00</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   <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   <authorized-by-shopper>true</authorized-by-shopper>\\n</alt-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"Create ECP Transaction Request: basic with payer info\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <soft-descriptor>ABC COMPANY</soft-descriptor>\\n   <amount>100.00</amount>\\n   <currency>USD</currency>\\n   <vaulted-shopper-id>19563598</vaulted-shopper-id>\\n   <ecp-transaction />\\n   <authorized-by-shopper>true</authorized-by-shopper>\\n</alt-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with vaulted shopper\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <merchant-transaction-id>unique_001</merchant-transaction-id>\\n   <amount>100.00</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   <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   <authorized-by-shopper>true</authorized-by-shopper>\\n</alt-transaction>'\",\n      \"language\": \"curl\",\n      \"name\": \"with Merchant Transaction ID\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <soft-descriptor>ABC COMPANY</soft-descriptor>\\n   <vendor-info>\\n      <vendor-id>514147</vendor-id>\\n   </vendor-info>\\n   <amount>100.00</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   <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   <authorized-by-shopper>true</authorized-by-shopper>\\n</alt-transaction>\",\n      \"language\": \"curl\",\n      \"name\": \"Create ECP with vendor info\"\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>38504784</transaction-id>\\n   <soft-descriptor>ABC COMPANY</soft-descriptor>\\n   <amount>100.00</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>21614931</vaulted-shopper-id>\\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>PENDING</processing-status>\\n   </processing-info>\\n</alt-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"Create ECP Transaction Response: 200 OK - basic with payer info\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <transaction-id>38504786</transaction-id>\\n   <soft-descriptor>ABC COMPANY</soft-descriptor>\\n   <amount>100.00</amount>\\n   <currency>USD</currency>\\n   <vaulted-shopper-id>19563598</vaulted-shopper-id>\\n   <ecp-transaction />\\n   <processing-info>\\n      <processing-status>PENDING</processing-status>\\n   </processing-info>\\n</alt-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - with vaulted shopper\"\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.00</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    <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>PENDING</processing-status>\\n    </processing-info>\\n</alt-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - with Merchant Transaction ID\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n\\t<transaction-id>1013344083</transaction-id>\\n\\t<vendor-info>\\n\\t\\t<vendor-id>514147</vendor-id>\\n\\t\\t<commission-percent>20</commission-percent>\\n\\t</vendor-info>\\n\\t<soft-descriptor>ABC COMPANY</soft-descriptor>\\n\\t<amount>100.00</amount>\\n\\t<currency>USD</currency>\\n\\t<payer-info>\\n\\t\\t<first-name>John</first-name>\\n\\t\\t<last-name>Doe</last-name>\\n\\t\\t<zip>12345</zip>\\n\\t\\t<phone>1234567890</phone>\\n\\t</payer-info>\\n\\t<vaulted-shopper-id>21523973</vaulted-shopper-id>\\n\\t<ecp-transaction>\\n\\t\\t<account-number>4099999992</account-number>\\n\\t\\t<routing-number>011075150</routing-number>\\n\\t\\t<account-type>CONSUMER_CHECKING</account-type>\\n\\t</ecp-transaction>\\n\\t<processing-info>\\n\\t\\t<processing-status>PENDING</processing-status>\\n\\t</processing-info>\\n</alt-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - with vendor info\"\n    }\n  ]\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##Example Descriptions\n\n###Create basic ECP transaction with payer info\nThis example shows a basic create ECP Transaction request, including the minimum required fields to process an ACH/ECP transaction with basic information about the shopper.\n\nFor all ACH transactions, you must obtain permission from the shopper to debit their account, for example by showing a checkbox with the following wording on your checkout page. *\"I authorize this Electronic Check (ACH) transaction and agree to this debit of my account.\"*\n\nInclude the `authorized-by-shopper` element with the value set to **true** to indicate that you have obtained the shopper's permission.\n\n###Create ECP transaction with vaulted shopper\nTo perform a Create ECP Transaction with an existing vaulted shopper (with saved ECP account details), you'll need to include the `vaulted-shopper-id` property within the **[alt-transaction](doc:alt-transaction)** resource in your request. \n\nAbove is an example of a Create ECP Transaction request with an existing vaulted shopper with the ID 19563598. When you use a vaulted shopper, the `ecp-transaction` property can be left empty, as shown in the example.\n\n###Create ECP transaction with Merchant Transaction ID\nYou 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 will need to include the `merchant-transaction-id` property within the **[alt-transaction](doc:alt-transaction)** resource in your request.\n\nAbove is an example of a request that includes a Merchant Transaction ID.\n\n###Create ECP transaction with Vendor Info\nThis example shows a Create ECP transaction request within a marketplace. If you are a marketplace merchant, you will include `vendor-info` in the request to process a transaction between a shopper and a specific vendor within your marketplace (see [vendor-info](doc:vendor-info)). \n\nIn the above example request, only the required `vendor-id` is included in the `vendor-info` container. By leaving out the `commission-percent` property, the transaction will default to the value set during the creation of the vendor. \n\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##API Explorer\nTo test out a call, click the **Test in the API Explorer** button below.\nThen just paste in the XML portion of the request and click **Try it!**\n\n**Tip**: Copy the XML portion from one of the examples above, or use the XML code below as a starting point. You can enter different parameters 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.*\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <soft-descriptor>ABC COMPANY</soft-descriptor>\\n   <amount>100.00</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   <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   <authorized-by-shopper>true</authorized-by-shopper>\\n</alt-transaction>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"create-ecp-transaction","type":"post","title":"Create ECP Transaction"}

postCreate ECP Transaction


Definition

{{ api_url }}{{ page_api_url }}

Documentation

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 BlueSnap Merchant Console, go to Checkout Page > Payment Methods and select Show in the menu next to the ECP payment method. Click Submit to save your change.

Try it in the API Explorer

Request Content

alt-transaction container    required, contains the following properties (see alt-transaction):
      merchant-transaction-id string    optional
      soft-descriptor string    optional
      amount decimal    required
      currency string    required
      vendor-info container    required if Marketplace vendors used (see vendor-info)
      payer-info container    required if vaulted-shopper-id is not sent (see payer-info)
      vaulted-shopper-id integer    required if payer-info is not sent
      ecp-transaction container    required for ECP transactions (see ecp-transaction)
      authorized-by-shopper boolean    required, value must be true
      transaction-meta-data container    optional (see transaction-meta-data)
      transaction-fraud-info container    optional (see transaction-fraud-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:

      transaction-id
      vaulted-shopper-id
      processing-info
      fraud-result-info
      vendor-info


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 '
<?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>
   <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>
   <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">
   <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>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>
   <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>
   <vendor-info>
      <vendor-id>514147</vendor-id>
   </vendor-info>
   <amount>100.00</amount>
   <currency>USD</currency>
   <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>
   <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>12345</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>
   </processing-info>
</alt-transaction>
<?xml version="1.0" encoding="UTF-8"?>
<alt-transaction xmlns="http://ws.plimus.com">
   <transaction-id>38504786</transaction-id>
   <soft-descriptor>ABC COMPANY</soft-descriptor>
   <amount>100.00</amount>
   <currency>USD</currency>
   <vaulted-shopper-id>19563598</vaulted-shopper-id>
   <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>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>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>1013344083</transaction-id>
	<vendor-info>
		<vendor-id>514147</vendor-id>
		<commission-percent>20</commission-percent>
	</vendor-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>12345</zip>
		<phone>1234567890</phone>
	</payer-info>
	<vaulted-shopper-id>21523973</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>

Back to Top


Example Descriptions

Create basic ECP transaction with payer info

This example shows a basic create ECP Transaction request, including the minimum required fields to process an ACH/ECP transaction with basic information about the shopper.

For all ACH transactions, you must obtain permission from the shopper to debit their account, for example by showing a checkbox with the following wording on your checkout page. "I authorize this Electronic Check (ACH) transaction and agree to this debit of my account."

Include the authorized-by-shopper element with the value set to true to indicate that you have obtained the shopper's permission.

Create ECP transaction with vaulted shopper

To perform a Create ECP Transaction with an existing vaulted shopper (with saved ECP account details), you'll need to include the vaulted-shopper-id property within the alt-transaction resource in your request.

Above is an example of a Create ECP Transaction request with an existing vaulted shopper with the ID 19563598. When you use a vaulted shopper, the ecp-transaction property can be left empty, as shown in the example.

Create ECP transaction 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 will need to include the merchant-transaction-id property within the alt-transaction resource in your request.

Above is an example of a request that includes a Merchant Transaction ID.

Create ECP transaction with Vendor Info

This example shows a Create ECP transaction request within a marketplace. If you are a marketplace merchant, you will include vendor-info in the request to process a transaction between a shopper and a specific vendor within your marketplace (see vendor-info).

In the above example request, only the required vendor-id is included in the vendor-info container. By leaving out the commission-percent property, the transaction will default to the value set during the creation of the vendor.



Back to Top


API Explorer

To test out a call, click the Test in the API Explorer button below.
Then just paste in the XML portion of the request and click Try it!

Tip: Copy the XML portion from one of the examples above, or use the XML code below as a starting point. You can enter different parameters 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.

<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>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>
   <authorized-by-shopper>true</authorized-by-shopper>
</alt-transaction>

User Information

Try It Out


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