Process Cart

post

https://rest.cleverbridge.com/cart/processcart

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 (LogonPurchaseId), your own client account identifier (CustomerReferenceId), or a subscription ID (SubscriptionId).
For more information, see Process Cart. For XML examples and schemas, see the Additional Examples - Process Cart.

Body Params

Cart

object

required

The order to be processed.

ExtraParameterMode

string

enum

Defaults to 0

If the order contains a subscription product, you can control how the x-parameters defined in Cart.ExtraParameters are used. If set to PurchaseOnly, the x-parameters are only added to the initial purchase of the subscription. If set to SubscriptionOnly, the x-parameters are only added to subsequent billing events. If set to Default, 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:
0 - Default
1 - PurchaseOnly
2 - SubscriptionOnly
For more information, see Process Cart > Important Parameters.

Allowed:

FraudProtectionMode

string

enum

Defaults to 1

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:
0 - Disabled
1 - Enabled

Allowed:

ProcessCartMode

string

enum

Defaults to 0

How the order is processed. With interactive 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:
0 - interactive
1 - noninteractive
For more information, see Process Cart > Important Parameters.

Allowed:

Subscription

object

Use only if the order contains a subscription product and if you handle subscriptions yourself. Assigns the purchase to an existing subscription. The SubscriptionId can be used to identify the customer and auto-process the order.

Headers

string

enum

Defaults to application/json

Expected response format.

Allowed:

Content-Type

string

enum

Defaults to application/json

Format of the HTTP post body.

Allowed:

Responses

200OK

400Bad Request

500Internal Server Error