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.


πŸ“˜

Tip

You can test out a request that hits our sandbox in real-time. Follow the instructions here to use the "Try It!" feature on the right side.

Request Content

Send an altTransaction object with the following:

PropertyTypeRequired
merchantTransactionIdstringoptional
softDescriptorstringoptional
amountdecimalrequired
currencystringrequired
taxReferencestringoptional
vendorsInfoobjectoptional (see vendorsInfo)
payerInfoobjectrequired if vaultedShopperId is not sent (see payerInfo)
vaultedShopperIdintegerrequired if payerInfo is not sent
pfTokenstringrequired if using Secured Payment Collector
ecpTransactionobjectrequired if pfToken is not sent (see ecpTransaction)
authorizedByShopperbooleanrequired, value must be true
transactionMetaDataobjectoptional (see transactionMetaData)
transactionFraudInfoobjectoptional (see transactionFraudInfo)

Response Details

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

PropertyNotes
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": {}
}

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