POST request/Switch/Pro/Update/Bank

Returns a set of specific bank detail captures for a consumer switching energy to either provide or has already provided as mandatory. (Direct debit only switches). Bank details can be updated dependent on how the consumer switching journey is built.

Request Information

URI Parameters

None.

Body Parameters

The details bank binding model.

DetailsBankBindingModel
NameDescriptionTypeAdditional information
AccountName

string

Required

Min length: 1

String length: inclusive between 0 and 100

AccountNumber

string

Required

Min length: 8

String length: inclusive between 0 and 14

BankAddressLine1

string

None.

BankAddressLine2

string

None.

BankAddressPostCode

string

None.

BankAddressTown

string

None.

Branch

string

None.

IsAuthorisedToSetupDirectDebits

boolean

Required

IsCertainOfDataCorrectness

boolean

None.

IsTou

boolean

None.

Name

string

Min length: 1

String length: inclusive between 0 and 100

PreferredDirectDebitDay

DirectDebitDayOfTheMonth

Required

SortCode

string

Required

Min length: 6

String length: inclusive between 0 and 6

SwitchKey

string

Required

Max length: 50

Min length: 1

Request Formats

application/json, text/json

Sample:
{
  "accountName": "sample string 1",
  "preferredDirectDebitDay": "First",
  "name": "sample string 2",
  "branch": "sample string 3",
  "bankAddressLine1": "sample string 4",
  "bankAddressLine2": "sample string 5",
  "bankAddressTown": "sample string 6",
  "bankAddressPostCode": "sample string 7",
  "isCertainOfDataCorrectness": true,
  "isAuthorisedToSetupDirectDebits": true,
  "sortCode": "sample string 8",
  "accountNumber": "sample string 9",
  "switchKey": "sample string 10",
  "isTou": true
}

application/xml, text/xml

Sample:
<DetailsBankBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.BindingModel">
  <IsTou>true</IsTou>
  <SwitchKey>sample string 10</SwitchKey>
  <AccountNumber>sample string 9</AccountNumber>
  <SortCode>sample string 8</SortCode>
  <AccountName>sample string 1</AccountName>
  <BankAddressLine1>sample string 4</BankAddressLine1>
  <BankAddressLine2>sample string 5</BankAddressLine2>
  <BankAddressPostCode>sample string 7</BankAddressPostCode>
  <BankAddressTown>sample string 6</BankAddressTown>
  <Branch>sample string 3</Branch>
  <IsAuthorisedToSetupDirectDebits>true</IsAuthorisedToSetupDirectDebits>
  <IsCertainOfDataCorrectness>true</IsCertainOfDataCorrectness>
  <Name>sample string 2</Name>
  <PreferredDirectDebitDay>First</PreferredDirectDebitDay>
</DetailsBankBindingModel>

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AccountName"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PreferredDirectDebitDay"

First
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Branch"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BankAddressLine1"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BankAddressLine2"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BankAddressTown"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BankAddressPostCode"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsCertainOfDataCorrectness"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsAuthorisedToSetupDirectDebits"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SortCode"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AccountNumber"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SwitchKey"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsTou"

True
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample:
{}

application/xml, text/xml

Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name=""

System.Object
--MultipartDataMediaFormatterBoundary1q2w3e--