CDD Engine Web Service v2.14.0.0

<back to all web services

BankAccountRequest

iNASA
Requires Authentication
The following routes are available for this service:
GET, POST/BankAccount
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BankAccountResult:
    account_name: Optional[str] = None
    bank_name: Optional[str] = None
    sort_code: Optional[str] = None
    is_valid: Optional[bool] = None
    is_direct_debit_capable: Optional[bool] = None
    account_number: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BankAccountResponse:
    result: Optional[BankAccountResult] = None
    """
    Contains the bank account lookup result when successful.
    """

    response_status: Optional[ResponseStatus] = None
    """
    Contains response status, details and errors.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BankAccountRequest:
    # @Required()
    sortcode: Optional[str] = None
    """
    The bank sort code.
    """


    # @Required()
    account_number: Optional[str] = None
    """
    The bank account number.
    """


    csr: Optional[str] = None
    """
    The Csr of the application (if available).
    """

Python BankAccountRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /BankAccount HTTP/1.1 
Host: wpcdd-featuretest-ws.worldpay.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BankAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CDD_Engine_WS.dto.Requests">
  <AccountNumber>String</AccountNumber>
  <Csr>String</Csr>
  <Sortcode>String</Sortcode>
</BankAccountRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BankAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CDD_Engine_WS.dto.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <BankName>String</BankName>
    <IsDirectDebitCapable>false</IsDirectDebitCapable>
    <IsValid>false</IsValid>
    <SortCode>String</SortCode>
  </Result>
</BankAccountResponse>