Sign in

v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB
Cart API

Process Cart

Processes an order automatically. The customer does not need to use a browser, interact with Cleverbridge, or enter new payment information. Instead, Cleverbridge uses the customer's most recent payment details to process the order. If the order cannot be processed automatically, the API returns a unique URL that can be sent to the customer in order to complete their transaction on the Cleverbridge-hosted page. To process an order, you have to submit a customer identifier and the cart item(s). The customer identifier can be a former purchase ID of an existing customer with Cleverbridge (<code>LogonPurchaseId</code>), your own client account identifier (<code>CustomerReferenceId</code>), or a subscription ID (<code>SubscriptionId</code>).<br />For more information, see Process Cart. For XML examples and schemas, see the Additional Examples - Process Cart.

post/cart/processcart

Headers

Accept'application/json' | 'application/xml'

Expected response format.

Content-Type'application/json' | 'application/xml'

Format of the HTTP post body.

Request body

ExtraParameterMode'Default' | 'PurchaseOnly' | 'SubscriptionOnly'

If the order contains a subscription product, you can control how the x-parameters defined in <code>Cart.ExtraParameters</code> are used. If set to <code>PurchaseOnly</code>, the x-parameters are only added to the initial purchase of the subscription. If set to <code>SubscriptionOnly</code>, the x-parameters are only added to subsequent billing events. If set to <code>Default</code>, the x-parameters are added to both the initial purchase of the subscription and subsequent billing events. For a JSON request, the data type is integer. Use the following integers: <br />0 - Default<br />1 - PurchaseOnly<br />2 - SubscriptionOnly<br />For more information, see Process Cart > Important Parameters.

FraudProtectionMode'Disabled' | 'Enabled'

Enable or disable fraud protection. Fraud protection ensures that suspicious orders are inspected by the Cleverbridge anti-fraud team. Warning: Only deactivate fraud protection if it is important that none of the orders are delayed due to inspection. For a JSON request, the data type is integer. Use the following integers: <br />0 - Disabled<br />1 - Enabled

ProcessCartMode'Interactive' | 'NonInteractive'

How the order is processed. With <code>interactive</code> you can interact directly with the customer if any information is outdated or invalid. This method returns a session URL. For a JSON request, the data type is integer. Use the following integers: <br />0 - interactive<br />1 - noninteractive<br />For more information, see Process Cart > Important Parameters.

Response

OK

ContinueUrlstring

URL of web page with transaction details or payment instructions.

IsPaymentRetryScheduledboolean

Indicates whether a payment retry has been scheduled for a subscription because of a failed credit card payment. If you use this field to manage your own subscriptions, see Process Cart > Important Parameters for important information about our retry logic. For general information about our retry logic, see Using IsPaymentRetryScheduled for Subscription Management.

ProcessResult'Paid' | 'WaitingForOfflinePayment' | 'TestOrder' | 'Pending' | 'Failed' | 'CustomerActionNeeded' | 'ContactMissing' | 'SubscriptionNotFound'

The result. For a JSON response, the data type is integer. Possible values are:<br />0 - Paid<br />1 - WaitingForOfflinePayment<br />2 - TestOrder<br />3 - Pending<br />4 - Failed<br />5 - CustomerActionNeeded<br />6 - ContactMissing<br />7 - SubscriptionNotFound

PurchaseIdinteger

Unique ID of the purchase that was created.

ResultMessagestring

Optional result or error message.