Enums and Data Structures

This section provides details of parameters with Enumerated (Enum) values and data structures.

BankingFeaturesType

Property	Type	Value	Description
BankingIn	Enum	ENUM_BankingIn	See ENUM_BankingInEnabled
BankingOut	Enum	ENUM_BankingOut	See ENUM_BankingOutEnabled
DirectDebitIn	Enum	DirectDebitIn	See ENUM_DirectDebitInEnabled
DirectDebitOut	Enum	DirectDebitOut	See ENUM_DirectDebitOutEnabled
SEPAIn	Boolean	SEPAInEnabled	Allow payments in. Set to TRUE or FALSE.
SEPAOut	Boolean	SEPAOutEnabled	Allow payments out. Set to TRUE or FALSE.
AccountName	String	AccountName	Account name.

Changed Banking Features

Property	Type	Value	Description
PublicToken	Integer	PublicToken	Public token
BankingFeatures	Data structure	BankingFeaturesReturnType	See BankingFeaturesReturnType
	Enum	UpdateSuccess	See ENUM_ChangedBankingFeaturesUpdate
BankingFeaturesReturnType	Enum	BankingIn	See ENUM_BankingInEnabled
	Enum	BankingOut	See ENUM_BankingOutEnabled
	Enum	DirectDebitIn	See ENUM_DirectDebitInEnabled
	Enum	DirectDebitOut	See ENUM_DirectDebitOutEnabled
	Enum	CardEnabled	See ENUM_CardEnabled.

BankingEnabled Enums

Property	Type	Value	Description
ENUM_BankingInEnabled	Enum	Enabled Disabled	Enabled Disabled
ENUM_BankingOutEnabled	Enum	Enabled Disabled	Enabled Disabled
ENUM_DirectDebitInEnabled	Enum	Enabled Disabled	Enabled Disabled
ENUM_DirectDebitOutEnabled	Enum	Enabled Disabled	Enabled Disabled
ENUM_ChangedBankingFeaturesUpdate	Enum	Success Fail DirectDebitNotAllowed	Successful Failed Direct Debit not allowed

Enum_CardEnabled

Property	Type	Value	Description
ENUM_CardEnabled	Enum	Enabled Disabled	Enabled Disabled

AccountStatus

Property	Type	Value	Description
AccountStatus	Enum	AccountStatus	See ENUM_AccountStatus.
	Enum	BankingInEnabled	See ENUM_BankingInEnabled.
	Enum	BankingOutEnabled	See ENUM_BankingOutEnabled.
	Enum	DirectDebitInEnabled	See ENUM_DirectDebitInEnabled.
	Enum	DirectDebitOutEnabled	See ENUM_DirectDebitOutEnabled
	Enum	CardEnabled	See ENUM_CardEnabled.

ENUM_AccountStatus

Property	Type	Value	Description
ENUM_AccountStatus	Enum	Open Closed SuspendedPaymentsInAllowed FullySuspended Deceased Probate	The account is open. The account is closed. The account is suspended, but payments in are allowed. The account is fully suspended. The account holder is deceased The account is in probate (for a deceased account holder)

BLAccount

Property	Type	Value	Description
BLAccount	Integer (long)	PublicToken	Encrypted public token
	String	SortCode	String of the 6-digit sort code
	String	AccountNumber	String of account number
	Enum	Status	Account status. See ENUM_AccountStatus.
	Number	Balance	Account balance (decimal)
	String	UpdateStatusResult	String of status result

BankingFeatures

Property	Type	Value	Description
ExistingToken	String	ExistingToken	Public token.
BankingIn	Boolean	BankingInEnabled	Allow payments in. Set to "TRUE" or "FALSE".
BankingOut	Boolean	BankingOutEnabled	Allow payments out. Set to "TRUE" or "FALSE".
DirectDebitIn	Boolean	DirectDebitInEnabled	Allow direct debit payments in. Set to "TRUE" or "FALSE".
DirectDebitOut	Boolean	DirectDebitOutEnabled	Allow direct debit payments out. Set to "TRUE" or "FALSE".
CardEnabled	Boolean	CardEnabled	Indicates whether the card is enabled. Set to "TRUE" or "FALSE".
Status	String	Status	Account status code.
CompanyName	String	CompanyName	Company name.
AccountName	String	AccountName	Account name.

Notes

• Populating the ExistingToken field will add banking features onto an existing card.

• Boolean options, if not populated, will default to true.

• The status codes and their associated options are shown below (0 = false, 1 = true).

Status Code	Description	AllowPaymentsIn	AllowPaymentsOut	AllowDirectDebitIn	AllowDirectDebitOut	Priority	BlockCard	CardStatus
C	Closed	0	0	0	0	1	1	5
D	Customer deceased	1	0	0	0	1	1	5
F	Full suspended	0	0	0	0	1	1	5
O	Open	1	1	1	1	0	1	0
P	Probate	1	1	0	0	1	1	5
S	Suspended payments in allowed	1	0	0	0	1	1	5

* Priority - takes precedent over any other account settings.
** When creating a card, the status is automatically set to status "O" (open).
*** For CardStatus, see Card Status.

BankingError

Property	Type	Value	Description
BankingError	String	field	Error message field.
	String	code	Error message code.
	String	message	Error message.
	String	error	Error.

Beneficiary

Property	Type	Value	Description
Beneficiary	String	AccountNumber	Account number
	String	SortCode	Sort code
	String	AccountName	Account name
	String	IBAN	IBAN

SEPABeneficiaryAddress

Property	Type	Value	Description
SEPABeneficiaryAddress	String	AddressLine1	First line of the address
	String	AddressLine2	Second line of the address
	String	PostTown	Address town or city
	String	PostCode	Address postcode
	String	Country	Address country

ENUM_PaymentMethod

Property	Type	Value	Description
ENUM_PaymentMethod	Enum	FasterPaymentIn FasterPaymentOut BACSIn BACSOut DirectDebitIn FasterPaymentReturn PeerToPeerIn PeerToPeerOut SEPAOut	Faster Payment into the account Faster Payment out of the account BACS payment into the account BACS payment out of the account Direct Debit payment into the account Faster Payment returned Peer-To-Peer payment into the account Peer-To- Peer payment out of the account SEPA payment out of the account

ENUM_PaymentDirection

Property	Type	Value	Description
ENUM_PaymentDirection	Enum	Outbound Inbound	Payment out of the account. Payment into the account.

ENUM_TransferFundsResult

Property	Type	Value	Description
ENUM_TransferFundsResult	Enum	Success Failure	Transfer of funds was successful. Transfer of funds failed.

ENUM_DirectDebitCancellationReason

Property	Type	Value	Description
ENUM_DirectDebitCancellationReason	Enum	AccountClosed CancelledByDebtor DebtorDeceased ReferToDebtor	Account closed. Cancelled by debtor. The debtor is deceased.

ENUM_DirectDebitCancelStatus

Property	Type	Value	Description
ENUM_DirectDebitCancelStatus	Enum	Success Failure	Cancel of direct debit was successful. Cancel of direct debit failed.

ENUM_DirectDebitStatus

Property	Type	Value	Description
ENUM_DirectDebitStatus	Enum	0 1 2 3 4 5	Active Suspended Cancelled Pending Dormant Expired

BLDirectDebit

Type	Value	Description
DateTime	Created	Date and time created.
Enum	CreationMethod	Creation method. See Enum_CreationMethod.
String	CreditorAccountName	Creditor account name
String	CreditorBIC	Creditor BIC
String	CreditorIBAN	Creditor IBAN
String	CreditorReference	Creditor reference
String	DebtorAccountID	Debtor account ID
String	DerivedReference	Derived reference
String	IBAN	IBAN
Guid	ID	ID
Boolean	IgnoreTransactionCode	Whether to ignore the transaction code.
Boolean	IsInstructionHeldAtBank	Whether the instruction is held at a bank.
Boolean	IsPaperless	Whether the instruction is paperless .
Boolean	IsThroughNotificationService	Whether the instruction is through a notification service
DateTime	LatChanged	Date last changed.
String	Reference	Reference.
String	ServiceUserNumber	ServiceUserNumber.
Enum	Status	Direct debit status. See ENUM_DirectDebitStatus.
Boolean	SuppressFirstDirectDebit	Whether to suppress the first direct debit.

ENUM_ChangeAccountStatus

Property	Type	Value	Description
ENUM_ChangeAccountStatus	Enum	Success Failure AccountDoesNotExist AccountInvalidStatus	Account status change successful Account status change failed Account does not exist Invalid account status

ENUM_CreationMethod

Property	Type	Value	Description
ENUM_CreationMethod	Enum	Unknown Manual Imported	Unknown creation method Manually entered into system Imported into system

ENUM_PendingDirectDebit

Property	Type	Value	Description
ENUM_PendingDirectDebit	Enum	LikelySuccess LikelyFailure	Pending Direct Debit likely to succeed. Pending Direct Debit likely to fail.

3D Secure Data Structures

Detail

Property	Type	Value	Description
Detail	String	ENUM_3DS_Details	See ENUM_3DS_Details.

ENUM_3DS_Details

Value	Description
EmbossedName	Up to 120 characters allowed
Last4SSN	Four digit integer.
DateOfBirth	Must be in the format YYYYMMDD.
PANExp	Four digit integer.
FirstName	Up to 120 characters allowed.
MiddleName	Up to 120 characters allowed.
LastName	Up to 120 characters allowed.
NamePrefix	Up to 120 characters allowed.
NameSuffix	Up to 120 characters allowed.
FullSSN	Nine digit integer.
Last6SSN	Six digit integer.
MothersMaidenName	Up to 120 characters allowed.
HomePhone	Up to 50 digit integer.
BusinessPhone	Up to 50 digit integer.
AltPhone1	Up to 50 digit integer.
AltPhone2	Up to 50 digit integer.
RelationshipType	Must be one of the following primary, co-applicant, authorized)
CustomerID	Up to 120 characters allowed.
AddressLine1	Up to 120 characters allowed.
AddressLine2	Up to 120 characters allowed.
City	Up to 120 characters allowed.
StateCode	Two digits
ZipCode	Five digits
CountryCode	Two characters according to ISO 3166-1 alpha-2 standards.
DayOfBirth	Two digits
MonthOfBirth	Two digits
YearOfBirth	Two digits
CreditLimit	Nine digits
LastStatementDate	Must be format YYYYMMDD.
CompanyName	Up to 120 characters allowed
CompanyTel	Up to 50 digit integer
BranchNumber	Ten digits
AccountNumber	Ten digits
Misc1	Up to 120 characters allowed.
Misc2	Up to 120 characters allowed.
Misc3	Up to 120 characters allowed.
Misc4	Up to 120 characters allowed.
Misc5	Up to 120 characters allowed.
Misc6	Up to 120 characters allowed.
Misc7	Up to 120 characters allowed.
Misc8	Up to 120 characters allowed.

ENUM_3DS_Action

Property	Type	Value	Description
ENUM_3DS_Action	String	Add Update Delete	Add 3DS record. Update 3DS record. Delete 3DS record.

Ws_3DS_ReIssue

Property	Type	Value	Description
Ws_3DS_ReIssue	Boolean	ReIssue	Re-issue 3DS token.
	Integer	NewToken	New token value.

Agency Banking Data Structures

Associate

Property	Type	Description
applicant	Boolean	Whether the associate is an applicant.
dateOfBirth	DateTime	Date of birth.
documentInfo	String	Document information
firstName	String	First name
lastName	String	Last name
middleName	String	Middle name
ownership	Int	Ownership
phone	String	Phone
homeAddress	Object	See homeAddress

DocumentInfo

Property	Type	Description
filename	String	Filename of the file sent to the SFTP server.
filepath	String	Filepath to where the file is stored on the SFTP server.
uploadDate	DateTime	Date uploaded to the SFTP server.

homeAddress

Property	Type	Description
addressLine1	String	Address line 1
addressLine2	String	Address line 2
posttown	String	Town
postCode	String	Postcode
country	String	Country

RegisteredAddress

Property	Type	Description
addressLine1	String	Address line 1
addressLine2	String	Address line 2
posttown	String	Town
postCode	String	Postcode
country	String	Country

TradingAddress

Property	Type	Description
addressLine1	String	Address line 1
addressLine2	String	Address line 2
posttown	String	Town
postCode	String	Postcode
country	String	Country

BankingFeaturesReturnType

Property	Type	Description
BankingIn	Enum	See ENUM_BankingInEnabled
BankingOut	Enum	See ENUM_BankingOutEnabled
DirectDebitIn	Enum	See ENUM_DirectDebitInEnabled
DirectDebitOut	Enum	See ENUM_DirectDebitOutEnabled
CardEnabled	Enum	See ENUM_CardEnabled
AccountName	String	The account name.

DD_MANDATES

Type	Value	Description
MandateId	AN	The mandateId related to the direct debit mandate.
MerchantName	AN	MerchantName from the latest DD_INCOMING_DEBIT with the same MandateID.
LastScheduledAmount	N	Amount of last PAYOUT with same Mandate ID.
MandateStatus	AN	The NewStatus of the mandate.
MandateCreatedDate	Date	Date that the mandate ID was originally added to the database.