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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"Sortcode":"String","AccountNumber":"String","Csr":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Result":{"AccountName":"String","BankName":"String","SortCode":"String","IsValid":false,"IsDirectDebitCapable":false,"AccountNumber":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}