Retrieve Pay by Bank Transaction

🚧

Beta Feature

Pay by Bank is currently in beta and not suitable for production environments.

This request retrieves details about a past Pay by Bank (Open Banking) transaction.

Request Content

No content is required in the request body. Enter the relevant IDs in the request URL as a path parameter:

By Transaction ID

/services/2/alt-transactions/{transaction-id}

For example:

https://sandbox.bluesnap.com/services/2/alt-transactions/123456782

By Merchant Transaction ID and Merchant ID

/services/2/alt-transactions/{merchant-transaction-id},{merchant-id}

For example:

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

Path Parameters

Path parametersTypeRequiredDescription
{transaction-id}integerrequired to retrieve by transaction.Unique identifier that BlueSnap assigned to the transaction.
{merchant-transaction-id}integerrequired to retrieve transaction by merchant transaction ID and merchant ID.Unique identifier that the merchant assigned to the transaction.
{merchant-id}integerrequired to retrieve transaction by merchant transaction ID and merchant ID.Unique identifier that BlueSnap assigned to the merchant.

Response Details

Successful requests return the HTTP response status code 200 OK and a response body that contains the following properties:

PropertyNotes
amountValue of the transaction in the provided currency.
currencyCurrency used to process the transaction.
pay-by-bank-transactionSee pay-by-bank-transaction.
payer-infoReturned when the shopper is a not a vaulted shopper. See payer-info.
processing-infoStatus of the transaction. See processing-info.
product-descriptionDetails about the product purchased in the transaction.
transaction-idUnique identifier of the transaction.
vaulted-shopper-idUnique identifier for the vaulted shopper.

Examples

Request Examples

curl --request GET \
     --url https://sandbox.bluesnap.com/services/2/alt-transactions/1065288084 \
     --header 'Authorization: Basic QVBJXzE2MTk2MjgyMzU0ODkyMDM5MTMzODc0OkFsdG9pZHMxIQ==' \
     --header 'accept: application/xml' \
     --header 'content-type: application/xml'
curl --request GET \
     --url https://sandbox.bluesnap.com/services/2/alt-transactions/unique_test_id,10427111 \
     --header 'Authorization: Basic QVBJXzE2MTk2MjgyMzU0ODkyMDM5MTMzODc0OkFsdG9pZHMxIQ==' \
     --header 'accept: application/xml' \
     --header 'content-type: application/xml'

Response Examples

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <transaction-id>1108067347</transaction-id>
    <amount>100</amount>
    <currency>EUR</currency>
    <payer-info>
        <first-name>John</first-name>
        <last-name>Doe</last-name>
        <country>fr</country>
        <zip>02453</zip>
        <phone>1234567890</phone>
    </payer-info>
    <vaulted-shopper-id>51668979</vaulted-shopper-id>
    <pay-by-bank-transaction>
        <pay-by-bank-url>https&#x3a;&#x2f;&#x2f;sandbox.bluesnap.com&#x2f;services&#x2f;fel&#x2f;pbb&#x2f;hostedpage&#x3f;hpid&#x3d;aHBpZDoxMTA4MDY3MzQ3OjEwMDAw&#x26;invid&#x3d;1108067347</pay-by-bank-url>
        <iban-first-four>DE73</iban-first-four>
        <iban-last-four>4946</iban-last-four>
    </pay-by-bank-transaction>
    <product-description>N&#x2f;A</product-description>
    <processing-info>
        <processing-status>PENDING</processing-status>
        <transaction-region>UK</transaction-region>
    </processing-info>
</alt-transaction>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <merchant-transaction-id>unique_test_id</merchant-transaction-id>
    <transaction-id>1108068311</transaction-id>
    <amount>515</amount>
    <currency>EUR</currency>
    <payer-info>
        <first-name>Jane</first-name>
        <last-name>Shopper</last-name>
        <country>de</country>
        <zip>12345</zip>
    </payer-info>
    <vaulted-shopper-id>51669313</vaulted-shopper-id>
    <pay-by-bank-transaction>
        <pay-by-bank-url>https&#x3a;&#x2f;&#x2f;sandbox.bluesnap.com&#x2f;services&#x2f;fel&#x2f;pbb&#x2f;hostedpage&#x3f;hpid&#x3d;aHBpZDoxMTA4MDY4MzExOjUxNTAw&#x26;invid&#x3d;1108068311</pay-by-bank-url>
        <iban-first-four>DE12</iban-first-four>
        <iban-last-four>3210</iban-last-four>
    </pay-by-bank-transaction>
    <product-description>N&#x2f;A</product-description>
    <processing-info>
        <processing-status>PENDING</processing-status>
        <transaction-region>UK</transaction-region>
    </processing-info>
</alt-transaction>