{"_id":"5c6c23e4735b81006177d082","category":{"_id":"5c6c23e4735b81006177d007","version":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-10-15T15:28:41.796Z","from_sync":false,"order":1,"slug":"payment-transaction-service","title":"Card/Wallet Transactions"},"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"version":{"_id":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedd214812951004a2ad9df","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5c6c23e4735b81006177d006","5c6c23e4735b81006177d007","5c6c23e4735b81006177d008","5c6c23e4735b81006177d009","5c6c23e4735b81006177d00a","5c6c23e4735b81006177d00b","5c6c23e4735b81006177d00c","5c6c23e4735b81006177d00d","5c6c23e4735b81006177d00e","5c6c23e4735b81006177d00f","5c6c23e4735b81006177d010","5c6c23e4735b81006177d011","5c6c23e4735b81006177d012","5c6c23e4735b81006177d013","5c6c23e4735b81006177d014"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":1,"metadata":{"title":"","description":"","image":[]},"updates":["5cf2ebd683e0140043d27e7e"],"next":{"pages":[],"description":""},"createdAt":"2015-10-21T17:17:37.750Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"put","results":{"codes":[{"language":"text","code":""}]},"settings":"57ee593a21ceb20e0061959e","auth":"optional","params":[],"url":"/transactions"},"isReference":true,"order":2,"body":"Capture is a request that submits a previously authorized transaction for settlement (i.e. payment by the shopper). Note that each credit card company will only hold the authorization for a limited period (for example, 3-10 days, depending on the credit card scheme).\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Auth Only required before Capture\",\n  \"body\": \"Before you can send a transaction for capture, you must send it for authorization using the [Auth Only](doc:auth-only) request. \\n\\nThe capture will be performed based on the details that were in the Auth Only request (currency, credit card, etc.).\"\n}\n[/block]\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\n\nSend a **[cardTransaction](doc:card-transaction)** object, with the following:\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`cardTransactionType` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, value must be **CAPTURE**\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transactionId` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, value must be the transaction ID from the [Auth Only](doc:auth-only) response\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`amount` &nbsp;&nbsp;&nbsp; *decimal* &nbsp;&nbsp;&nbsp;optional&nbsp;&nbsp;&nbsp; default value is the full authorization amount\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`softDescriptor` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transactionMetaData` *object* &nbsp;&nbsp;&nbsp;optional (see [transactionMetaData](doc:transaction-meta-data))\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendorsInfo` *object* &nbsp;&nbsp;&nbsp;optional &nbsp;&nbsp;&nbsp; applicable if using marketplace vendor(s) (see [vendorsInfo](doc:vendorsinfo))\n\n###Response Details\n\nIf successful, the response HTTP status code is 200 OK and contains the [**cardTransaction**](doc:card-transaction) object. The `transactionId` in the response will match the `transactionId` for the initial [Auth Only](doc:auth-only).\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n  \\\"cardTransactionType\\\": \\\"CAPTURE\\\",\\n  \\\"transactionId\\\": \\\"1011671985\\\"\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"Capture: Basic\"\n    },\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n  \\\"cardTransactionType\\\": \\\"CAPTURE\\\",\\n  \\\"transactionId\\\": \\\"1015593705\\\",\\n  \\\"vendorsInfo\\\": {\\n    \\\"vendorInfo\\\": [\\n       {\\\"vendorId\\\": 10398032}\\n    ]\\n  }\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"with vendors info\"\n    },\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n  \\\"cardTransactionType\\\": \\\"CAPTURE\\\",\\n  \\\"transactionId\\\": \\\"1016133355\\\",\\n  \\\"amount\\\": 75\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"with amount\"\n    },\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n  \\\"cardTransactionType\\\": \\\"CAPTURE\\\",\\n  \\\"transactionId\\\": \\\"1016141063\\\",\\n  \\\"amount\\\": 65,\\n  \\\"vendorsInfo\\\": {\\n    \\\"vendorInfo\\\": [\\n      {\\\"vendorId\\\": 10398032}\\n    ]\\n  }\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"with amount and vendors info\"\n    }\n  ]\n}\n[/block]\n###Response Examples \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"amount\\\": 11,\\n  \\\"vaultedShopperId\\\": 1234,\\n  \\\"processingInfo\\\": {\\\"processingStatus\\\": \\\"SUCCESS\\\"},\\n  \\\"softDescriptor\\\": \\\"BLS*DescTest\\\",\\n  \\\"cardHolderInfo\\\": {\\n    \\\"firstName\\\": \\\"test first name\\\",\\n    \\\"lastName\\\": \\\"test last name\\\",\\n    \\\"zip\\\": \\\"123456\\\"\\n  },\\n  \\\"currency\\\": \\\"USD\\\",\\n  \\\"creditCard\\\": {\\n    \\\"cardLastFourDigits\\\": \\\"0026\\\",\\n    \\\"cardSubType\\\": \\\"CREDIT\\\",\\n    \\\"cardType\\\": \\\"VISA\\\",\\n    \\\"cardCategory\\\": \\\"CLASSIC\\\"\\n  },\\n  \\\"cardTransactionType\\\": \\\"CAPTURE\\\",\\n  \\\"transactionId\\\": \\\"1011671985\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 OK - Basic\"\n    },\n    {\n      \"code\": \"{\\n  \\\"cardTransactionType\\\": \\\"CAPTURE\\\",\\n  \\\"vendorInfo\\\": {\\n    \\\"vendorId\\\": 10398032,\\n    \\\"commissionPercent\\\": 20\\n  },\\n  \\\"vendorsInfo\\\": {\\n    \\\"vendorInfo\\\": [\\n      {\\n        \\\"vendorId\\\": 10398032,\\n        \\\"commissionPercent\\\": 20\\n      }\\n    ]\\n  },\\n  \\\"transactionId\\\": \\\"1015593705\\\",\\n  \\\"softDescriptor\\\": \\\"BLS&#x2a;DescTest\\\",\\n  \\\"amount\\\": 11,\\n  \\\"currency\\\": \\\"USD\\\",\\n  \\\"cardHolderInfo\\\": {\\n    \\\"firstName\\\": \\\"test first name\\\",\\n    \\\"lastName\\\": \\\"test last name\\\",\\n    \\\"zip\\\": \\\"123456\\\"\\n  },\\n  \\\"vaultedShopperId\\\": 22324271,\\n  \\\"creditCard\\\": {\\n    \\\"cardLastFourDigits\\\": \\\"9299\\\",\\n    \\\"cardType\\\": \\\"VISA\\\",\\n    \\\"cardSubType\\\": \\\"CREDIT\\\",\\n    \\\"cardCategory\\\": \\\"GOLD\\\"\\n  },\\n  \\\"processingInfo\\\": {\\n    \\\"processingStatus\\\": \\\"SUCCESS\\\",\\n    \\\"cvvResponseCode\\\": \\\"MA\\\",\\n    \\\"avsResponseCodeZip\\\": \\\"U\\\",\\n    \\\"avsResponseCodeAddress\\\": \\\"U\\\",\\n    \\\"avsResponseCodeName\\\": \\\"U\\\"\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"with vendors info\"\n    },\n    {\n      \"code\": \"{\\n  \\\"cardTransactionType\\\": \\\"CAPTURE\\\",\\n  \\\"transactionId\\\": \\\"1016133355\\\",\\n  \\\"softDescriptor\\\": \\\"BLS&#x2a;DescTest\\\",\\n  \\\"amount\\\": 75,\\n  \\\"openToCapture\\\": 25,\\n  \\\"currency\\\": \\\"USD\\\",\\n  \\\"cardHolderInfo\\\": {\\n    \\\"firstName\\\": \\\"test first name\\\",\\n    \\\"lastName\\\": \\\"test last name\\\",\\n    \\\"zip\\\": \\\"123456\\\"\\n  },\\n  \\\"vaultedShopperId\\\": 22483647,\\n  \\\"creditCard\\\": {\\n    \\\"cardLastFourDigits\\\": \\\"9299\\\",\\n    \\\"cardType\\\": \\\"VISA\\\",\\n    \\\"cardSubType\\\": \\\"CREDIT\\\",\\n    \\\"cardCategory\\\": \\\"GOLD\\\"\\n  },\\n  \\\"processingInfo\\\": {\\n    \\\"processingStatus\\\": \\\"SUCCESS\\\",\\n    \\\"cvvResponseCode\\\": \\\"MA\\\",\\n    \\\"avsResponseCodeZip\\\": \\\"U\\\",\\n    \\\"avsResponseCodeAddress\\\": \\\"U\\\",\\n    \\\"avsResponseCodeName\\\": \\\"U\\\"\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"with amount\"\n    },\n    {\n      \"code\": \"{\\n  \\\"cardTransactionType\\\": \\\"CAPTURE\\\",\\n  \\\"vendorInfo\\\": {\\n    \\\"vendorId\\\": 10398032,\\n    \\\"commissionPercent\\\": 90.2\\n  },\\n  \\\"vendorsInfo\\\": {\\n    \\\"vendorInfo\\\": [\\n      {\\n        \\\"vendorId\\\": 10398032,\\n        \\\"commissionPercent\\\": 90.2\\n      }\\n    ]\\n  },\\n  \\\"transactionId\\\": \\\"1016141063\\\",\\n  \\\"softDescriptor\\\": \\\"BLS&#x2a;DescTest\\\",\\n  \\\"amount\\\": 65,\\n  \\\"openToCapture\\\": 15,\\n  \\\"currency\\\": \\\"USD\\\",\\n  \\\"cardHolderInfo\\\": {\\n    \\\"firstName\\\": \\\"test first name\\\",\\n    \\\"lastName\\\": \\\"test last name\\\",\\n    \\\"zip\\\": \\\"123456\\\"\\n  },\\n  \\\"vaultedShopperId\\\": 22484023,\\n  \\\"creditCard\\\": {\\n    \\\"cardLastFourDigits\\\": \\\"9299\\\",\\n    \\\"cardType\\\": \\\"VISA\\\",\\n    \\\"cardSubType\\\": \\\"CREDIT\\\",\\n    \\\"cardCategory\\\": \\\"GOLD\\\"\\n  },\\n  \\\"processingInfo\\\": {\\n    \\\"processingStatus\\\": \\\"SUCCESS\\\",\\n    \\\"cvvResponseCode\\\": \\\"MA\\\",\\n    \\\"avsResponseCodeZip\\\": \\\"U\\\",\\n    \\\"avsResponseCodeAddress\\\": \\\"U\\\",\\n    \\\"avsResponseCodeName\\\": \\\"U\\\"\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"with amount and vendors info\"\n    }\n  ]\n}\n[/block]\n<hr>\n  \n##Example Descriptions\nFor details about the above examples, see:\n* [Basic Capture](#section-basic-capture)\n* [Capture with vendors info](#section-capture-with-vendors-info)\n* [Capture with amount](#section-capture-with-amount)\n* [Capture with amount and vendors info](#section-capture-with-amount-and-vendors-info)\n\n###Basic Capture\nThe example above shows a Capture request for the full authorization amount, where the transaction ID received for the initial [Auth Only](doc:auth-only) for this transaction was **1011671985**.\n\n###Capture with vendors info\nThis example shows a Capture request for the full authorization amount, with a marketplace vendor. By including `vendorsInfo` in the request, the vendor (or vendors) will be linked to the transaction at the capture step. For more information, visit the [Marketplace Guide](/docs/processing-transactions). \n\n###Capture with amount \nThis example shows a Capture request for a partial amount (i.e. a partial capture). The full authorization amount is $100, the captured amount is $75 (indicated by `amount` in the request), and the remaining authorization amount available for capture is $25 (indicated by `openToCapture` in the response). \n\n**Notes:** \n* To have partial captures enabled, contact your [Implementation Specialist](https://bluesnap.zendesk.com/hc/en-us/requests/new?ticket_form_id=360000248073) or [Merchant Support](https://bluesnap.zendesk.com/hc/en-us/requests/new?ticket_form_id=360000127087).\n*  Once a partial capture has been processed, the remaining authorization amount cannot be voided (reversed). \n\n###Capture with amount and vendors info\nThis example shows a partial capture with a marketplace vendor. The full authorization amount is $80, the captured amount is $65 (indicated by `amount` in the request), the vendor's commission rate for the capture is 90.2% (the vendor's default commission rate), and the remaining authorization amount available for capture is $15 (indicated by `openToCapture` in the response).\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 the request content below and then click **Try it!**\n\n**Tip**: Use the JSON code below as a starting point. You can enter different parameters to see how your test scenario would work. *The request headers, including authorization, are already built in for you in this test area, so you should not include them here.*\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"cardTransactionType\\\": \\\"CAPTURE\\\",\\n    \\\"transactionId\\\": 1011671985\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"capture","type":"endpoint","title":"Capture"}