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 'package:servicestack/servicestack.dart';

class BankAccountResult implements IConvertible
{
    String? AccountName;
    String? BankName;
    String? SortCode;
    bool? IsValid;
    bool? IsDirectDebitCapable;
    String? AccountNumber;

    BankAccountResult({this.AccountName,this.BankName,this.SortCode,this.IsValid,this.IsDirectDebitCapable,this.AccountNumber});
    BankAccountResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AccountName = json['AccountName'];
        BankName = json['BankName'];
        SortCode = json['SortCode'];
        IsValid = json['IsValid'];
        IsDirectDebitCapable = json['IsDirectDebitCapable'];
        AccountNumber = json['AccountNumber'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AccountName': AccountName,
        'BankName': BankName,
        'SortCode': SortCode,
        'IsValid': IsValid,
        'IsDirectDebitCapable': IsDirectDebitCapable,
        'AccountNumber': AccountNumber
    };

    getTypeName() => "BankAccountResult";
    TypeContext? context = _ctx;
}

class BankAccountResponse implements IConvertible
{
    /**
    * Contains the bank account lookup result when successful.
    */
    BankAccountResult? Result;
    /**
    * Contains response status, details and errors.
    */
    ResponseStatus? ResponseStatus;

    BankAccountResponse({this.Result,this.ResponseStatus});
    BankAccountResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Result = JsonConverters.fromJson(json['Result'],'BankAccountResult',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Result': JsonConverters.toJson(Result,'BankAccountResult',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "BankAccountResponse";
    TypeContext? context = _ctx;
}

class BankAccountRequest implements IConvertible
{
    /**
    * The bank sort code.
    */
    // @Required()
    String? Sortcode;

    /**
    * The bank account number.
    */
    // @Required()
    String? AccountNumber;

    /**
    * The Csr of the application (if available).
    */
    String? Csr;

    BankAccountRequest({this.Sortcode,this.AccountNumber,this.Csr});
    BankAccountRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Sortcode = json['Sortcode'];
        AccountNumber = json['AccountNumber'];
        Csr = json['Csr'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Sortcode': Sortcode,
        'AccountNumber': AccountNumber,
        'Csr': Csr
    };

    getTypeName() => "BankAccountRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'wpcdd_featuretest_ws.worldpay.com', types: <String, TypeInfo> {
    'BankAccountResult': TypeInfo(TypeOf.Class, create:() => BankAccountResult()),
    'BankAccountResponse': TypeInfo(TypeOf.Class, create:() => BankAccountResponse()),
    'BankAccountRequest': TypeInfo(TypeOf.Class, create:() => BankAccountRequest()),
});

Dart BankAccountRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Sortcode: String,
	AccountNumber: String,
	Csr: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}