Create a URL for a checkout page to accept payments.
This URL can be seamlessly integrated into your payment flow, embedded into your payment page, or used to direct customers to a hosted payment page. The link will be deactivated once the customer opens the checkout page.
The required arguments for this endpoint are checkout line items. Optionally, you can provide a return URL to redirect the customer to a specific webpage after the payment is completed.
| Name | Description |
|---|---|
| CheckoutSubscription | Information for creating a checkout subscription |
| BillingFrequencyType | How often the subscription should be attempted for billing |
| SubscriptionBillingPlans | The subscription's individual billing items |
| BillingPlanName | The subscription's primary payment information |
| BillingPlanValue | Value for which the billing plan should be executed for |
| Name | Description | Default value |
|---|---|---|
| CustomerId | Customer's unique identifier | null |
| MerchantCustomerRefId | Merchant's identifier for the customer | null |
| MerchantSubscriptionRefId | Merchant's unique identifier for the subscription | null |
| SubscriptionCancelType | The circumstances under which a subscription must be cancelled (e.g. Immediate or EndOfCycle) | |
| TrialDuration | The amount of trial duration time in the unit of TrialDurationType | 0 |
| TrialDurationType | The type of trial duration | Daily |
| BillingPlanCycleCount | The number of times the billing plan should be billed before expiration | -1 |
| BillingPlanValueType | A qualifier for how the value should be interpreted (e.g. standard, discount, discountPercentage, finalDiscount, or priceOverride) | Standard |
| BillingPlanStartCycleDelay | Amount of subscription cycle to delay the start date of the billing plan | 0 |
Description of request parameters
- returnUrl
-
Optional
If you want the last screen with payment results to have a "Go Back To Site" button leading to your site, you need to specify the URL here.
Validation rules:
- The URL must be encoded once. For example: `https://mysite.com` - in request shoulb be `https%3A%2F%2Fmysite.com`.
- The hostname in this URL must have been added to the allowed checkout hosts in the Revolv3 Portal.
- oneTimePayment
-
Required
Data for a checkout with one-time payment.
No validation rules - checkoutLineItems
-
Required
Individual elements of one-time payment billing.
Validation rules:- Must contain at least one plan with standard type.
- Should contain no more than 1 plan with price override type.
- The total amount, considering the types of billing plans, must not be less than zero.
- name
-
Required
Name of the line item.
Validation rules:- Maximum length 100 characters.
- description
-
Optional
Item description.
Validation rules:- Maximum length 200 characters.
- value
-
Required
The value of line item.
Validation rules:- Must be greater than or equal to 0.
- In case the valueType is DiscountPercentage, the length must be between 0 and 100 characters.
- valueType
-
Optional. Default value: Standard.
A qualifier for how the value should be interpreted.
Validation rules:- Possible values: Standard, Discount, DiscountPercentage, FinalDiscount, PriceOverride.