POST api/customer/ValidateBankDetails

Validates supplied bank account details with VSeries

Request Information

URI Parameters

None.

Body Parameters

DirectDebitModel
NameDescriptionTypeAdditional information
AccountCode

Code of account to link the direct debit to

 string

None.
BoatNo

Unique identifier of the boat the direct debit is linked to

 integer

None.
MarinaCode

Code of marina where to create the marina, leave blank if Direct Debits are global across all marinas

 string

None.
FrequencyId

Frequency of direct debit: 1 = weekly, 2 = monthly, 3 = quarterly, 4 = bi-annually, 5 = annually

 integer

None.
BankAccountName

Name of bank account

 string

None.
BankAccountNumber

Bank account number

 string

None.
SortCode

Bank sort code

 string

None.
ContractRenewalDetails

If specified, then DDSchedule is calculated and returned along with any upfront payment amount

 DirectDebitContractUpdateModel

None.

Request Formats

application/json, text/json

Sample: 
{
  "accountCode": "sample string 1",
  "boatNo": 2,
  "marinaCode": "sample string 3",
  "frequencyId": 4,
  "bankAccountName": "sample string 5",
  "bankAccountNumber": "sample string 6",
  "sortCode": "sample string 7",
  "contractRenewalDetails": {
    "contractId": 1,
    "contractType": "sample string 2",
    "loyaltyPointsToUse": 1
  }
}

multipart/form-data

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

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

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MarinaCode"

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

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BankAccountName"

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

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

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalDetails.contractId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalDetails.contractType"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ContractRenewalDetails.LoyaltyPointsToUse"

1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ValidateDirectDebitResultModel
NameDescriptionTypeAdditional information
ResultCode

Code indicating outcome: 1 - new direct debit created successfully, 2 - direct debit failed VSeries validation, 3 - direct debit successfully verified, 4 - direct debit not created

 integer

None.
Message

Message accompanying result code

 string

None.
DDSchedule

DD payment information

 DirectDebitScheduleListModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "resultCode": 1,
  "message": "sample string 2",
  "ddSchedule": {
    "upfrontAmount": 1.0,
    "ddScheduleList": [
      {
        "date": "sample string 1",
        "amount": 2.0
      },
      {
        "date": "sample string 1",
        "amount": 2.0
      }
    ]
  }
}

multipart/form-data

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

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Message"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DDSchedule.UpfrontAmount"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DDSchedule.DDScheduleList[0].Date"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DDSchedule.DDScheduleList[0].Amount"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DDSchedule.DDScheduleList[1].Date"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DDSchedule.DDScheduleList[1].Amount"

2
--MultipartDataMediaFormatterBoundary1q2w3e--