{"_id":"59df6a543b756800107b2051","category":{"_id":"59df6a523b756800107b2023","version":"59df6a523b756800107b201e","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-07-27T17:33:18.096Z","from_sync":false,"order":4,"slug":"sepa-direct-debit-transactions","title":"SEPA Direct Debit Transactions"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"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":2,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-27T17:48:48.987Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"optional","params":[{"_id":"5980a0ade4b008001ffc1e32","ref":"","in":"path","required":false,"desc":"transaction ID received in the response from BlueSnap","default":"","type":"string","name":"transaction-id"}],"url":"/alt-transactions/:transaction-id"},"isReference":false,"order":1,"body":"[block:html]\n{\n  \"html\": \"<script>\\n  // hide body textbox of API Explorer\\n $(document).ready(function() {\\n  $(\\\"textarea[placeholder='Body Content']\\\").hide();  \\n }); \\n</script>\"\n}\n[/block]\nThis request gets details about a past SEPA Direct Debit transaction, such as the transaction ID, amount, currency, payer info or vaulted shopper, and so on.\n\n<a class=\"btn btn-success\" href=\"#section-api-explorer-for-request-based-on-transaction-id-\" role=\"button\">Try it in the API Explorer</a>\n\n\n###Request Content\nNo content is required in the request body. Enter the relevant IDs in the request URL, as follows:\n\n**Retrieve based on Transaction ID**\nEnter the `transaction-id` into the web service URL, in the format:\n`services/2/alt-transactions/{transaction-id}`\n\nFor example:\n`services/2/alt-transactions/38504790`\n\n**Retrieve based on Merchant Transaction ID and Merchant ID**\nEnter the `merchant-transaction-id` and `merchant-id` into the web service URL, in the format:\n`services/2/alt-transactions/{merchant-transaction-id},{merchant-id}`\n\nFor example:\n`services/2/alt-transactions/unique_001,395608`\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved `alt-transaction` resource (see [alt-transaction](doc:alt-transaction)). \n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Staying informed of the transaction status\",\n  \"body\": \"The `processing-status` property is returned in the response, and it will indicate the status of the transaction.\\nThe possible values are: \\n* **PENDING** - Invoice was not yet approved. \\n* **SUCCESS** - Invoice was approved and the shopper's account was debited.\\n* **FAIL** - Invoice was canceled and the shopper's account was not debited. \\n* **REFUNDED** - Invoice was refunded in response to a chargeback or refund requested by the shopper.\"\n}\n[/block]\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/alt-transactions/1011189089 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Accept: application/xml' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve SEPA Direct Debit Transaction: by Transaction ID\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/alt-transactions/unique_001,395608 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Accept: application/xml' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n      \"language\": \"curl\",\n      \"name\": \"by Merchant Transaction ID and Merchant ID\"\n    }\n  ]\n}\n[/block]\n###Response Examples\nThe below examples assume the shopper's bank has approved the transaction and their account has been debited, shown by a `processing-status` value of **SUCCESS**. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n    <transaction-id>1011189089</transaction-id>\\n    <soft-descriptor>ABC COMPANY</soft-descriptor>\\n    <amount>9.65</amount>\\n    <currency>EUR</currency>\\n    <payer-info>\\n        <first-name>John</first-name>\\n        <last-name>Doe</last-name>\\n    </payer-info>\\n    <vaulted-shopper-id>21781957</vaulted-shopper-id>\\n    <sepa-direct-debit-transaction>\\n        <iban-first-four>DE09</iban-first-four>\\n        <iban-last-four>7893</iban-last-four>\\n        <mandate-id>Ooo153451</mandate-id>\\n        <mandate-date>01-Aug-17</mandate-date>\\n    </sepa-direct-debit-transaction>\\n    <processing-info>\\n        <processing-status>SUCCESS</processing-status>\\n    </processing-info>\\n</alt-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"Retrieve SEPA Direct Debit Transaction: 200 OK - by Transaction ID\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n    <transaction-id>38504790</transaction-id>\\n  \\t<merchant-transaction-id>unique_001</merchant-transaction-id>\\n    <soft-descriptor>ABC COMPANY</soft-descriptor>\\n    <amount>9.65</amount>\\n    <currency>EUR</currency>\\n    <payer-info>\\n        <first-name>John</first-name>\\n        <last-name>Doe</last-name>\\n    </payer-info>\\n    <vaulted-shopper-id>21788723</vaulted-shopper-id>\\n    <sepa-direct-debit-transaction>\\n        <iban-first-four>DE09</iban-first-four>\\n        <iban-last-four>7893</iban-last-four>\\n        <mandate-id>Ooo153467</mandate-id>\\n        <mandate-date>01-Aug-17</mandate-date>\\n    </sepa-direct-debit-transaction>\\n    <processing-info>\\n        <processing-status>SUCCESS</processing-status>\\n    </processing-info>\\n</alt-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - by Merchant Transaction ID and Merchant ID\"\n    }\n  ]\n}\n[/block]\n##API Explorer (for request based on Transaction ID)\nTo test out a call, enter an existing transaction ID in the `transaction-id` field. This will automatically insert the ID into the request URL.","excerpt":"","slug":"retrieve-sepa-dd-transaction","type":"get","title":"Retrieve SEPA DD Transaction"}

getRetrieve SEPA DD Transaction


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

transaction-id:
string
transaction ID received in the response from BlueSnap

Documentation

This request gets details about a past SEPA Direct Debit transaction, such as the transaction ID, amount, currency, payer info or vaulted shopper, and so on.

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

For example:
services/2/alt-transactions/38504790

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

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

Staying informed of the transaction status

The processing-status property is returned in the response, and it will indicate the status of the transaction.
The possible values are:

  • PENDING - Invoice was not yet approved.
  • SUCCESS - Invoice was approved and the shopper's account was debited.
  • FAIL - Invoice was canceled and the shopper's account was not debited.
  • REFUNDED - Invoice was refunded in response to a chargeback or refund requested by the shopper.


Examples

Request Examples

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

Response Examples

The below examples assume the shopper's bank has approved the transaction and their account has been debited, shown by a processing-status value of SUCCESS.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <transaction-id>1011189089</transaction-id>
    <soft-descriptor>ABC COMPANY</soft-descriptor>
    <amount>9.65</amount>
    <currency>EUR</currency>
    <payer-info>
        <first-name>John</first-name>
        <last-name>Doe</last-name>
    </payer-info>
    <vaulted-shopper-id>21781957</vaulted-shopper-id>
    <sepa-direct-debit-transaction>
        <iban-first-four>DE09</iban-first-four>
        <iban-last-four>7893</iban-last-four>
        <mandate-id>Ooo153451</mandate-id>
        <mandate-date>01-Aug-17</mandate-date>
    </sepa-direct-debit-transaction>
    <processing-info>
        <processing-status>SUCCESS</processing-status>
    </processing-info>
</alt-transaction>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <transaction-id>38504790</transaction-id>
  	<merchant-transaction-id>unique_001</merchant-transaction-id>
    <soft-descriptor>ABC COMPANY</soft-descriptor>
    <amount>9.65</amount>
    <currency>EUR</currency>
    <payer-info>
        <first-name>John</first-name>
        <last-name>Doe</last-name>
    </payer-info>
    <vaulted-shopper-id>21788723</vaulted-shopper-id>
    <sepa-direct-debit-transaction>
        <iban-first-four>DE09</iban-first-four>
        <iban-last-four>7893</iban-last-four>
        <mandate-id>Ooo153467</mandate-id>
        <mandate-date>01-Aug-17</mandate-date>
    </sepa-direct-debit-transaction>
    <processing-info>
        <processing-status>SUCCESS</processing-status>
    </processing-info>
</alt-transaction>

API Explorer (for request based on Transaction ID)

To test out a call, enter an existing transaction ID in the transaction-id field. This will automatically insert the ID into the request URL.


User Information

Try It Out


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