GET request/Bank/Direct/Valid-Info

?sortCode={sortCode}&accountNumber={accountNumber}

Used to validate a consumer’s bank account and sort code for direct debit ONLY payment methods during consumer energy switching

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accountNumber

string

Required

sortCode

string

Required

Body Parameters

None.

Response Information

Resource Description

AboutBankDtoResponse
NameDescriptionTypeAdditional information
AboutBankDto

AboutBankDto

None.

ApiVersion

string

None.

Uri

string

None.

Response Formats

application/json, text/json

Sample:
{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "aboutBankDto": {
    "sortcode": "sample string 1",
    "accountNumber": "sample string 2",
    "accountName": "sample string 3",
    "name": "sample string 4",
    "info": "sample string 5",
    "isValid": true,
    "branch": "sample string 7",
    "bankAddressLine1": "sample string 8",
    "bankAddressLine2": "sample string 9",
    "bankAddressTown": "sample string 10",
    "bankAddressPostCode": "sample string 11"
  }
}

application/xml, text/xml

Sample:
<AboutBankDtoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.DtoResponse">
  <AboutBankDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.Dto">
    <d2p1:AccountName>sample string 3</d2p1:AccountName>
    <d2p1:AccountNumber>sample string 2</d2p1:AccountNumber>
    <d2p1:BankAddressLine1>sample string 8</d2p1:BankAddressLine1>
    <d2p1:BankAddressLine2>sample string 9</d2p1:BankAddressLine2>
    <d2p1:BankAddressPostCode>sample string 11</d2p1:BankAddressPostCode>
    <d2p1:BankAddressTown>sample string 10</d2p1:BankAddressTown>
    <d2p1:Branch>sample string 7</d2p1:Branch>
    <d2p1:Info>sample string 5</d2p1:Info>
    <d2p1:IsValid>true</d2p1:IsValid>
    <d2p1:Name>sample string 4</d2p1:Name>
    <d2p1:Sortcode>sample string 1</d2p1:Sortcode>
  </AboutBankDto>
  <ApiVersion>sample string 1</ApiVersion>
  <Uri>sample string 2</Uri>
</AboutBankDtoResponse>

multipart/form-data

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

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

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AboutBankDto.Sortcode"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AboutBankDto.AccountNumber"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AboutBankDto.AccountName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AboutBankDto.Name"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AboutBankDto.Info"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AboutBankDto.IsValid"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AboutBankDto.Branch"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AboutBankDto.BankAddressLine1"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AboutBankDto.BankAddressLine2"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AboutBankDto.BankAddressTown"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AboutBankDto.BankAddressPostCode"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e--