This method is used to get the model necessary to display the selected package and to collect the necessary information to purchase the package. It includes information about the payment gateway, tokenised credit card information and more detailed package information.
Success Response Content
Example JSON:
{ "validationErrors": [], "result": { "purchasePackageModelBean": { "specReferenceNumber": "P-0000055", "displayName": "Super Freshness", "tagLine": "Vivamus eget enim at ante imperdiet iaculis. Nunc ullamcorper egestas porta.", "summary": "Praesent a arcu tincidunt odio convallis facilisis vel ac lectus", "largeImage": { "width": 480, "height": 270, "url": "http://localhost:64050/public/3ad14ff7-c042-4d5c-a9fb-1bc2e50f57d9" }, "smallImage": { "width": 480, "height": 270, "url": "http://localhost:64050/public/3ad14ff7-c042-4d5c-a9fb-1bc2e50f57d9" }, "category": { "key": "91", "name": "spiffy", "reference": "spiffy" }, "promoted": false, "purchaseLimit": -1, "purchaseCount": 3, "subscriptionPeriod": "MONTHLY", "pricingModelBean": { "packageType": "RECURRING_WITH_ONE_OFF", "chargeType": "PAY_LATER", "minimumSetUpCost": "$ 5.20", "minimumSetUpCostDetails": { "currencyCode": "AUD", "currencySymbol": "$", "amount": "5.20" }, "minimumRecurringCost": "$ 2.50", "minimumRecurringCostDetails": { "currencyCode": "AUD", "currencySymbol": "$", "amount": "2.50" } }, "lastUpdateTime": "2010-08-22T11:29:25.000", "description": "<p>Phasellus mauris turpis.</p>", "termsAndConditions": "You must be neat", "nextSteps": "Next!", "products": [ { "referenceNumber": "C-000000036", "propertyRequired": false, "displayName": "Mints", "productCode": "SKU-ECLIPSE", "productPricingModelBean": { "setupCost": "$ 0.00", "setupCostDetails": { "currencyCode": "AUD", "currencySymbol": "$", "amount": "0.00" }, "recurringCost": "$ 0.00", "recurringCostDetails": { "currencyCode": "AUD", "currencySymbol": "$", "amount": "0.00" }, "optional": false }, "variations": [ { "reference": "19", "key": "flavour", "name": "Choose your flavour", "description": "Choose you a flava", "options": [ { "reference": "69", "key": "blue", "name": "Peppermint", "defaultSelected": true, "recurringCost": "$ 0.00", "recurringCostDetails": { "currencyCode": "AUD", "currencySymbol": "$", "amount": "0.00" }, "setupCost": "$ 0.00", "setupCostDetails": { "currencyCode": "AUD", "currencySymbol": "$", "amount": "0.00" } } ] } ] }, { "referenceNumber": "C-000000037", "propertyRequired": false, "displayName": "Listerine", "productCode": "SKU-MTHWASH", "productPricingModelBean": { "setupCost": "$ 0.00", "setupCostDetails": { "currencyCode": "AUD", "currencySymbol": "$", "amount": "0.00" }, "recurringCost": "$ 0.00", "recurringCostDetails": { "currencyCode": "AUD", "currencySymbol": "$", "amount": "0.00" }, "optional": false }, "variations": [ { "reference": "20", "key": "size", "name": "Choose your size", "options": [ { "reference": "72", "key": "small", "name": "250ml", "defaultSelected": true, "recurringCost": "$ 0.00", "recurringCostDetails": { "currencyCode": "AUD", "currencySymbol": "$", "amount": "0.00" }, "setupCost": "$ 0.00", "setupCostDetails": { "currencyCode": "AUD", "currencySymbol": "$", "amount": "0.00" } } ] } ], "metaFields": [ { "reference": "12", "displayName": "How many teeth do you have?", "helpText": "Help us count your teeth!", "key": "teeth", "mandatory": false, "type": "FREE_TEXT", "otherAllowedInList": false } ] } ], "properties": [ { "name": "742 Evergreen Tce Springfield", "reference": "PP-00000001" }, { "name": "742 Evergreen Tce Springfield", "reference": "PP-00000001" } ], "paymentGateWayBean": { "paymentGatewayProviderType": "INNOVATE", "paymentGatewayType": "LOCALLY_COLLECTED", "testMode": true, "tokenisationSupported": true }, "tokenisedCreditCardBean": { "name": "Bob Simpson", "cardNumber": "............1111", "expiryMonth": "11", "expiryYear": "20" }, "billingAddress": { "line1": "c\\o Planet Express Delivery Company\nWest 57th Street & Henry Hudson Parkway", "city": "Manhattan", "state": "New New York", "postcode": "90210", "country": "US" }, "phone": "212-555-1234", "canPurchase": "ALLOWED", "accountCredit": { "currencyCode": "AUD", "currencySymbol": "$", "amount": "0.00" }, "howToPayInstructions": "Please contact Test Seeder on 1900 MIX A LOT for payment information.", "payNow": true } }}Fields Description