{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/alt-transactions/:transactionId","auth":"optional","results":{"codes":[]},"settings":"57ee593a21ceb20e0061959e","examples":{"codes":[]},"method":"get","params":[{"name":"transactionId","type":"string","default":"","desc":"transaction ID received in the response from BlueSnap","required":false,"in":"path","ref":"","_id":"596cf1cb20660f0015f5191a"}]},"next":{"description":"","pages":[]},"title":"Retrieve SEPA DD Transaction","type":"endpoint","slug":"retrieve-sepa-dd-transaction","excerpt":"","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**Note**: If you are using the [API + Hosted Page Hybrid solution](https://support.bluesnap.com/docs/hybrid-solution), this can also return transactions created in Hosted Payment Pages. \n<br />\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 `transactionId` into the web service URL, in the format:\n`services/2/alt-transactions/{transactionId}`\n\nFor example: `services/2/alt-transactions/38504790`\n\n**Retrieve based on Merchant Transaction ID and Merchant ID**\nEnter the `merchantTransactionId` and `merchantId` into the web service URL, in the format:\n`services/2/alt-transactions/{merchantTransactionId},{merchantId}`\n\nFor example: `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 `altTransaction` resource (see [altTransaction](doc:alt-transaction)). \n\n##Staying informed of the transaction status\nThe `processingStatus` property is returned in the response, and it indicates the status of the transaction. The possible values are as follows.\n\nProperty values|Invoice status\n---|---\n`PENDING`|Not yet approved \n`SUCCESS`|Approved and the shopper's account was debited\n`FAIL`|Canceled and the shopper's account was not debited \n`REFUNDED`|Refunded in response to a chargeback or refund requested by the shopper\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/38504790 \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\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/json' \\\\\\n-H 'Accept: application/json' \\\\ \\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 `processingStatus` value of **SUCCESS**. \n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"transactionId\\\": \\\"38504790\\\",\\n \\\"softDescriptor\\\": \\\"Testing\\\",\\n \\\"amount\\\": 9.65,\\n \\\"currency\\\": \\\"EUR\\\",\\n \\\"payerInfo\\\": {\\n \\\"firstName\\\": \\\"John\\\",\\n \\\"lastName\\\": \\\"Doe\\\"\\n },\\n \\\"vaultedShopperId\\\": 21788723,\\n \\\"sepaDirectDebitTransaction\\\": {\\n \\\"ibanFirstFour\\\": \\\"DE09\\\",\\n \\\"ibanLastFour\\\": \\\"7893\\\",\\n \\\"mandateId\\\": \\\"Ooo153467\\\",\\n \\\"mandateDate\\\": \\\"21-Jul-17\\\"\\n },\\n \\\"processingInfo\\\": {\\n \\\"processingStatus\\\": \\\"SUCCESS\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"Retrieve SEPA Direct Debit Transaction: 200 OK - by Transaction ID\"\n },\n {\n \"code\": \"{\\n \\\"merchantTransactionId\\\": \\\"unique_001\\\", \\n \\\"transactionId\\\": \\\"38504790\\\",\\n \\\"softDescriptor\\\": \\\"Testing\\\",\\n \\\"amount\\\": 9.65,\\n \\\"currency\\\": \\\"EUR\\\",\\n \\\"payerInfo\\\": {\\n \\\"firstName\\\": \\\"John\\\",\\n \\\"lastName\\\": \\\"Doe\\\"\\n },\\n \\\"vaultedShopperId\\\": 21788723,\\n \\\"sepaDirectDebitTransaction\\\": {\\n \\\"ibanFirstFour\\\": \\\"DE09\\\",\\n \\\"ibanLastFour\\\": \\\"7893\\\",\\n \\\"mandateId\\\": \\\"Ooo153467\\\",\\n \\\"mandateDate\\\": \\\"21-Jul-17\\\"\\n },\\n \\\"processingInfo\\\": {\\n \\\"processingStatus\\\": \\\"SUCCESS\\\"\\n }\\n}\",\n \"language\": \"json\",\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 (e.g. *1014672453*) in the `transactionId` field; this automatically inserts the ID into the request URL. Then, click **Try it!**.","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e5d3aa2dc4d35003d784d7d","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"SEPA Direct Debit Transactions","slug":"sepa-direct-debit-transactions","order":4,"from_sync":false,"reference":false,"_id":"5e5d3aa2dc4d35003d784cf4","version":"5e5d3aa2dc4d35003d784d9d","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2017-07-10T15:05:46.960Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"Live","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e5d3aa2dc4d35003d784cf0","5e5d3aa2dc4d35003d784cf1","5e5d3aa2dc4d35003d784cf2","5e5d3aa2dc4d35003d784cf3","5e5d3aa2dc4d35003d784cf4","5e5d3aa2dc4d35003d784cf5","5e5d3aa2dc4d35003d784cf6","5e5d3aa2dc4d35003d784cf7","5e5d3aa2dc4d35003d784cf8","5e5d3aa2dc4d35003d784cf9","5e5d3aa2dc4d35003d784cfa","5e5d3aa2dc4d35003d784cfb","5e5d3aa2dc4d35003d784cfc","5e5d3aa2dc4d35003d784cfd","5e5d3aa2dc4d35003d784cfe","5e5d57ed1362cf0064910881","5e7a7ac40efab8003ae688c3"],"_id":"5e5d3aa2dc4d35003d784d9d","project":"57336fd5a6a9c40e00e13a0b","__v":2,"forked_from":"5c6c23e4735b81006177d0a4","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2017-07-17T17:16:35.401Z","githubsync":"","__v":4}getRetrieve SEPA DD Transaction
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
transactionId:
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.
Note: If you are using the API + Hosted Page Hybrid solution, this can also return transactions created in Hosted Payment Pages.
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/alt-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).
Staying informed of the transaction status
The processingStatus property is returned in the response, and it indicates the status of the transaction. The possible values are as follows.
| Property values | Invoice status |
|---|---|
PENDING |
Not yet approved |
SUCCESS |
Approved and the shopper's account was debited |
FAIL |
Canceled and the shopper's account was not debited |
REFUNDED |
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/38504790 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '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 '{
"transactionId": "38504790",
"softDescriptor": "Testing",
"amount": 9.65,
"currency": "EUR",
"payerInfo": {
"firstName": "John",
"lastName": "Doe"
},
"vaultedShopperId": 21788723,
"sepaDirectDebitTransaction": {
"ibanFirstFour": "DE09",
"ibanLastFour": "7893",
"mandateId": "Ooo153467",
"mandateDate": "21-Jul-17"
},
"processingInfo": {
"processingStatus": "SUCCESS"
}
}{
"merchantTransactionId": "unique_001",
"transactionId": "38504790",
"softDescriptor": "Testing",
"amount": 9.65,
"currency": "EUR",
"payerInfo": {
"firstName": "John",
"lastName": "Doe"
},
"vaultedShopperId": 21788723,
"sepaDirectDebitTransaction": {
"ibanFirstFour": "DE09",
"ibanLastFour": "7893",
"mandateId": "Ooo153467",
"mandateDate": "21-Jul-17"
},
"processingInfo": {
"processingStatus": "SUCCESS"
}
}
