{"_id":"59a45d2bd12e81000f842efb","category":{"_id":"59a45d2bd12e81000f842eea","version":"59a45d2bd12e81000f842ee2","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-07-27T10:22:06.636Z","from_sync":false,"order":7,"slug":"subscriptions","title":"Subscriptions"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"59a45d2bd12e81000f842ee2","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:12:59.168Z","releaseDate":"2017-08-28T18:12:59.168Z","categories":["59a45d2bd12e81000f842ee3","59a45d2bd12e81000f842ee4","59a45d2bd12e81000f842ee5","59a45d2bd12e81000f842ee6","59a45d2bd12e81000f842ee7","59a45d2bd12e81000f842ee8","59a45d2bd12e81000f842ee9","59a45d2bd12e81000f842eea","59a45d2bd12e81000f842eeb","59a45d2bd12e81000f842eec","59a45d2bd12e81000f842eed","59a45d2bd12e81000f842eee","59a45d2bd12e81000f842eef","59a45d2bd12e81000f842ef0","59a45d2bd12e81000f842ef1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"__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":"57ee593a21ceb20e0061959e","auth":"optional","params":[{"_id":"579f2b8806ff650e0092b8f3","ref":"","in":"path","required":true,"desc":"BlueSnap identifier for the charge.","default":"","type":"int","name":"chargeId"}],"url":"/recurring/subscriptions/charges/:chargeId"},"isReference":false,"order":26,"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 `chargeId` into the web service URL, in the format:\n`services/2/recurring/subscriptions/charges/{chargeId}`\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)** object.\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/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\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\": \"{\\n \\\"amount\\\": 100,\\n \\\"vaultedShopperId\\\": 21188039,\\n \\\"chargeInfo\\\": {\\n \\\"fromDate\\\": \\\"2016-08-01\\\",\\n \\\"toDate\\\": \\\"2016-08-15\\\",\\n \\\"chargeType\\\": \\\"INITIAL\\\"\\n },\\n \\\"chargeId\\\": 12116263,\\n \\\"paymentSource\\\": {\\\"creditCardInfo\\\": {\\\"creditCard\\\": {\\n \\\"expirationYear\\\": 2019,\\n \\\"cardLastFourDigits\\\": 1111,\\n \\\"cardSubType\\\": \\\"CREDIT\\\",\\n \\\"cardCategory\\\": \\\"CLASSIC\\\",\\n \\\"cardType\\\": \\\"VISA\\\",\\n \\\"expirationMonth\\\": \\\"07\\\"\\n }}},\\n \\\"softDescriptor\\\": \\\"BLS*default_descriptor\\\",\\n \\\"planId\\\": 2283845,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"transactionDate\\\": \\\"2016-08-01\\\",\\n \\\"subscriptionId\\\": 8491535,\\n \\\"transactionId\\\": 1012460801\\n}\",\n \"language\": \"json\",\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 content is required in the request body. You simply need to include the charge ID in the request URL.\nThe response contains the retrieved **[charge](doc:charge)** object.\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 `chargeId` 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
chargeId:
required
integer
BlueSnap identifier for the charge.
Documentation
The Retrieve Specific Charge request enables you to retrieve details about one existing charge.
Request Content
Enter the chargeId into the web service URL, in the format:services/2/recurring/subscriptions/charges/{chargeId}
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 object.
Examples
Request Examples
curl -v -X GET https://sandbox.bluesnap.com/services/2/recurring/subscriptions/charges/12116263 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '{
"amount": 100,
"vaultedShopperId": 21188039,
"chargeInfo": {
"fromDate": "2016-08-01",
"toDate": "2016-08-15",
"chargeType": "INITIAL"
},
"chargeId": 12116263,
"paymentSource": {"creditCardInfo": {"creditCard": {
"expirationYear": 2019,
"cardLastFourDigits": 1111,
"cardSubType": "CREDIT",
"cardCategory": "CLASSIC",
"cardType": "VISA",
"expirationMonth": "07"
}}},
"softDescriptor": "BLS*default_descriptor",
"planId": 2283845,
"currency": "USD",
"transactionDate": "2016-08-01",
"subscriptionId": 8491535,
"transactionId": 1012460801
}Example Descriptions
Above is an example request. Note that no content is required in the request body. You simply need to include the charge ID in the request URL.
The response contains the retrieved charge object.
API Explorer
To test out a call, enter an existing charge ID (e.g. 12116263) in the chargeId field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.