Ecommerce Page Setup (V2)

Ecommerce Page Setup records contain the configuration for how the Ecommerce links should behave, and which actions are available to the customer clicking on the link. API request for V2 records only.

Method Purpose
GET (Singular) Return Ecommerce Page Setup details

GET (Singular)

Action: Return Ecommerce Page Setup details.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/ecommercepagesetup/{ID}

{ID} denotes ID of record.

Response Parameters

Property Description
id Unique identifier for the record.
name Meaningful name given to the record.
url
collection_period
collection_day
payment_types
collection_stretch
description
on_page_description
single_use
expiry
payment_type_step
customer_step
bank_step
card_step
schedule_step
branding
client_bank_account
account_validation_required
encryption_key

Response Sample

{
    "ecommerce_setup": {
        "id": "EP02KMD1LRPM0KJYEQG4",
        "name": "Mike - DD - Mandate - Generic",
        "url": "https://smarterpay-ecommerce-url.com?setup=KsR28AZ5p45irEeQoUdeenz9ZDfQpieFfeCZx6XhKPNRfpgRQnJU%2Bf5jQdbMh7RGwMhcKHIYnYjs%2FpyqqMZ9thCn1LtqVM8UzFFJAC9Y6Eo66%2FkBd%2BP3pmiyrrwfs5qy&page=455030324B4D44314C52504D304B4A5945514734",
        "collection_period": "monthly",
        "collection_day": "12",
        "payment_types": "DDMandateOnly",
        "collection_stretch": 1,
        "description": "Ongoing DD Payments",
        "on_page_description": "",
        "single_use": false,
        "expiry": "never",
        "payment_type_step": "Skip",
        "customer_step": "Edit",
        "bank_step": "Edit",
        "card_step": "Skip",
        "schedule_step": "Skip",
        "branding": "EB02XDNZWLJRQPGQ914E",
        "client_bank_account": "OB01O6YQRDJZWJVL359M",
        "account_validation_required": false,
        "encryption_key": "vlL7rgnvdQ1jyVRktLGbec9OMwYCrjaKoB/O+asVKSE="
    }
}