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.).
Important
The API Explorer Try It! feature does not currently send XML requests to our sandbox environment.
For request and response examples, refer to the Examples section.
Request Content
card-transaction
container required, contains the following properties (see card-transaction):
Property | Type | Required |
---|---|---|
amount | decimal | optional. Default value is the full authorization amount |
card-transaction-type | string | required, value must be CAPTURE |
level-3-data | container | optional (see level-3-data) |
product-description | string | optional |
soft-descriptor | string | optional |
tax-reference | string | optional |
transaction-id | string | required, value must be the transaction ID from Auth Only response |
transaction-meta-data | container | optional (see transaction-meta-data) |
vendors-info | container | optional, applicable if using marketplace vendor(s) (see vendors-info) |
Note
Non-reusable cards cannot be used as a payment method.
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-id
for 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>'
Response Examples
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>
<transaction-region>US</transaction-region>
</processing-info>
</card-transaction>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<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>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<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>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<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>
Partial Capture
- 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).
- Apple Pay only supports single partial capture.
API Explorer
To test out a call, click Try it!