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.

Try it in the API Explorer

Request Content

Send an altTransaction object with the following:

      merchantTransactionId     string    optional
     softDescriptor     string    optional
     amount     decimal    required
     currency     string    required
     taxReference     string    optional
     vendorsInfo object    optional (see vendorsInfo)
     payerInfo     object    required if vaultedShopperId is not sent (see payerInfo)
     vaultedShopperId     integer    required if payerInfo is not sent
     pfToken     string    required if using Secured Payment Collector
     ecpTransaction     object    required if pfToken is not sent (see ecpTransaction)
     authorizedByShopper     boolean    required, value must be true
     transactionMetaData     object    optional (see transactionMetaData)
     transactionFraudInfo     object    optional (see transactionFraudInfo)

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the request properties plus these additions:

      transactionId
     vaultedShopperId
     processingInfo   (see processingInfo)
     fraudResultInfo   (see fraudResultInfo)
     vendorsInfo    (see vendorsInfo)

Examples

Request Examples

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "ecpTransaction": {
        "routingNumber": "011075150",
        "accountType": "CONSUMER_CHECKING",
        "accountNumber": "4099999992"
    },
    "amount": "100",
    "payerInfo": {
        "zip": "02453",
        "firstName": "John",
        "lastName": "Doe",
        "phone": "1234567890"
    },
    "softDescriptor": "ABC COMPANY",
    "currency": "USD",
    "authorizedByShopper": true,
    "transactionFraudInfo": {
        "fraudSessionId": "1234",
        "customerId": "121341",
        "customerCreationDate": "2021-08-05"
    }
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "ecpTransaction": {},
    "amount": 100,
    "vaultedShopperId": 19563598,
    "softDescriptor": "ABC COMPANY",
    "currency": "USD",
    "authorizedByShopper": true
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "ecpTransaction": {
        "routingNumber": "011075150",
        "accountType": "CONSUMER_CHECKING",
        "accountNumber": 4099999992
    },
    "amount": 100,
    "payerInfo": {
        "zip": "02453",
        "firstName": "John",
        "lastName": "Doe",
        "phone": 1234567890
    },
    "merchantTransactionId": "unique_001",
    "currency": "USD",
    "authorizedByShopper": true
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "ecpTransaction": {
        "routingNumber": "011075150",
        "accountType": "CONSUMER_CHECKING",
        "accountNumber": 4099999992
    },
    "amount": 100,
    "vendorsInfo": {
       "vendorInfo": [
          {"vendorId": "10398030"}
    	]
    },
    "payerInfo": {
        "zip": "02453",
        "firstName": "John",
        "lastName": "Doe",
        "phone": 1234567890
    },
    "softDescriptor": "ABC COMPANY",
    "currency": "USD",
    "authorizedByShopper": true,
     "transactionFraudInfo": {
          "fraudSessionId": 1234
    }
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
     "vaultedShopperId": "19570144",
     "ecpTransaction": {
        "accountType": "CONSUMER_CHECKING",
        "publicAccountNumber": "99992",
        "publicRoutingNumber": "75150"
    },
    "amount": "100",
    "payerInfo": {
        "zip": "02453",
        "firstName": "John",
        "lastName": "Doe",
        "phone": "1234567890"
    },
   
    "softDescriptor": "ABC COMPANY",
    "currency": "USD",
    "authorizedByShopper": true,
    "transactionFraudInfo": {"fraudSessionId": "1234"}
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "pfToken": "eba795a8ec2a8e7754afe7a69b0a0869fba0e6daec01e2d81e1ccbb6771c24ab_",
  "amount": 100,
  "currency": "USD",
  "payerInfo": {
    "zip": "02453",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "1234567890"
  },
  "softDescriptor": "ABC COMPANY",
  "authorizedByShopper": true
}'

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "ecpTransaction": {
        "routingNumber": "011075150",
        "accountType": "CONSUMER_CHECKING",
        "accountNumber": "4099999992"
    },
    "amount": "115.50",
    "payerInfo": {
        "zip": "02453",
        "firstName": "John",
        "lastName": "Doe",
        "phone": "1234567890"
    },
    "softDescriptor": "ABC COMPANY",
    "currency": "USD",
    "authorizedByShopper": true,
    "taxReference": "048deff0-a285-47e1-bc39-42f79bf0095b",
    "transactionFraudInfo": {"fraudSessionId": "1234"}
}

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "transactionOrderSource": "MOTO",
    "ecpTransaction": {
        "routingNumber": "011075150",
        "accountType": "CONSUMER_CHECKING",
        "accountNumber": "4099999992"
    },
    "amount": "100",
    "payerInfo": {
        "zip": "02453",
        "firstName": "John",
        "lastName": "Doe",
        "phone": "1234567890"
    },
    "softDescriptor": "ABC COMPANY",
    "currency": "USD",
    "authorizedByShopper": true,
    "transactionFraudInfo": {
        "fraudSessionId": "1234",
        "customerId": "121341",
        "customerCreationDate": "2021-08-05"
    }
}

Response Examples

{
    "ecpTransaction": {
        "routingNumber": "011075150",
        "accountType": "CONSUMER_CHECKING",
        "accountNumber": 4099999992
    },
    "amount": 100,
    "payerInfo": {
        "zip": "02453",
        "firstName": "John",
        "lastName": "Doe",
        "phone": 1234567890
    },
  	"vaultedShopperId": 21614935,
    "processingInfo": {"processingStatus": "PENDING"},
    "softDescriptor": "ABC COMPANY",
    "currency": "USD",
    "transactionId": 38504784,
    "fraudResultInfo": {"deviceDataCollector": "Y"}
}

{
    "ecpTransaction": {},
    "amount": 100,
    "vaultedShopperId": 19563598,
    "processingInfo": {"processingStatus": "PENDING"},
    "softDescriptor": "ABC COMPANY",
    "currency": "USD",
    "transactionId": 38504786
}

{
    "ecpTransaction": {
        "routingNumber": "011075150",
        "accountType": "CONSUMER_CHECKING",
        "accountNumber": 4099999992
    },
    "amount": 100,
    "payerInfo": {
        "zip": "02453",
        "firstName": "John",
        "lastName": "Doe",
        "phone": 1234567890
    },
  	"vaultedShopperId": 21614935,
    "merchantTransactionId": "unique_001",
    "processingInfo": {"processingStatus": "PENDING"},
    "currency": "USD",
    "transactionId": 38504788
}

{
  "transactionId": "1015593717",
  "vendorInfo": {
    "vendorId": 10398030,
    "commissionPercent": 30
  },
  "vendorsInfo": {
    "vendorInfo": [
      {
        "vendorId": 10398030,
        "commissionPercent": 30
      }
    ]
  },
  "softDescriptor": "ABC COMPANY",
  "amount": 100,
  "currency": "USD",
  "payerInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "zip": "02453",
    "phone": "1234567890"
  },
  "vaultedShopperId": 22324287,
  "ecpTransaction": {
    "accountNumber": "4099999992",
    "routingNumber": "011075150",
    "accountType": "CONSUMER_CHECKING"
  },
  "processingInfo": {
    "processingStatus": "PENDING"
  }
}

{
    "transactionId": "38505332",
    "softDescriptor": "ABC COMPANY",
    "amount": "100",
    "currency": "USD",
    "payerInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "zip": "02453",
        "phone": "1234567890"
    },
    "vaultedShopperId": "19570144",
    "ecpTransaction": {
        "accountType": "CONSUMER_CHECKING",
        "publicAccountNumber": "99992",
        "publicRoutingNumber": "75150"
    },
    "processingInfo": {
        "processingStatus": "PENDING"
    }
}

{
    "transactionId": "1066353507",
    "softDescriptor": "ABC COMPANY",
    "amount": 100,
    "currency": "USD",
    "payerInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "zip": "02453",
        "phone": "1234567890"
    },
    "vaultedShopperId": 37729623,
    "ecpTransaction": {
        "accountType": "CONSUMER_CHECKING",
        "publicAccountNumber": "99992",
        "publicRoutingNumber": "75150"
    },
    "processingInfo": {
        "processingStatus": "PENDING"
    },
    "fraudResultInfo": {}
}

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 authorizedByShopper 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 must include the vaultedShopperId property within the altTransaction 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 ecpTransaction 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 must include the merchantTransactionId property within the altTransaction resource in your request.

Create ECP transaction with Vendors Info

This example shows a Create ECP transaction request within a marketplace. Include vendorsInfo in the request to process a transaction involving one or more vendors. For more details, see Processing Transactions.

Create ECP transaction with multiple vaulted ACH

This example shows a Create ECP transaction request when the customer has more than one ACH account. When your vaulted shopper has multiple ACH accounts use ecpTransaction to identify which ACH account to use for the transaction.

Create ECP transaction with a token

This example shows a Create ECP transaction request with tokenized bank details. When you use BlueSnap's Secured Payment Collector, you can securely capture and tokenize the shopper's sensitive banking details. After the shopper's banking details have been submitted to BlueSnap and associated with the token, you can process the transaction by including the token within the pfToken property.

Create ECP transaction with MOTO

This example shows a Create ECP transaction request with MOTO. MOTO is passed as an indication that the transaction was done on behalf of the shopper, like with a phone order.

API Explorer

To test out a call, enter the request content below and then click Try it!

Tip: Use the JSON 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.

{
    "ecpTransaction": {
        "routingNumber": "011075150",
        "accountType": "CONSUMER_CHECKING",
        "accountNumber": 4099999992
    },
    "amount": 100,
    "payerInfo": {
        "zip": 02453,
        "firstName": "John",
        "lastName": "Doe",
        "phone": 1234567890
    },
    "softDescriptor": "ABC COMPANY",
    "currency": "USD",
    "authorizedByShopper": true
}

👍Prerequisite: Enable the ECP payment method in your account

Request Content

Response Details

Examples

Request Examples

Response Examples

Example Descriptions

Create basic ECP transaction with payer info

Create ECP transaction with vaulted shopper

Create ECP transaction with Merchant Transaction ID

Create ECP transaction with Vendors Info

Create ECP transaction with multiple vaulted ACH

Create ECP transaction with a token

Create ECP transaction with MOTO

API Explorer

👍
Prerequisite: Enable the ECP payment method in your account