TASK 8: HOW TO CANCEL A BUYSAFE BOND
The SetShoppingCartCancelOrder call is issued by the merchant’s order management system when a Bond needs to be canceled. This API tells buySAFE to cancel the buySAFE Bond and inform the buyer that the bond has been revoked.
There are two different scenarios when the SetShoppingCartCancelOrder call will need to be executed:
- When the entire order is canceled. In this scenario, the customer will be refunded the Bond Cost as part of the refund for the entire order.
- When the bond is canceled, but not the entire order. In this scenario, the merchant will need to refund the customer for the cost of the bond.
We allow customers to cancel the buySAFE Bond for any reason within 72 hours of their order being placed.
In all situations, if a bond is canceled, the customer must be refunded for their bond cost. If a third-party payment method was used, you may need to issue the refund through that third-party payment method. See TASK 9 for more information about payment methods.
STEP 1: CONSTRUCT SETSHOPPINGCARTCANCELORDER CALL
Here is an example:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<BuySafeWSHeader xmlns="http://ws.buysafe.com">
<Version>VERSION</Version>
</BuySafeWSHeader>
<MerchantServiceProviderCredentials xmlns="http://ws.buysafe.com">
<UserName>USERNAME</UserName>
<Password>PASSWORD</Password>
</MerchantServiceProviderCredentials>
<BuySafeUserCredentials xmlns="http://ws.buysafe.com">
<AuthenticationTokens>
<string>STORE_TOKEN</string>
</AuthenticationTokens>
</BuySafeUserCredentials>
</soap:Header>
<soap:Body>
<SetShoppingCartCancelOrder xmlns="http://ws.buysafe.com">
<SetShoppingCartCancelOrderRQ>
<ShoppingCartId>ShoppingCartId</ShoppingCartId>
</SetShoppingCartCancelOrderRQ>
</SetShoppingCartCancelOrder>
</soap:Body>
</soap:Envelope>
ShoppingCartId is the only required field for the SetShoppingCartCancelOrder call.
If necessary, orders can be canceled by Order Number instead of ShoppingCartId. Once this has been enabled for your account, simply send the Order Number prefixed by "PON::" in the ShoppingCartId field. Please contact your buySAFE Integration Manager if you'd like to enable this setting.
You need to POST your SetShoppingCartCancelOrder request to: https://sbws.buysafe.com/BuysafeWS/CheckoutAPI.dll. This will change when we move to production (TASK 11).
The SOAPAction is: http://ws.buysafe.com/SetShoppingCartCancelOrder
The XMLNS is: http://ws.buysafe.com
When the entire order is canceled
When a Bonded order is canceled, the merchant's order management system should automatically send a SetShoppingCartCancelOrder call.
When only the buySAFE Bond is canceled
In order to cancel Bonds, but not entire orders, a CANCEL BOND button is typically built into the merchant's order management system. This Button is used to manually send SetShoppingCartCancelOrder calls.
Other options
If necessary, buySAFE can arrange other methods of Bond cancellation. This is sometimes necessary if the merchant's order management system is not able to be modified. Cancel Bond requests can, for example, be sent by email. Talk to your buySAFE Integration Manager for more details.
SetShoppingCartCancelOrder response
The body of the SetShoppingCartCancelOrder response will be empty. The empty response is simply a verification that the request was received.
|
NOTES FOR SHOPPING CART PLATFORMS: If merchants on your platform use a separate order management system, please contact your buySAFE Integration Manager to discuss options for handling Bond cancellations. |
<< PREVIOUS TASK || TOC || NEXT TASK >>