{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/transactions","auth":"optional","examples":{"codes":[]},"method":"put","results":{"codes":[{"code":"","language":"text"}]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Capture","type":"endpoint","slug":"capture","excerpt":"","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* <span style=\"color:#F37500\">**required**</span>, contains the following properties (see [card-transaction](doc:card-transaction)):\n `card-transaction-type` *string* <span style=\"color:#F37500\">**required**</span>, value must be **CAPTURE**\n `transaction-id` *string* <span style=\"color:#F37500\">**required**</span>, value must be the transaction ID from [Auth Only](doc:auth-only) response\n `amount` *decimal* optional default value is the full authorization amount\n `soft-descriptor` *string* optional\n `transaction-meta-data` *container* optional (see [transaction-meta-data](doc:transaction-meta-data))\n `vendors-info` *container* optional applicable if using marketplace vendor(s) (see [vendors-info](doc:vendors-info))\n `level-3-data` *container* optional (see [level-3-data](doc:level-3-data)) \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 <usd-amount>11.00</usd-amount>\\n <currency>USD</currency>\\n <transaction-approval-date>10/01/2020</transaction-approval-date>\\n <transaction-approval-time>10:19:21</transaction-approval-time>\\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>02453</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*DescTest</soft-descriptor>\\n <amount>11.00</amount>\\n <usd-amount>11.00</usd-amount>\\n <currency>USD</currency>\\n <transaction-approval-date>10/01/2020</transaction-approval-date>\\n <transaction-approval-time>10:19:21</transaction-approval-time>\\n <card-holder-info>\\n <first-name>Jane</first-name>\\n <last-name>Shopper</last-name>\\n <zip>02453</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*DescTest</soft-descriptor>\\n <amount>75</amount>\\n <usd-amount>75</usd-amount>\\n <currency>USD</currency>\\n <transaction-approval-date>10/01/2020</transaction-approval-date>\\n <transaction-approval-time>10:19:21</transaction-approval-time>\\n <open-to-capture>25.00</open-to-capture>\\n <card-holder-info>\\n <first-name>test first name</first-name>\\n <last-name>test last name</last-name>\\n <zip>02453</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*DescTest</soft-descriptor>\\n <amount>65</amount>\\n <usd-amount>65</usd-amount>\\n <currency>USD</currency>\\n <transaction-approval-date>10/01/2020</transaction-approval-date>\\n <transaction-approval-time>10:19:21</transaction-approval-time>\\n <open-to-capture>15.00</open-to-capture>\\n <card-holder-info>\\n <first-name>test first name</first-name>\\n <last-name>test last name</last-name>\\n <zip>02453</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]","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"61a5208deadb750070998ed7","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Card/Wallet Transactions","slug":"payment-transaction-service","order":1,"from_sync":false,"reference":true,"_id":"61a5208deadb750070998e88","version":"61a5208deadb750070998f48","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T15:28:41.796Z","__v":0},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61a5208deadb750070998e87","61a5208deadb750070998e88","61a5208deadb750070998e89","61a5208deadb750070998e8a","61a5208deadb750070998e8b","61a5208deadb750070998e8c","61a5208deadb750070998e8d","61a5208deadb750070998e8e","61a5208deadb750070998e8f","61a5208deadb750070998e90","61a5208deadb750070998e91","61a5208deadb750070998e92","61a5208deadb750070998e93","61a5208deadb750070998e94","61a5208deadb750070998e95","61a5208deadb750070998e96","61a5208deadb750070998e97","61a5208deadb750070998e98","61a5208deadb750070998e99","61a5208deadb750070998e9a"],"_id":"61a5208deadb750070998f48","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"60fed269718a45001c25b4a0","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2015-10-21T17:17:37.750Z","githubsync":"","__v":0}putCapture
Definition
{{ api_url }}{{ page_api_url }}
Documentation
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).
Auth Only required before Capture
Before you can send a transaction for capture, you must send it for authorization using the Auth Only request.
The capture will be performed based on the details that were in the Auth Only request (currency, credit card, etc.).
Request Content
card-transaction container required, contains the following properties (see card-transaction):
card-transaction-type string required, value must be CAPTURE
transaction-id string required, value must be the transaction ID from Auth Only response
amount decimal optional default value is the full authorization amount
soft-descriptor string optional
transaction-meta-data container optional (see transaction-meta-data)
vendors-info container optional applicable if using marketplace vendor(s) (see vendors-info)
level-3-data container optional (see level-3-data)
Response Details
If successful, the response HTTP status code is 200 OK and contains the card-transaction container. The transaction-id in the response will match the transaction-idfor the initial Auth Only.
Examples
Request Examples
curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>CAPTURE</card-transaction-type>
<transaction-id>1011671985</transaction-id>
</card-transaction>'curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>CAPTURE</card-transaction-type>
<transaction-id>1015600997</transaction-id>
<vendors-info>
<vendor-info>
<vendor-id>10398032</vendor-id>
</vendor-info>
</vendors-info>
</card-transaction>'curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>CAPTURE</card-transaction-type>
<transaction-id>1016164955</transaction-id>
<amount>75</amount>
</card-transaction>'curl -v -X PUT https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>CAPTURE</card-transaction-type>
<transaction-id>1016165339</transaction-id>
<amount>65</amount>
<vendors-info>
<vendor-info>
<vendor-id>10398032</vendor-id>
</vendor-info>
</vendors-info>
</card-transaction>'HTTP/ 1.1 200 OK
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>CAPTURE</card-transaction-type>
<transaction-id>1011671985</transaction-id>
<soft-descriptor>BLS*DescTest</soft-descriptor>
<amount>11.00</amount>
<usd-amount>11.00</usd-amount>
<currency>USD</currency>
<transaction-approval-date>10/01/2020</transaction-approval-date>
<transaction-approval-time>10:19:21</transaction-approval-time>
<vaulted-shopper-id>1234</vaulted-shopper-id>
<card-holder-info>
<first-name>test first name</first-name>
<last-name>test last name</last-name>
<zip>02453</zip>
</card-holder-info>
<credit-card>
<card-last-four-digits>0026</card-last-four-digits>
<card-type>VISA</card-type>
<card-sub-type>CREDIT</card-sub-type>
<card-category>CLASSIC</card-category>
</credit-card>
<processing-info>
<processing-status>SUCCESS</processing-status>
</processing-info>
</card-transaction>
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>CAPTURE</card-transaction-type>
<vendor-info>
<vendor-id>10398032</vendor-id>
<commission-percent>20</commission-percent>
</vendor-info>
<vendors-info>
<vendor-info>
<vendor-id>10398032</vendor-id>
<commission-percent>20</commission-percent>
</vendor-info>
</vendors-info>
<transaction-id>1015600997</transaction-id>
<soft-descriptor>BLS*DescTest</soft-descriptor>
<amount>11.00</amount>
<usd-amount>11.00</usd-amount>
<currency>USD</currency>
<transaction-approval-date>10/01/2020</transaction-approval-date>
<transaction-approval-time>10:19:21</transaction-approval-time>
<card-holder-info>
<first-name>Jane</first-name>
<last-name>Shopper</last-name>
<zip>02453</zip>
</card-holder-info>
<vaulted-shopper-id>22327435</vaulted-shopper-id>
<credit-card>
<card-last-four-digits>9299</card-last-four-digits>
<card-type>VISA</card-type>
<card-sub-type>CREDIT</card-sub-type>
<card-category>GOLD</card-category>
</credit-card>
<processing-info>
<processing-status>SUCCESS</processing-status>
<cvv-response-code>MA</cvv-response-code>
<avs-response-code-zip>U</avs-response-code-zip>
<avs-response-code-address>U</avs-response-code-address>
<avs-response-code-name>U</avs-response-code-name>
</processing-info>
</card-transaction>
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>CAPTURE</card-transaction-type>
<transaction-id>1016164955</transaction-id>
<soft-descriptor>BLS*DescTest</soft-descriptor>
<amount>75</amount>
<usd-amount>75</usd-amount>
<currency>USD</currency>
<transaction-approval-date>10/01/2020</transaction-approval-date>
<transaction-approval-time>10:19:21</transaction-approval-time>
<open-to-capture>25.00</open-to-capture>
<card-holder-info>
<first-name>test first name</first-name>
<last-name>test last name</last-name>
<zip>02453</zip>
</card-holder-info>
<vaulted-shopper-id>22488315</vaulted-shopper-id>
<credit-card>
<card-last-four-digits>9299</card-last-four-digits>
<card-type>VISA</card-type>
<card-sub-type>CREDIT</card-sub-type>
<card-category>GOLD</card-category>
</credit-card>
<processing-info>
<processing-status>SUCCESS</processing-status>
<cvv-response-code>MA</cvv-response-code>
<avs-response-code-zip>U</avs-response-code-zip>
<avs-response-code-address>U</avs-response-code-address>
<avs-response-code-name>U</avs-response-code-name>
</processing-info>
</card-transaction>
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>CAPTURE</card-transaction-type>
<vendor-info>
<vendor-id>10398032</vendor-id>
<commission-percent>90.2</commission-percent>
</vendor-info>
<vendors-info>
<vendor-info>
<vendor-id>10398032</vendor-id>
<commission-percent>90.2</commission-percent>
</vendor-info>
</vendors-info>
<transaction-id>1016165339</transaction-id>
<soft-descriptor>BLS*DescTest</soft-descriptor>
<amount>65</amount>
<usd-amount>65</usd-amount>
<currency>USD</currency>
<transaction-approval-date>10/01/2020</transaction-approval-date>
<transaction-approval-time>10:19:21</transaction-approval-time>
<open-to-capture>15.00</open-to-capture>
<card-holder-info>
<first-name>test first name</first-name>
<last-name>test last name</last-name>
<zip>02453</zip>
</card-holder-info>
<vaulted-shopper-id>22488357</vaulted-shopper-id>
<credit-card>
<card-last-four-digits>9299</card-last-four-digits>
<card-type>VISA</card-type>
<card-sub-type>CREDIT</card-sub-type>
<card-category>GOLD</card-category>
</credit-card>
<processing-info>
<processing-status>SUCCESS</processing-status>
<cvv-response-code>MA</cvv-response-code>
<avs-response-code-zip>U</avs-response-code-zip>
<avs-response-code-address>U</avs-response-code-address>
<avs-response-code-name>U</avs-response-code-name>
</processing-info>
</card-transaction>Example Descriptions
For details about the above examples, see:
Basic Capture
The example above shows a Capture request for the full authorization amount, where the transaction ID received for the initial Auth Only for this transaction was 1011671985.
Capture with vendors info
This 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.
Capture with amount
This 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).
Notes:
- To have partial captures enabled, contact your Implementation Specialist or Merchant Support.
- Once a partial capture has been processed, the remaining authorization amount cannot be voided (reversed).
Capture with amount and vendors info
This 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).
API Explorer
To test out a call, enter the XML portion of the request below and then click Try it!
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.
<card-transaction xmlns="http://ws.plimus.com">
<card-transaction-type>CAPTURE</card-transaction-type>
<transaction-id>1011671985</transaction-id>
</card-transaction>
