Difference between revisions of "CreatePurchase"
Jump to navigation
Jump to search
| Line 14: | Line 14: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=Product Id of the subscription to be purchased |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 20: | Line 20: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=This use case deals with subscriptions. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 26: | Line 26: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=Pricing Model Id |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 38: | Line 38: | ||
|ParamType=String | |ParamType=String | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=User purchase PIN |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 44: | Line 44: | ||
|ParamType=String | |ParamType=String | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=This parameter makes sense only with paypal an ewallet payment methods. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 50: | Line 50: | ||
|ParamType=String | |ParamType=String | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=This parameter makes sense only with paypal an ewallet payment methods. |
}} | }} | ||
Revision as of 19:51, 18 September 2014
Description
Create a purchase for product
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- productId (int, required)
- Product Id of the subscription to be purchased
- productType (int, required)
- This use case deals with subscriptions.
- pricingModelId (int, required)
- Pricing Model Id
- paymentType (PaymentType, required)
- pin (String, required)
- User purchase PIN
- returnURL (String, required)
- This parameter makes sense only with paypal an ewallet payment methods.
- cancelURL (String, required)
- This parameter makes sense only with paypal an ewallet payment methods.
Returns
Returns a JSON with a PurchaseResponse object containing information that Purchase has been created with success.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 6,
- "Content":
- [ PurchaseResponse object ]
}
Exceptions
Caching
This method is not cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
