{"_id":"59a45d447ee621000fc9d3d2","category":{"_id":"59a45d447ee621000fc9d3c0","version":"59a45d437ee621000fc9d3b7","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":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:13:23.840Z","releaseDate":"2017-08-28T18:13:23.840Z","categories":["59a45d447ee621000fc9d3b8","59a45d447ee621000fc9d3b9","59a45d447ee621000fc9d3ba","59a45d447ee621000fc9d3bb","59a45d447ee621000fc9d3bc","59a45d447ee621000fc9d3bd","59a45d447ee621000fc9d3be","59a45d447ee621000fc9d3bf","59a45d447ee621000fc9d3c0","59a45d447ee621000fc9d3c1","59a45d447ee621000fc9d3c2","59a45d447ee621000fc9d3c3","59a45d447ee621000fc9d3c4","59a45d447ee621000fc9d3c5","59a45d447ee621000fc9d3c6","59a45d447ee621000fc9d3c7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-01T10:59:20.000Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"","auth":"optional","params":[{"_id":"579f2b8806ff650e0092b8f3","ref":"","in":"path","required":true,"desc":"BlueSnap identifier for the charge.","default":"","type":"int","name":"charge-id"}],"url":"/recurring/subscriptions/charges/:charge-id"},"isReference":false,"order":28,"body":"The 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 `charge-id` into the web service URL, in the format:\n`services/2/recurring/subscriptions/charges/{charge-id}`\n\nFor example:\n`services/2/recurring/subscriptions/charges/5678`\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/12116263 \\\\\\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&#x2a;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>2019</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 charge ID in 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 charge ID (e.g. 12116263) in the `charge-id` field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.","excerpt":"","slug":"retrieve-specific-charge","type":"get","title":"Retrieve Specific Charge"}

getRetrieve Specific Charge


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

charge-id:
required
integer
BlueSnap identifier for the charge.

Documentation

The Retrieve Specific Charge request enables you to retrieve details about one existing charge.

Try it in the API Explorer

Request Content

Enter the charge-id into the web service URL, in the format:
services/2/recurring/subscriptions/charges/{charge-id}

For example:
services/2/recurring/subscriptions/charges/5678

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/12116263 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

HTTP/ 1.1 200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<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&#x2a;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>2019</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 charge ID in the request URL.



Back to Top


API Explorer

To test out a call, enter an existing charge ID (e.g. 12116263) in the charge-id field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.


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