POST Api/Sales/Windcave/InitiatePayment

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PaymentTransactionID		globally unique identifier	None.
Model		PowershopParamModels	None.

Request Formats

application/json, text/json

Sample:

{
  "PaymentTransactionID": "049b0434-d806-4c1e-8548-465c405d7da3",
  "Model": {
    "accountSetup": {
      "AccountType": "sample string 1"
    },
    "accountHolder": {
      "AccountType": "sample string 1",
      "Title": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "DateOfBirth": "sample string 5",
      "PhoneNumber": "sample string 6"
    },
    "login": {
      "Email": "sample string 1"
    },
    "businessDetails": {
      "Name": "sample string 1",
      "RegisteredBusinessNumber": "sample string 2",
      "AnzsicCode": "sample string 3",
      "PhoneNumber": "sample string 4",
      "IsTaxRegistered": true
    },
    "SecondaryAccountHolders": [
      {
        "Title": "sample string 1",
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "DateOfBirth": "sample string 4",
        "PhoneNumber": "sample string 5"
      },
      {
        "Title": "sample string 1",
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "DateOfBirth": "sample string 4",
        "PhoneNumber": "sample string 5"
      }
    ],
    "propertyInformation": {
      "SupplyAddress": {
        "FlatNumber": "sample string 1",
        "FlatType": "sample string 2",
        "FloorNumber": "sample string 3",
        "FloorType": "sample string 4",
        "HouseNumber": 5,
        "HouseNumberSuffix": "sample string 6",
        "StreetName": "sample string 7",
        "StreetType": "sample string 8",
        "StreetSuffix": "sample string 9",
        "Postcode": "sample string 10",
        "Suburb": "sample string 11",
        "Region": "sample string 12"
      },
      "CurrentSituation": "sample string 1",
      "Hazards": {
        "Dog": true,
        "ElectricFence": true,
        "Caution": true,
        "ElectricalSafetyIssue": true,
        "AsbestosFuse": true,
        "AsbestosBoard": true,
        "Other": "sample string 1"
      }
    },
    "PostalAddress": {
      "FlatNumber": "sample string 1",
      "FlatType": "sample string 2",
      "FloorNumber": "sample string 3",
      "FloorType": "sample string 4",
      "HouseNumber": 5,
      "HouseNumberSuffix": "sample string 6",
      "StreetName": "sample string 7",
      "StreetType": "sample string 8",
      "StreetSuffix": "sample string 9",
      "Postcode": "sample string 10",
      "Suburb": "sample string 11",
      "Region": "sample string 12"
    },
    "utilityDetails": [
      {
        "UtilityType": "sample string 1",
        "ConnectionNumber": "sample string 2",
        "CurrentSupplier": "sample string 3",
        "ProposedStartDate": "sample string 4",
        "IsConnectionCurrentlyActive": true,
        "MeterDetails": {
          "MeterLocationNotes": "sample string 1"
        },
        "EstimatedBilling": {
          "Cost": 1,
          "Period": "sample string 2"
        },
        "vulnerabilityDetails": {
          "DependencyType": "sample string 1",
          "MedicalReason": "sample string 2",
          "MedicalDetailsDisclaimerAcceptedAt": "sample string 3",
          "LifeSupportEquipment": "sample string 4"
        }
      },
      {
        "UtilityType": "sample string 1",
        "ConnectionNumber": "sample string 2",
        "CurrentSupplier": "sample string 3",
        "ProposedStartDate": "sample string 4",
        "IsConnectionCurrentlyActive": true,
        "MeterDetails": {
          "MeterLocationNotes": "sample string 1"
        },
        "EstimatedBilling": {
          "Cost": 1,
          "Period": "sample string 2"
        },
        "vulnerabilityDetails": {
          "DependencyType": "sample string 1",
          "MedicalReason": "sample string 2",
          "MedicalDetailsDisclaimerAcceptedAt": "sample string 3",
          "LifeSupportEquipment": "sample string 4"
        }
      }
    ],
    "promotion": {
      "PromotionCode": "sample string 1",
      "PromotionTermsAndConditionsAcceptedAt": "sample string 2"
    },
    "vulnerabilities": {
      "DependencyType": "sample string 1",
      "MedicalReason": "sample string 2",
      "MedicalDetailsDisclaimerAcceptedAt": "sample string 3",
      "LifeSupportEquipment": "sample string 4"
    },
    "paymentDetails": {
      "Card": {
        "CardType": "sample string 1",
        "MaskedCardNumber": "sample string 2",
        "ExpiryDate": "sample string 3",
        "CardholderName": "sample string 4",
        "Token": "sample string 5",
        "TermsAndConditionsAcceptedAt": "sample string 6",
        "Preferred": true
      },
      "DirectDebit": {
        "AccountName": "sample string 1",
        "BankNumber": "sample string 2",
        "BranchNumber": "sample string 3",
        "AccountNumber": "sample string 4",
        "TermsAndConditionsAcceptedAt": "sample string 5",
        "Preferred": true
      },
      "AmountInformation": {
        "Amount": 1.0,
        "CurrencyInformation": "sample string 2",
        "MerchantReference": "sample string 3"
      },
      "Callback": {
        "Url": "sample string 1"
      }
    },
    "ConcessionCards": [
      {
        "CustomerReferenceNumber": "sample string 1",
        "ConcessionEvidenceType": "sample string 2",
        "StartDate": "sample string 3",
        "EndDate": "sample string 4",
        "FirstName": "sample string 5",
        "LastName": "sample string 6",
        "AgreedToCcesValidation": true,
        "ConfirmedResidence": true,
        "Concessions": [
          {
            "ConcessionType": "sample string 1",
            "StartDate": "sample string 2",
            "EndDate": "sample string 3",
            "Value": 1.0
          },
          {
            "ConcessionType": "sample string 1",
            "StartDate": "sample string 2",
            "EndDate": "sample string 3",
            "Value": 1.0
          }
        ]
      },
      {
        "CustomerReferenceNumber": "sample string 1",
        "ConcessionEvidenceType": "sample string 2",
        "StartDate": "sample string 3",
        "EndDate": "sample string 4",
        "FirstName": "sample string 5",
        "LastName": "sample string 6",
        "AgreedToCcesValidation": true,
        "ConfirmedResidence": true,
        "Concessions": [
          {
            "ConcessionType": "sample string 1",
            "StartDate": "sample string 2",
            "EndDate": "sample string 3",
            "Value": 1.0
          },
          {
            "ConcessionType": "sample string 1",
            "StartDate": "sample string 2",
            "EndDate": "sample string 3",
            "Value": 1.0
          }
        ]
      }
    ],
    "EligibleForConcessions": true,
    "SupportRequest": "sample string 1",
    "TermsAndConditionsAcceptedAt": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<InitiatePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Windcave">
  <Model xmlns:d2p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Powershop">
    <d2p1:ConcessionCards>
      <d2p1:PowershopParamModels.ConcessionCard>
        <d2p1:AgreedToCcesValidation>true</d2p1:AgreedToCcesValidation>
        <d2p1:ConcessionEvidenceType>sample string 2</d2p1:ConcessionEvidenceType>
        <d2p1:Concessions>
          <d2p1:PowershopParamModels.Concession>
            <d2p1:ConcessionType>sample string 1</d2p1:ConcessionType>
            <d2p1:EndDate>sample string 3</d2p1:EndDate>
            <d2p1:StartDate>sample string 2</d2p1:StartDate>
            <d2p1:Value>1</d2p1:Value>
          </d2p1:PowershopParamModels.Concession>
          <d2p1:PowershopParamModels.Concession>
            <d2p1:ConcessionType>sample string 1</d2p1:ConcessionType>
            <d2p1:EndDate>sample string 3</d2p1:EndDate>
            <d2p1:StartDate>sample string 2</d2p1:StartDate>
            <d2p1:Value>1</d2p1:Value>
          </d2p1:PowershopParamModels.Concession>
        </d2p1:Concessions>
        <d2p1:ConfirmedResidence>true</d2p1:ConfirmedResidence>
        <d2p1:CustomerReferenceNumber>sample string 1</d2p1:CustomerReferenceNumber>
        <d2p1:EndDate>sample string 4</d2p1:EndDate>
        <d2p1:FirstName>sample string 5</d2p1:FirstName>
        <d2p1:LastName>sample string 6</d2p1:LastName>
        <d2p1:StartDate>sample string 3</d2p1:StartDate>
      </d2p1:PowershopParamModels.ConcessionCard>
      <d2p1:PowershopParamModels.ConcessionCard>
        <d2p1:AgreedToCcesValidation>true</d2p1:AgreedToCcesValidation>
        <d2p1:ConcessionEvidenceType>sample string 2</d2p1:ConcessionEvidenceType>
        <d2p1:Concessions>
          <d2p1:PowershopParamModels.Concession>
            <d2p1:ConcessionType>sample string 1</d2p1:ConcessionType>
            <d2p1:EndDate>sample string 3</d2p1:EndDate>
            <d2p1:StartDate>sample string 2</d2p1:StartDate>
            <d2p1:Value>1</d2p1:Value>
          </d2p1:PowershopParamModels.Concession>
          <d2p1:PowershopParamModels.Concession>
            <d2p1:ConcessionType>sample string 1</d2p1:ConcessionType>
            <d2p1:EndDate>sample string 3</d2p1:EndDate>
            <d2p1:StartDate>sample string 2</d2p1:StartDate>
            <d2p1:Value>1</d2p1:Value>
          </d2p1:PowershopParamModels.Concession>
        </d2p1:Concessions>
        <d2p1:ConfirmedResidence>true</d2p1:ConfirmedResidence>
        <d2p1:CustomerReferenceNumber>sample string 1</d2p1:CustomerReferenceNumber>
        <d2p1:EndDate>sample string 4</d2p1:EndDate>
        <d2p1:FirstName>sample string 5</d2p1:FirstName>
        <d2p1:LastName>sample string 6</d2p1:LastName>
        <d2p1:StartDate>sample string 3</d2p1:StartDate>
      </d2p1:PowershopParamModels.ConcessionCard>
    </d2p1:ConcessionCards>
    <d2p1:EligibleForConcessions>true</d2p1:EligibleForConcessions>
    <d2p1:PostalAddress>
      <d2p1:FlatNumber>sample string 1</d2p1:FlatNumber>
      <d2p1:FlatType>sample string 2</d2p1:FlatType>
      <d2p1:FloorNumber>sample string 3</d2p1:FloorNumber>
      <d2p1:FloorType>sample string 4</d2p1:FloorType>
      <d2p1:HouseNumber>5</d2p1:HouseNumber>
      <d2p1:HouseNumberSuffix>sample string 6</d2p1:HouseNumberSuffix>
      <d2p1:Postcode>sample string 10</d2p1:Postcode>
      <d2p1:Region>sample string 12</d2p1:Region>
      <d2p1:StreetName>sample string 7</d2p1:StreetName>
      <d2p1:StreetSuffix>sample string 9</d2p1:StreetSuffix>
      <d2p1:StreetType>sample string 8</d2p1:StreetType>
      <d2p1:Suburb>sample string 11</d2p1:Suburb>
    </d2p1:PostalAddress>
    <d2p1:SecondaryAccountHolders>
      <d2p1:PowershopParamModels.SecondaryAccountHolder>
        <d2p1:DateOfBirth>sample string 4</d2p1:DateOfBirth>
        <d2p1:FirstName>sample string 2</d2p1:FirstName>
        <d2p1:LastName>sample string 3</d2p1:LastName>
        <d2p1:PhoneNumber>sample string 5</d2p1:PhoneNumber>
        <d2p1:Title>sample string 1</d2p1:Title>
      </d2p1:PowershopParamModels.SecondaryAccountHolder>
      <d2p1:PowershopParamModels.SecondaryAccountHolder>
        <d2p1:DateOfBirth>sample string 4</d2p1:DateOfBirth>
        <d2p1:FirstName>sample string 2</d2p1:FirstName>
        <d2p1:LastName>sample string 3</d2p1:LastName>
        <d2p1:PhoneNumber>sample string 5</d2p1:PhoneNumber>
        <d2p1:Title>sample string 1</d2p1:Title>
      </d2p1:PowershopParamModels.SecondaryAccountHolder>
    </d2p1:SecondaryAccountHolders>
    <d2p1:SupportRequest>sample string 1</d2p1:SupportRequest>
    <d2p1:TermsAndConditionsAcceptedAt>sample string 2</d2p1:TermsAndConditionsAcceptedAt>
    <d2p1:accountHolder>
      <d2p1:AccountType>sample string 1</d2p1:AccountType>
      <d2p1:DateOfBirth>sample string 5</d2p1:DateOfBirth>
      <d2p1:FirstName>sample string 3</d2p1:FirstName>
      <d2p1:LastName>sample string 4</d2p1:LastName>
      <d2p1:PhoneNumber>sample string 6</d2p1:PhoneNumber>
      <d2p1:Title>sample string 2</d2p1:Title>
    </d2p1:accountHolder>
    <d2p1:accountSetup>
      <d2p1:AccountType>sample string 1</d2p1:AccountType>
    </d2p1:accountSetup>
    <d2p1:businessDetails>
      <d2p1:AnzsicCode>sample string 3</d2p1:AnzsicCode>
      <d2p1:IsTaxRegistered>true</d2p1:IsTaxRegistered>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:PhoneNumber>sample string 4</d2p1:PhoneNumber>
      <d2p1:RegisteredBusinessNumber>sample string 2</d2p1:RegisteredBusinessNumber>
    </d2p1:businessDetails>
    <d2p1:login>
      <d2p1:Email>sample string 1</d2p1:Email>
    </d2p1:login>
    <d2p1:paymentDetails>
      <d2p1:AmountInformation>
        <d2p1:Amount>1</d2p1:Amount>
        <d2p1:CurrencyInformation>sample string 2</d2p1:CurrencyInformation>
        <d2p1:MerchantReference>sample string 3</d2p1:MerchantReference>
      </d2p1:AmountInformation>
      <d2p1:Callback>
        <d2p1:Url>sample string 1</d2p1:Url>
      </d2p1:Callback>
      <d2p1:Card>
        <d2p1:CardType>sample string 1</d2p1:CardType>
        <d2p1:CardholderName>sample string 4</d2p1:CardholderName>
        <d2p1:ExpiryDate>sample string 3</d2p1:ExpiryDate>
        <d2p1:MaskedCardNumber>sample string 2</d2p1:MaskedCardNumber>
        <d2p1:Preferred>true</d2p1:Preferred>
        <d2p1:TermsAndConditionsAcceptedAt>sample string 6</d2p1:TermsAndConditionsAcceptedAt>
        <d2p1:Token>sample string 5</d2p1:Token>
      </d2p1:Card>
      <d2p1:DirectDebit>
        <d2p1:AccountName>sample string 1</d2p1:AccountName>
        <d2p1:AccountNumber>sample string 4</d2p1:AccountNumber>
        <d2p1:BankNumber>sample string 2</d2p1:BankNumber>
        <d2p1:BranchNumber>sample string 3</d2p1:BranchNumber>
        <d2p1:Preferred>true</d2p1:Preferred>
        <d2p1:TermsAndConditionsAcceptedAt>sample string 5</d2p1:TermsAndConditionsAcceptedAt>
      </d2p1:DirectDebit>
    </d2p1:paymentDetails>
    <d2p1:promotion>
      <d2p1:PromotionCode>sample string 1</d2p1:PromotionCode>
      <d2p1:PromotionTermsAndConditionsAcceptedAt>sample string 2</d2p1:PromotionTermsAndConditionsAcceptedAt>
    </d2p1:promotion>
    <d2p1:propertyInformation>
      <d2p1:CurrentSituation>sample string 1</d2p1:CurrentSituation>
      <d2p1:Hazards>
        <d2p1:AsbestosBoard>true</d2p1:AsbestosBoard>
        <d2p1:AsbestosFuse>true</d2p1:AsbestosFuse>
        <d2p1:Caution>true</d2p1:Caution>
        <d2p1:Dog>true</d2p1:Dog>
        <d2p1:ElectricFence>true</d2p1:ElectricFence>
        <d2p1:ElectricalSafetyIssue>true</d2p1:ElectricalSafetyIssue>
        <d2p1:Other>sample string 1</d2p1:Other>
      </d2p1:Hazards>
      <d2p1:SupplyAddress>
        <d2p1:FlatNumber>sample string 1</d2p1:FlatNumber>
        <d2p1:FlatType>sample string 2</d2p1:FlatType>
        <d2p1:FloorNumber>sample string 3</d2p1:FloorNumber>
        <d2p1:FloorType>sample string 4</d2p1:FloorType>
        <d2p1:HouseNumber>5</d2p1:HouseNumber>
        <d2p1:HouseNumberSuffix>sample string 6</d2p1:HouseNumberSuffix>
        <d2p1:Postcode>sample string 10</d2p1:Postcode>
        <d2p1:Region>sample string 12</d2p1:Region>
        <d2p1:StreetName>sample string 7</d2p1:StreetName>
        <d2p1:StreetSuffix>sample string 9</d2p1:StreetSuffix>
        <d2p1:StreetType>sample string 8</d2p1:StreetType>
        <d2p1:Suburb>sample string 11</d2p1:Suburb>
      </d2p1:SupplyAddress>
    </d2p1:propertyInformation>
    <d2p1:utilityDetails>
      <d2p1:PowershopParamModels.UtilityDetails>
        <d2p1:ConnectionNumber>sample string 2</d2p1:ConnectionNumber>
        <d2p1:CurrentSupplier>sample string 3</d2p1:CurrentSupplier>
        <d2p1:EstimatedBilling>
          <d2p1:Cost>1</d2p1:Cost>
          <d2p1:Period>sample string 2</d2p1:Period>
        </d2p1:EstimatedBilling>
        <d2p1:IsConnectionCurrentlyActive>true</d2p1:IsConnectionCurrentlyActive>
        <d2p1:MeterDetails>
          <d2p1:MeterLocationNotes>sample string 1</d2p1:MeterLocationNotes>
        </d2p1:MeterDetails>
        <d2p1:ProposedStartDate>sample string 4</d2p1:ProposedStartDate>
        <d2p1:UtilityType>sample string 1</d2p1:UtilityType>
        <d2p1:vulnerabilityDetails>
          <d2p1:DependencyType>sample string 1</d2p1:DependencyType>
          <d2p1:LifeSupportEquipment>sample string 4</d2p1:LifeSupportEquipment>
          <d2p1:MedicalDetailsDisclaimerAcceptedAt>sample string 3</d2p1:MedicalDetailsDisclaimerAcceptedAt>
          <d2p1:MedicalReason>sample string 2</d2p1:MedicalReason>
        </d2p1:vulnerabilityDetails>
      </d2p1:PowershopParamModels.UtilityDetails>
      <d2p1:PowershopParamModels.UtilityDetails>
        <d2p1:ConnectionNumber>sample string 2</d2p1:ConnectionNumber>
        <d2p1:CurrentSupplier>sample string 3</d2p1:CurrentSupplier>
        <d2p1:EstimatedBilling>
          <d2p1:Cost>1</d2p1:Cost>
          <d2p1:Period>sample string 2</d2p1:Period>
        </d2p1:EstimatedBilling>
        <d2p1:IsConnectionCurrentlyActive>true</d2p1:IsConnectionCurrentlyActive>
        <d2p1:MeterDetails>
          <d2p1:MeterLocationNotes>sample string 1</d2p1:MeterLocationNotes>
        </d2p1:MeterDetails>
        <d2p1:ProposedStartDate>sample string 4</d2p1:ProposedStartDate>
        <d2p1:UtilityType>sample string 1</d2p1:UtilityType>
        <d2p1:vulnerabilityDetails>
          <d2p1:DependencyType>sample string 1</d2p1:DependencyType>
          <d2p1:LifeSupportEquipment>sample string 4</d2p1:LifeSupportEquipment>
          <d2p1:MedicalDetailsDisclaimerAcceptedAt>sample string 3</d2p1:MedicalDetailsDisclaimerAcceptedAt>
          <d2p1:MedicalReason>sample string 2</d2p1:MedicalReason>
        </d2p1:vulnerabilityDetails>
      </d2p1:PowershopParamModels.UtilityDetails>
    </d2p1:utilityDetails>
    <d2p1:vulnerabilities>
      <d2p1:DependencyType>sample string 1</d2p1:DependencyType>
      <d2p1:LifeSupportEquipment>sample string 4</d2p1:LifeSupportEquipment>
      <d2p1:MedicalDetailsDisclaimerAcceptedAt>sample string 3</d2p1:MedicalDetailsDisclaimerAcceptedAt>
      <d2p1:MedicalReason>sample string 2</d2p1:MedicalReason>
    </d2p1:vulnerabilities>
  </Model>
  <PaymentTransactionID>049b0434-d806-4c1e-8548-465c405d7da3</PaymentTransactionID>
</InitiatePaymentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.