{"_id":"5c6c2407b8d4b2000e72da10","category":{"_id":"5c6c2407b8d4b2000e72d989","version":"5c6c2407b8d4b2000e72da25","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-07-27T10:22:06.636Z","from_sync":false,"order":8,"slug":"subscriptions","title":"Subscriptions"},"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"version":{"_id":"5c6c2407b8d4b2000e72da25","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5beec5a5f95d82011c6f3714","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5c6c2407b8d4b2000e72d981","5c6c2407b8d4b2000e72d982","5c6c2407b8d4b2000e72d983","5c6c2407b8d4b2000e72d984","5c6c2407b8d4b2000e72d985","5c6c2407b8d4b2000e72d986","5c6c2407b8d4b2000e72d987","5c6c2407b8d4b2000e72d988","5c6c2407b8d4b2000e72d989","5c6c2407b8d4b2000e72d98a","5c6c2407b8d4b2000e72d98b","5c6c2407b8d4b2000e72d98c","5c6c2407b8d4b2000e72d98d","5c6c2407b8d4b2000e72d98e","5c6c2407b8d4b2000e72d98f","5c6c2407b8d4b2000e72d990"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-XML","version":"8976-XML"},"githubsync":"","__v":1,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-01T10:59:20.000Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"","auth":"optional","params":[{"_id":"59e4ee81737f88001aed76d4","ref":"","in":"query","required":true,"desc":"transaction ID received in the response from BlueSnap","default":"","type":"string","name":"transactionid"}],"url":"/recurring/subscriptions/charges/resolve?transactionid=:transactionid"},"isReference":false,"order":12,"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]\nThe Retrieve Specific Charge request enables you to retrieve details about one existing charge.\n\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\nEnter the transaction ID into the query string of the web service URL, in the format:\n`services/2/recurring/subscriptions/charges/resolve?transactionid={transaction ID}`\n\nFor example:\n`services/2/recurring/subscriptions/charges/resolve?transactionid=1011791571`\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved [charge](doc:charge) resource.\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/recurring/subscriptions/charges/resolve?transactionid=1012460801 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n \"language\": \"curl\",\n \"name\": \"Retrieve Specific Charge Request\"\n }\n ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"HTTP/ 1.1 200 OK\\n\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<charge xmlns=\\\"http://ws.plimus.com\\\">\\n <charge-id>12116263</charge-id>\\n <subscription-id>8491535</subscription-id>\\n <plan-id>2283845</plan-id>\\n <vaulted-shopper-id>21188039</vaulted-shopper-id>\\n <transaction-id>1012460801</transaction-id>\\n <transaction-date>2016-08-01</transaction-date>\\n <amount>100.00</amount>\\n <currency>USD</currency>\\n <soft-descriptor>BLS*default_descriptor</soft-descriptor>\\n <payment-source>\\n <credit-card-info>\\n <credit-card>\\n <card-last-four-digits>1111</card-last-four-digits>\\n <card-type>VISA</card-type>\\n <card-sub-type>CREDIT</card-sub-type>\\n <card-category>CLASSIC</card-category>\\n <expiration-month>07</expiration-month>\\n <expiration-year>2023</expiration-year>\\n </credit-card>\\n </credit-card-info>\\n </payment-source>\\n <charge-info>\\n <from-date>2016-08-01</from-date>\\n <to-date>2016-08-15</to-date>\\n <charge-type>INITIAL</charge-type>\\n </charge-info>\\n</charge>\",\n \"language\": \"xml\",\n \"name\": \"Retrieve Specific Charge Response: 200 OK\"\n }\n ]\n}\n[/block]\n<hr>\n\n##Example Descriptions\nAbove is an example request. Note that no XML content is required in the request body. You simply need to include the transaction ID in the query string of the request URL.\n\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##API Explorer\nTo test out a call, enter an existing transaction ID (e.g. 1014953379) in the `transactionid` field. This will automatically insert the transaction ID into the query string.","excerpt":"","slug":"retrieve-specific-charge","type":"endpoint","title":"Retrieve Specific Charge"}getRetrieve Specific Charge
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Query Params
transactionid:
required
string
transaction ID received in the response from BlueSnap
Documentation
The Retrieve Specific Charge request enables you to retrieve details about one existing charge.
Request Content
Enter the transaction ID into the query string of the web service URL, in the format:services/2/recurring/subscriptions/charges/resolve?transactionid={transaction ID}
For example:services/2/recurring/subscriptions/charges/resolve?transactionid=1011791571
Response Details
If successful, the response HTTP status code is 200 OK.
The response contains the retrieved charge resource.
Examples
Request Examples
curl -v -X GET https://sandbox.bluesnap.com/services/2/recurring/subscriptions/charges/resolve?transactionid=1012460801 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='HTTP/ 1.1 200 OK
<charge xmlns="http://ws.plimus.com">
<charge-id>12116263</charge-id>
<subscription-id>8491535</subscription-id>
<plan-id>2283845</plan-id>
<vaulted-shopper-id>21188039</vaulted-shopper-id>
<transaction-id>1012460801</transaction-id>
<transaction-date>2016-08-01</transaction-date>
<amount>100.00</amount>
<currency>USD</currency>
<soft-descriptor>BLS*default_descriptor</soft-descriptor>
<payment-source>
<credit-card-info>
<credit-card>
<card-last-four-digits>1111</card-last-four-digits>
<card-type>VISA</card-type>
<card-sub-type>CREDIT</card-sub-type>
<card-category>CLASSIC</card-category>
<expiration-month>07</expiration-month>
<expiration-year>2023</expiration-year>
</credit-card>
</credit-card-info>
</payment-source>
<charge-info>
<from-date>2016-08-01</from-date>
<to-date>2016-08-15</to-date>
<charge-type>INITIAL</charge-type>
</charge-info>
</charge>Example Descriptions
Above is an example request. Note that no XML content is required in the request body. You simply need to include the transaction ID in the query string of the request URL.
API Explorer
To test out a call, enter an existing transaction ID (e.g. 1014953379) in the transactionid field. This will automatically insert the transaction ID into the query string.