{"_id":"5c6c2407b8d4b2000e72d9d4","category":{"_id":"5c6c2407b8d4b2000e72d982","version":"5c6c2407b8d4b2000e72da25","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","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","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":0,"updates":[],"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":"","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`card-transaction` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, contains the following properties (see [card-transaction](doc:card-transaction)):\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`card-transaction-type` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, value must be **CAPTURE**\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transaction-id` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, value must be the transaction ID from [Auth Only](doc:auth-only) response\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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`soft-descriptor` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transaction-meta-data` *container* &nbsp;&nbsp;&nbsp;optional (see [transaction-meta-data](doc:transaction-meta-data))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendors-info` *container*&nbsp;&nbsp;&nbsp;optional&nbsp;&nbsp;&nbsp; applicable if using marketplace vendor(s) (see [vendors-info](doc:vendors-info))\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK and contains the [**card-transaction**](doc:card-transaction) container. The `transaction-id` in the response will match the `transaction-id`for the initial [Auth Only](doc:auth-only).\n\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/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>CAPTURE</card-transaction-type>\\n   <transaction-id>1011671985</transaction-id>\\n</card-transaction>'\",\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/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>CAPTURE</card-transaction-type>\\n   <transaction-id>1015600997</transaction-id>\\n   <vendors-info>\\n     <vendor-info>\\n       <vendor-id>10398032</vendor-id>\\n     </vendor-info>\\n   </vendors-info>\\n</card-transaction>'\",\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/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <card-transaction-type>CAPTURE</card-transaction-type>\\n  <transaction-id>1016164955</transaction-id>\\n  <amount>75</amount>\\n</card-transaction>'\",\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/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <card-transaction-type>CAPTURE</card-transaction-type>\\n  <transaction-id>1016165339</transaction-id>\\n  <amount>65</amount>\\n  <vendors-info>\\n    <vendor-info>\\n      <vendor-id>10398032</vendor-id>\\n    </vendor-info>\\n  </vendors-info>\\n</card-transaction>'\",\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\": \"HTTP/ 1.1 200 OK\\n\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>CAPTURE</card-transaction-type>\\n   <transaction-id>1011671985</transaction-id>\\n   <soft-descriptor>BLS*DescTest</soft-descriptor>\\n   <amount>11.00</amount>\\n   <currency>USD</currency>\\n   <vaulted-shopper-id>1234</vaulted-shopper-id>\\n   <card-holder-info>\\n      <first-name>test first name</first-name>\\n      <last-name>test last name</last-name>\\n      <zip>123456</zip>\\n   </card-holder-info>\\n   <credit-card>\\n      <card-last-four-digits>0026</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   </credit-card>\\n   <processing-info>\\n      <processing-status>SUCCESS</processing-status>\\n   </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - Basic\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <card-transaction-type>CAPTURE</card-transaction-type>\\n  <vendor-info>\\n    <vendor-id>10398032</vendor-id>\\n    <commission-percent>20</commission-percent>\\n  </vendor-info>\\n  <vendors-info>\\n    <vendor-info>\\n      <vendor-id>10398032</vendor-id>\\n      <commission-percent>20</commission-percent>\\n    </vendor-info>\\n  </vendors-info>\\n  <transaction-id>1015600997</transaction-id>\\n  <soft-descriptor>BLS&#x2a;DescTest</soft-descriptor>\\n  <amount>11.00</amount>\\n  <currency>USD</currency>\\n  <card-holder-info>\\n    <first-name>Jane</first-name>\\n    <last-name>Shopper</last-name>\\n    <zip>123456</zip>\\n  </card-holder-info>\\n  <vaulted-shopper-id>22327435</vaulted-shopper-id>\\n  <credit-card>\\n    <card-last-four-digits>9299</card-last-four-digits>\\n    <card-type>VISA</card-type>\\n    <card-sub-type>CREDIT</card-sub-type>\\n    <card-category>GOLD</card-category>\\n  </credit-card>\\n  <processing-info>\\n    <processing-status>SUCCESS</processing-status>\\n    <cvv-response-code>MA</cvv-response-code>\\n    <avs-response-code-zip>U</avs-response-code-zip>\\n    <avs-response-code-address>U</avs-response-code-address>\\n    <avs-response-code-name>U</avs-response-code-name>\\n  </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"with vendors info\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <card-transaction-type>CAPTURE</card-transaction-type>\\n  <transaction-id>1016164955</transaction-id>\\n  <soft-descriptor>BLS&#x2a;DescTest</soft-descriptor>\\n  <amount>75</amount>\\n  <open-to-capture>25.00</open-to-capture>\\n  <currency>USD</currency>\\n  <card-holder-info>\\n    <first-name>test first name</first-name>\\n    <last-name>test last name</last-name>\\n    <zip>123456</zip>\\n  </card-holder-info>\\n  <vaulted-shopper-id>22488315</vaulted-shopper-id>\\n  <credit-card>\\n    <card-last-four-digits>9299</card-last-four-digits>\\n    <card-type>VISA</card-type>\\n    <card-sub-type>CREDIT</card-sub-type>\\n    <card-category>GOLD</card-category>\\n  </credit-card>\\n  <processing-info>\\n    <processing-status>SUCCESS</processing-status>\\n    <cvv-response-code>MA</cvv-response-code>\\n    <avs-response-code-zip>U</avs-response-code-zip>\\n    <avs-response-code-address>U</avs-response-code-address>\\n    <avs-response-code-name>U</avs-response-code-name>\\n  </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\n      \"name\": \"with amount\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n  <card-transaction-type>CAPTURE</card-transaction-type>\\n  <vendor-info>\\n    <vendor-id>10398032</vendor-id>\\n    <commission-percent>90.2</commission-percent>\\n  </vendor-info>\\n  <vendors-info>\\n    <vendor-info>\\n      <vendor-id>10398032</vendor-id>\\n      <commission-percent>90.2</commission-percent>\\n    </vendor-info>\\n  </vendors-info>\\n  <transaction-id>1016165339</transaction-id>\\n  <soft-descriptor>BLS&#x2a;DescTest</soft-descriptor>\\n  <amount>65</amount>\\n  <open-to-capture>15.00</open-to-capture>\\n  <currency>USD</currency>\\n  <card-holder-info>\\n    <first-name>test first name</first-name>\\n    <last-name>test last name</last-name>\\n    <zip>123456</zip>\\n  </card-holder-info>\\n  <vaulted-shopper-id>22488357</vaulted-shopper-id>\\n  <credit-card>\\n    <card-last-four-digits>9299</card-last-four-digits>\\n    <card-type>VISA</card-type>\\n    <card-sub-type>CREDIT</card-sub-type>\\n    <card-category>GOLD</card-category>\\n  </credit-card>\\n  <processing-info>\\n    <processing-status>SUCCESS</processing-status>\\n    <cvv-response-code>MA</cvv-response-code>\\n    <avs-response-code-zip>U</avs-response-code-zip>\\n    <avs-response-code-address>U</avs-response-code-address>\\n    <avs-response-code-name>U</avs-response-code-name>\\n  </processing-info>\\n</card-transaction>\",\n      \"language\": \"xml\",\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 `vendors-info` 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 `open-to-capture` 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 `open-to-capture` 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 XML portion of the request below and then click **Try it!**\n\n**Tip:** Use the XML 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\": \"<card-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n   <card-transaction-type>CAPTURE</card-transaction-type>\\n   <transaction-id>1011671985</transaction-id>\\n</card-transaction>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"capture","type":"endpoint","title":"Capture"}