Retrieve ECP Transaction

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 transactionId into the web service URL, in the format:
services/2/alt-transactions/{transactionId}

For example:
services/2/transactions/38504790

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

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 altTransaction resource (see altTransaction).

---

Examples

Request Examples

Retrieve ECP Transaction Request: by Transaction ID

curl -v -X GET https://sandbox.bluesnap.com/services/2/alt-transactions/1035512757 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '

by Merchant Transaction ID and Merchant ID

curl -v -X GET https://sandbox.bluesnap.com/services/2/alt-transactions/unique_001,395608 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '

Response Examples

Retrieve ECP Transaction Response: 200 OK - by Transaction ID

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

by Merchant Transaction ID and Merchant ID

{
    "merchantTransactionId": "unique_001",
    "transactionId": "38504788",
    "amount": "100",
    "currency": "USD",
    "transactionApprovalDate": "09/29/2020",
    "transactionApprovalTime": "13:08:47",
    "payerInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "zip": "02453",
        "phone": "1234567890"
    },
    "ecpTransaction": {
        "accountNumber": "4099999992",
        "routingNumber": "011075150",
        "accountType": "CONSUMER_CHECKING"
    },
    "processingInfo": {
        "processingStatus": "SUCCESS"
    }
}

with vendor info

{
    "merchantTransactionId": "456",
    "transactionId": "38418384",
    "vendorInfo": {
        "vendorId": 397808,
        "commissionPercent": 20
    },
    "softDescriptor": "ABC COMPANY",
    "amount": 50,
    "currency": "USD",
    "transactionApprovalDate": "09/29/2020",
    "transactionApprovalTime": "13:08:47",
    "payerInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "zip": 02453,
        "phone": 1234567890
    },
    "ecpTransaction": {
        "accountNumber": 4099999992,
        "accountType": "CONSUMER_CHECKING",
        "routingNumber": "011075150"
    },
    "processingInfo": {
        "processingStatus": "REFUNDED"
    },
    "refunds": {
        "balanceAmount": 49,
        "vendorBalanceAmount": 9.8,
        "refund": [
            {
                "amount": 1,
                "vendorAmount": 0.2,
                "currency": "USD",
                "date": "2020-09-30"
            }
        ]
    }
}

200 OK API v3.0 - by Transaction ID

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

📘

Note:

In API v3.0, the ecpTransaction 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 transactionId field. This automatically inserts the ID into the request URL. Leave the Body Content field empty.