Documente Academic
Documente Profesional
Documente Cultură
Payment Services
Version 9.2.1
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 1 of 126
Electronic Receivable Payment services
SECTION ONE – CONTENTS
This document is protected by copyright and distributed under licenses restricting its use, copying, distribution,
and recompilation. No part of this document many be reproduced in any form by any means without prior
written consent and authorization from The Bank of New York Mellon Corporation.
Documentation is provided “as is” without warranty of any kind, either express or implied, including any kind of
implied or express warranty of non-infringement or the implied warranties of merchantability or fitness for a
particular purpose.
The Bank of New York Mellon Corporation reserves the right to change any products described herein at
any time, and without notice. The Bank of New York Mellon Corporation assumes no responsibility or liability
arising from the use of products described herein, except as expressly agreed to in writing by The Bank of New
York Mellon Corporation. The purchase, installation and use of this software product does not convey a license to
any patent copyright, or trademark rights, or any other intellectual property rights of The Bank of New York
Mellon Corporation.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 2 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 3 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 4 of 126
Many of the designations used by software, hardware manufacturers and sellers to distinguish their products are
claimed as trademarks. Where these designations appear in this document, and where The Bank of New York
Mellon Corporation was aware of a trademark claim, the designations have been printed in capital letters or initial
capitalizations.
While every precaution has been taken in the preparation of this installation document, The Bank of New York
Mellon Corporation assumes no responsibility for errors or omissions, or for damages resulting from the use of
the information contained herein.
______________________
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 5 of 126
Electronic Receivable Payment services
Table of Contents
ABOUT THIS DOCUMENT .................................................................................... 2
TABLE OF CONTENTS .......................................................................................... 6
OVERVIEW ....................................................................................................... 12
DATA TYPES ..................................................................................................... 13
BANK RELATED .................................................................................................... 13
BankInformation ........................................................................................... 13
CHECK RELATED ................................................................................................... 14
CheckTransaction .......................................................................................... 14
CheckAuthorizationInformation ....................................................................... 15
CheckCreditTransaction .................................................................................. 15
ACH RELATED ..................................................................................................... 16
ACHReturnsInformation .................................................................................. 16
ACHInformation ............................................................................................ 16
CREDIT CARD RELATED .......................................................................................... 17
CreditCardAuthorizationInformation ................................................................. 17
CreditCardTransaction .................................................................................... 17
CardHolderInformation ................................................................................... 18
COMMON TO BOTH CHECKS AND CREDIT CARDS ............................................................. 19
Splits ........................................................................................................... 19
PaymentProfileInformation.............................................................................. 19
CUSTOMER RELATED .............................................................................................. 20
CustomerRecord ............................................................................................ 20
GENERAL ........................................................................................................... 21
AuthenticationInformation .............................................................................. 21
ErrorInformation ........................................................................................... 21
GeneralInformation........................................................................................ 21
OptionInformation ......................................................................................... 21
OptionsInformation ........................................................................................ 21
ReceiptInformation ........................................................................................ 21
StatusInformation ......................................................................................... 21
ConvenienceFeeInformation ............................................................................ 21
BlockABAAccountInformation .......................................................................... 22
BlockCreditCardInformation ............................................................................ 22
BlockFieldValueInformation ............................................................................. 22
EBPP AND EMBEDDED SUPPORT ................................................................................ 23
BillInformation .............................................................................................. 23
UserAccountInformation ................................................................................. 23
NotificationSettings ........................................................................................ 23
RecurringPaymentInformation ......................................................................... 24
RESPONSE TYPES ............................................................................................. 25
BankResponse ............................................................................................... 25
CheckResponse ............................................................................................. 25
GetCheckTransactionsResponse ....................................................................... 25
GetLastACHReturnResponse ............................................................................ 25
IsACHABAResponse ....................................................................................... 25
BlockAABAAccountResponse ........................................................................... 25
BlockCreditCardResponse ............................................................................... 26
BlockFieldValueResponse ................................................................................ 26
IsABAAccountNumberValidResponse ................................................................ 26
IsValidCreditCardResponse ............................................................................. 26
CreditCardResponse ....................................................................................... 26
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 6 of 126
Electronic Receivable Payment services
SECTION ONE – CONTENTS
ConvenienceFeeResponse ............................................................................... 26
GetCreditCardTransactionsResponse ................................................................ 26
CardHolderResponse ...................................................................................... 27
CustomerResponse ........................................................................................ 27
OptionResponse ............................................................................................ 27
OptionsResponse ........................................................................................... 27
PaymentProfileResponse ................................................................................. 27
EBPP AND EMBEDDED SUPPORT ................................................................................ 28
BillResponse ................................................................................................. 28
BillsResponse ................................................................................................ 28
BillRenderedResponse .................................................................................... 28
UserAccountResponse .................................................................................... 28
LinkCustomerToUserAccountResponse .............................................................. 28
UnLinkCustomerToUserAccountResponse .......................................................... 28
RecurringPaymentResponse ............................................................................ 28
MESSAGE TYPES ............................................................................................... 29
ADDCHECKTRANSACTION ........................................................................................ 31
Message ....................................................................................................... 31
Response...................................................................................................... 31
AUTHORIZECHECKTRANSACTION................................................................................ 31
Message ....................................................................................................... 31
Response...................................................................................................... 31
AUTHORIZECHECKTRANSACTION (SOAP ACTION = UPDATEANDAUTHORIZECHECKTRANSACTION).... 31
Message ....................................................................................................... 31
Response...................................................................................................... 31
AUTHORIZECHECKTRANSACTION (SOAP ACTION = AUTHORIZEEXISTINGCHECKTRANSACTION) ....... 32
Message ....................................................................................................... 32
Response...................................................................................................... 32
GETCHECKTRANSACTION ........................................................................................ 32
Message ....................................................................................................... 32
Response...................................................................................................... 32
GETCHECKTRANSACTIONS ....................................................................................... 32
Message ....................................................................................................... 32
Response...................................................................................................... 32
DELETECHECKTRANSACTION .................................................................................... 33
Message ....................................................................................................... 33
Response...................................................................................................... 33
ADDCHECKCREDITTRANSACTION ............................................................................... 33
Message ....................................................................................................... 33
Response...................................................................................................... 33
ADDCREDITCARDTRANSACTION................................................................................. 33
Message ....................................................................................................... 33
Response...................................................................................................... 33
ADDCREDITCARDTRANSACTION (SOAP ACTION = UPDATEANDRESUBMITCREDITCARDTRANSACTION)
...................................................................................................................... 34
Message ....................................................................................................... 34
Response...................................................................................................... 34
ADDCREDITCARDTRANSACTION (SOAP ACTION = RESUBMITCREDITCARDTRANSACTION) ............. 34
Message ....................................................................................................... 34
Response...................................................................................................... 34
GETCREDITCARD.................................................................................................. 34
Message ....................................................................................................... 34
Response...................................................................................................... 34
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 7 of 126
GETCREDITCARDTRANSACTION ................................................................................. 35
Message ....................................................................................................... 35
Response...................................................................................................... 35
GETCREDITCARDTRANSACTIONS ............................................................................... 35
Message ....................................................................................................... 35
Response...................................................................................................... 35
VOIDCREDITCARDTRANSACTION................................................................................ 36
Message ....................................................................................................... 36
Response...................................................................................................... 36
REVERSECREDITCARDTRANSACTION ........................................................................... 36
Message ....................................................................................................... 36
Response...................................................................................................... 36
ADDCREDITCARDCREDITTRANSACTION (SOAP ACTION = ADDPARTIALCREDITCARDCREDIT) ......... 36
Message ....................................................................................................... 36
Response...................................................................................................... 36
ADDCREDITCARDCREDITTRANSACTION (SOAP ACTION = ADDFULLCREDITCARDCREDIT) ............. 37
Message ....................................................................................................... 37
Response...................................................................................................... 37
GETCARDHOLDERINFORMATION ................................................................................ 37
Message ....................................................................................................... 37
Response...................................................................................................... 37
ADDCUSTOMERRECORD .......................................................................................... 37
Message ....................................................................................................... 37
Response...................................................................................................... 37
UPDATECUSTOMERRECORD ...................................................................................... 38
Message ....................................................................................................... 38
Response...................................................................................................... 38
GETCUSTOMERRECORD .......................................................................................... 38
Message ....................................................................................................... 38
Response...................................................................................................... 38
DELETECUSTOMERRECORD ...................................................................................... 38
Message ....................................................................................................... 38
Response...................................................................................................... 38
GETLASTACHRETURN (SOAP ACTION = GETLASTACHRETURNBYRECNUM) ............................. 39
Message ....................................................................................................... 39
Response...................................................................................................... 39
GETLASTACHRETURN (SOAP ACTION = GETLASTACHRETURNBYABAACCOUNTNUMBER) ............ 39
Message ....................................................................................................... 39
Response...................................................................................................... 39
ISACHABA ........................................................................................................ 39
Message ....................................................................................................... 39
Response...................................................................................................... 39
ADDPAYMENTPROFILE ............................................................................................ 40
Message ....................................................................................................... 40
Response...................................................................................................... 40
GETPAYMENTPROFILE............................................................................................. 40
Message ....................................................................................................... 40
Response...................................................................................................... 40
GETPAYMENTPROFILE (SOAP ACTION = GETPAYMENTPROFILEBYID)...................................... 40
Message ....................................................................................................... 40
Response...................................................................................................... 40
DELETEPAYMENTPROFILE......................................................................................... 41
Message ....................................................................................................... 41
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 8 of 126
Response...................................................................................................... 41
DELETEPAYMENTPROFILE (SOAP ACTION = GETPAYMENTPROFILEBYID) ................................. 41
Message ....................................................................................................... 41
Response...................................................................................................... 41
UPDATEPAYMENTPROFILE ........................................................................................ 41
Message ....................................................................................................... 41
Response...................................................................................................... 41
BLOCKABAACOUNTNUMBER..................................................................................... 42
Message ....................................................................................................... 42
Response...................................................................................................... 42
UNBLOCKABAACCOUNTNUMBER ............................................................................... 42
Message ....................................................................................................... 42
Response...................................................................................................... 42
ISABAACCOUNTNUMBERBLOCKED ............................................................................. 42
Message ....................................................................................................... 42
Response...................................................................................................... 42
BLOCKCREDITCARDNUMBER..................................................................................... 43
Message ....................................................................................................... 43
Response...................................................................................................... 43
UNBLOCKCREDITCARDNUMBER ................................................................................. 43
Message ....................................................................................................... 43
Response...................................................................................................... 43
ISCREDITCARDNUMBERBLOCKED ............................................................................... 43
Message ....................................................................................................... 43
Response...................................................................................................... 43
ISABAACCOUNTNUMBERVALID ................................................................................. 43
Message ....................................................................................................... 43
Response...................................................................................................... 43
ISVALIDCREDITCARD (SOAP ACTION = ISVALIDCREDITCARDNUMBER) .................................. 44
Message ....................................................................................................... 44
Response...................................................................................................... 44
ISVALIDCREDITCARD (SOAP ACTION = ISVALIDCREDITCARDNUMBERFORPAYTO) ..................... 44
Message ....................................................................................................... 44
Response...................................................................................................... 44
BLOCKFIELDVALUE................................................................................................ 44
Message ....................................................................................................... 44
Response...................................................................................................... 44
UNBLOCKFIELDVALUE ............................................................................................ 44
Message ....................................................................................................... 44
Response...................................................................................................... 44
ISFIELDVALUEBLOCKED .......................................................................................... 45
Message ....................................................................................................... 45
Response...................................................................................................... 45
GETBANKINFORMATION .......................................................................................... 45
Message ....................................................................................................... 45
Response...................................................................................................... 45
GETOPTIONVALUE ................................................................................................ 45
Message ....................................................................................................... 45
Response...................................................................................................... 45
GETOPTIONVALUES ............................................................................................... 46
Message ....................................................................................................... 46
Response...................................................................................................... 46
EBPP SUPPORT.................................................................................................... 47
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 9 of 126
ADDBILL............................................................................................................ 47
Message ....................................................................................................... 47
Response...................................................................................................... 47
GETBILL ............................................................................................................ 47
Message ....................................................................................................... 47
Response...................................................................................................... 47
DELETEBILL ........................................................................................................ 47
Message ....................................................................................................... 47
Response...................................................................................................... 47
UPDATEBILL ....................................................................................................... 48
Message ....................................................................................................... 48
Response...................................................................................................... 48
GETBILLS .......................................................................................................... 48
Message ....................................................................................................... 48
Response...................................................................................................... 48
GETBILLHTML .................................................................................................... 48
Message ....................................................................................................... 48
Response...................................................................................................... 48
GETBILLPDF....................................................................................................... 49
Message ....................................................................................................... 49
Response...................................................................................................... 49
ADDUSERACCOUNT ............................................................................................... 49
Message ....................................................................................................... 49
Response...................................................................................................... 49
GETUSERACCOUNT ............................................................................................... 49
Message ....................................................................................................... 49
Response...................................................................................................... 49
DELETEUSERACCOUNT ........................................................................................... 50
Message ....................................................................................................... 50
Response...................................................................................................... 50
UPDATEUSERACCOUNT ........................................................................................... 50
Message ....................................................................................................... 50
Response...................................................................................................... 50
LINKCUSTOMERTOUSERACCOUNT .............................................................................. 50
Message ....................................................................................................... 50
Response...................................................................................................... 50
UNLINKCUSTOMERTOUSERACCOUNT .......................................................................... 51
Message ....................................................................................................... 51
Response...................................................................................................... 51
ADDRECURRINGPAYMENT ........................................................................................ 51
Message ....................................................................................................... 51
Response...................................................................................................... 51
GETRECURRINGPAYMENT ........................................................................................ 51
Message ....................................................................................................... 51
Response...................................................................................................... 51
DELETERECURRINGPAYMENT .................................................................................... 52
Message ....................................................................................................... 52
Response...................................................................................................... 52
UPDATERECURRINGPAYMENT .................................................................................... 52
Message ....................................................................................................... 52
Response...................................................................................................... 52
PROGRAMMING CONSIDERATIONS .................................................................. 53
EXAMPLE: REQUEST .............................................................................................. 53
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 10 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 11 of 126
Overview
The following document describes the functionality provided by the Electronic Receivable Payment
Services (ERPS) XML Web Service. The XML Web Service is designed to provide a method of
communication to the ERPS database for both NT and non-NT platforms.
The following pages describe the various data types that are used for the web service application. It
is also possible to display the data types and schema used in the application by loading the ERPS
WebService.asmx page in your browser, and clicking the service description hyperlink.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 12 of 126
Electronic Receivable Payment services
SECTION TWO – DATA TYPES
Data Types
Bank Related
BankInform ation
FieldName Size Description
ABA 9 Unique ID that identifies the customer record.
AbbrName 50
Street 40
City 30
State 2
PhoneNumber 10
Notes 255
LastUpdate 8 Last update of notes.
UserName 16 Username of last notes update.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 13 of 126
Electronic Receivable Payment services
SECTION TWO – DATA TYPES
Check Related
CheckTransaction
FieldName Size REQ Description
ABA 9 X
AccountNumber 20 X
ACHEntryClass 3
AdditionalPrincipal Decimal
Amount Decimal X No dollar sign; commas & decimal point
AuthorizationRequired Boolean Authorization Required.
Accepted values:
‘0’ = false, ‘1’ = true OR ‘false’ / ‘true’ (case sensitive).
AuthorizationStationID 16 X Required only for AuthorizeCheckTransaction.
BankCity 30 Input ignored.
BankName 50 Input ignored.
BankState 2 Input ignored.
BatchID int Input ignored.
CheckDate 10 X Date format is mm/dd/yyyy (ex: 11/28/2002)
CheckType 1 Check Type (P)ersonal or (B)usiness.
City 25
ConfrimationLetterPrinted Boolean Input ignored.
Accepted values:
‘0’ = false, ‘1’ = true OR ‘false’ / ‘true’ (case sensitive).
ConfirmationLetterRequested Boolean Accepted values:
‘0’ = false, ‘1’ = true OR ‘false’ / ‘true’ (case sensitive).
CustomerID 32 Optional customer supplied field.
DatePrinted 10 Input ignored.
DatePosted 10 Input ignored.
DateSettled 10 Input ignored.
DOB 10 Date of Birth.
DriversLicense 24 Drivers License.
DriversLicenseState 2 Drivers License State.
EmailAddress 64 Email Address.
Fee Decimal Optional check fee field.
FeeDatePrinted 10 Input ignored.
FeePrinted Boolean Input ignored. (true/false).
Frozen Boolean Input ignored. (true/false).
GroupID int Input ignored.
IsCredit Boolean Input ignored. (true/false).
LocationID 4 Location ID.
Memo 40
MICRNumberAlignment 1 R, C, L for right, left or center MICR styles. (R: default).
Name1 35
Name2 35
Number 10 Check Number
OriginalDebitRecordNumber int Record number of the original debit. Only valid for credit
transactions. Defaults to 0, read only.
PaymentProfileID int Input ignored. Internal use only.
PaymentProfileName 64
PayToName 40 “Pay to” name string. (Blank will default to current
setting)
PhoneNumber 10 Phone Number.
Printed Boolean Check Printed
Accepted values:
‘0’ = false, ‘1’ = true OR ‘false’ / ‘true’ (case sensitive).
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 14 of 126
Electronic Receivable Payment services
SECTION TWO – DATA TYPES
CheckAuthorizationInform ation
FieldName Size Description
AuthorizationApprovalCode 16 Input ignored.
AuthorizationResponseCode 4 Input ignored.
AuthorizationResponseText 128 Input ignored.
AuthorizationStatus 1 Input ignored.
AuthorizationTime 8 Input ignored.
CheckCreditTransaction
FieldName Size Req Description
OriginalDebitRecordNumber int X Record number of the original debit to be credited.
Amount Decimal X Amount of the credit. No dollar sign; commas & decimal
point
CheckDate 10 X Date the credit is to be issued. Date format is
mm/dd/yyyy (ex: 11/28/2002)
UseAlternateABAAccountNumber Boolean Defaults to false. Use the alternate ABA & Account
number designated in the credit options section of the
browser.
Accepted values:
‘0’ = false, ‘1’ = true OR ‘false’ / ‘true’ (case sensitive).
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 15 of 126
ACH Related
ACHR eturnsInform ation
FieldName Size Description
Recnum int
Created 19
ImmediateDestination 10
ImmediateDestinationName 23
ImmediateOrigin 10
ImmediateOriginName 23
ReferenceCode 8
ServiceClassCode 3
CompanyName 16
CompanyDiscretionaryData 20
CompanyIdentification 10
StandardEntryClass 3
CompanyEntryDescription 10
CompanyDescriptiveDate 10
EffectiveEntryDate 10
SettlementDate 10
OriginatorStatusCode 1
OriginatingDFI 9
BatchNumber 7
TransactionCode 2
ReceivingDFI 9
AccountNumber 17
Amount Decimal
IndividualIdentificationNumber 15
IndividualName 22
DiscretionaryData 2
EntryTraceNumber 15
AddendaTypeCode 2
ReturnReasonCode 3
OriginalEntryTraceNumber 15
DateOfDeath 10
OrigReceivingDFIIdentification 9
AddendaInformation 44
AddendaTraceNumber 15
ProcessedFlag 1
Processed 19
ACHInform ation
FieldName Size Description
IsACHABA Boolean Returns true if ACHable, false if not.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 16 of 126
CreditCardTransaction
FieldName Size REQ Description
Amount Decimal X No dollar sign; No commas - Decimal point only ex 1.00.
Ignored if TransactionType = 6 (credit).
CardNumber 20 X Credit card Number. Ignored if TransactionType = 6 (credit).
City 25 Ignored if TransactionType = 6 (credit).
ConfirmationLetterRequested Boolean Indicates whether a confirmation letter will be printed for this
transaction. Works in conjuction with
CCConfirmationLetterRequired function.
CreatedDate 10 Read Only. Date transaction was created.
CustomerID 32 Ignored if TransactionType = 6 (credit).
CVV2 4 Ignored if TransactionType = 6 (credit).
CVV2PresenceIndicator 1 Ignored if TransactionType = 6 (credit). (0 = Not Provided, 1
= Provided, 2 = Value not legible, 3 = Data not available)
ExpirationDate 4 X Expiration Date MMYY. Ignored if TransactionType = 6
(credit).
EmailAddress 64 Email Address.
Fee Decimal Fee to be charged in addition to transaction amount.
FirstName 35 Ignored if TransactionType = 6 (credit).
GroupID Long Read Only. Input ignored.
LastName 35 Ignored if TransactionType = 6 (credit).
Memo 64 Ignored if TransactionType = 6 (credit).
MiddleInitial 1 Ignored if TransactionType = 6 (credit).
OrderNumber 20
PaymentProfileID Int Input ignored. Internal use only.
PaymentProfileName 64
PaytoName 40 “Pay to” name string. (Blank will default to current
setting)
RecordNumber Long Read only
ReferenceCode 32 Ignored if TransactionType = 6 (credit).
RequestorName 16 Username of person entering transaction. Ignored if
TransactionType = 6 (credit).
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 17 of 126
Electronic Receivable Payment services
SECTION TWO – DATA TYPES
SalesTax Decimal Sales Tax. No dollar sign; commas - Decimal point only ex
1.00. Ignored if TransactionType = 6 (credit).
Splits N/A Array of split elements, (complex type) see Splits Section.
State 2 Ignored if TransactionType = 6 (credit).
Street 40 Ignored if TransactionType = 6 (credit).
Submitted Boolean Input ignored. (true/false) Indicates whether or not the
transaction was submitted. true indicates that the processor
returned an error message. Only returned if Status = true.
TransactionDate 10
TransactionSource 1 ERPS product that created the transaction: (Internal Use
Only)
WebService = "W" (default value)
TransactionSourceVRU = "V"
UDK1 8 User definable key 1. Ignored if TransactionType = 6 (credit).
UDK2 16 User definable key 2. Ignored if TransactionType = 6 (credit).
UDK3 32 User definable key 3. Ignored if TransactionType = 6 (credit).
UDK4 512 User definable key 4.
UDK5 512 User definable key 5.
UDK6 int User definable key 6.
ZipCode 5 Ignored if TransactionType = 6 (credit).
ProcessingType 1 C = Credit, D = Debit, A = AutoRoute. Ignored if
TransactionType = 6 (credit).
CardHolderInform ation
FieldName Size Description
CreditCardNumber 20 Credit card number on file. Read only.
ExpirationDate 4 Expiration Date. Read Only.
CardType 10 Numeric representation of credit card type. Read Only.
Visa = 1
Mastercard = 2
Amex = 3
Discover = 4
Diners = 5
JCB = 6
Debit = 7
Carte_Blanche = 8
FirstName 35 First name. Read only.
MiddleInitial 1 Fiddle initial. Read only.
LastName 34 Last name. Read only.
BillingStreet 40 Street address. Read only.
BillingCity 25 City. Read only.
BillingState 2 State. Read only.
BillingZip 9 ZIP. Read only.
IsPINLessCapable Boolean Input ignored. (true/false) Indicates whether or not the the
card number is Pinless Capable.
IsDebitCard Boolean Input ignored. (true/false) Indicates whether or not the card
number is a Debit card.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 18 of 126
PaymentType 1 X Type of Payment Profile. Valid values are “A” for ACH, and
“C” for credit cards.
AccountNumber 20 X ACH or credit card account number.
ABA 9 Required for ACH transactions, ignored for credit card
transactions
Name1 35 Required for ACH transactions, not used for credit card
transactions
Name2 35 Optional for ACH transactions. Used for joint checking
accounts, but not required for an ACH transaction. Not
used for credit card transactions.
FirstName 35 Optional for credit card transactions. Not used for ACH
transactions.
MiddleInitial 1 Optional for credit card transactions. Not used for ACH
transactions.
LastName 35 Optional for credit card transactions. Not used for ACH
transactions.
CheckProfileType 1 Required for check transactions only, ignored for credit
card transactions. Valid values are “B” = Business, “P” =
Personal.
ExpirationDate 4 Required for credit card profiles only, not used for ACH
transactions. “MMYY” format.
ProcessingType 1 Required for credit card transactions only to indicate
whether the transaction is a to be processed as debit or
credit card. Valid values are “D” = Debit, “C” = Credit.
SavingsAccount Boolean
State 2 State.
City 25 City.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 19 of 126
Customer Related
Custom erRecord
FieldName Size REQ Description
ABA 9 X
AccountNumber 20 X
BillingCity 25
BillingState 2
BillingStreet 40
BillingZipCode 5
CheckType 1
City 25 X
CreatedDate 10 X
CreditCardExpirationDate 4 Expiration Date (MMYY)
CreditCardNumber 20
CurrentBalance Decimal
CustomerID 32 X
DefaultAddress 1
DOB 10 Date format is mm/dd/yyyy (ex: 11/28/1997)
DriversLicense 24
DriversLicenseState 2
EmailAddress 64
FirstName 25 X
HomePhoneNumber 10
LastModifiedDate 10 X Read Only.
LastName 25 X
LastPaymentAmount Decimal Read Only.
LastPaymentDate 10 Read Only.
Memo 32
MICRNumberAlignment 1
MiddleInitial 1
MinimumPayment Decimal
MostRecentBill Read Only. See BillInformation
Name1 35 X
Name2 35
Notes 255
NotificationSettings Read Only. See NotificationSettings
PaperEnrolled
PaytoName 40
PIN 16 Customer Personal ID
RecurringPayment Read Only. See RecurringPaymentInformation
ReferenceCode 32
Street 40 X
State 2 X
ShippingCity 25
ShippingStreet 40
ShippingState 2
ShippingZipCode 5
SSN 9 Social Security Number
TransactionType 4 Optional Field Associated with the account number.
UDK1 8 User definable key 1
UDK2 16 User definable key 2
UDK3 32 User definable key 3
UDK4 512 User definable key 4.
UDK5 512 User definable key 5.
UDK6 int User definable key 6.
WorkPhoneNumber 10
ZipCode 5 X
PaymentProfiles Read Only. Array of PaymentProfile elements, (complex
type) see PaymentProfiles Section.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 20 of 126
General
AuthenticationInform ation
FieldName Size REQ Description
UserName 16 X Valid username that has access to the ERPS application.
Password 16 X Valid Password.
TransactionID 10 Unique identifier used to identify the transaction to the
application that posted the transaction.
ClientID 16 X ClientID that uniquely identifies the client in ERPS
datacenter.
ErrorInform ation
FieldName Size Description
Text 255 Only returned if Status = false
Number int Only returned if Status = false
GeneralInform ation
FieldName Size Description
Version 10 Version number of the message returned. This will change with new
releases of the web service. Format: MajorVersion.MinorVersion.Build
TransactionID 10 Unique identifier used to identify the transaction to the application that
posted the transaction. Must match the task ID in the original message.
TimeStamp 22 Timestamp of transaction.
OptionInform ation
FieldName Size Description
OptionName 64
OptionValue 128
OptionsInform ation
FieldName Description
Option Name/Value DataSet This DataSet will contain the same DataTable passed into the method, except it
will contain a second column named “OptionValue”. Each row containing an
Option Name will have its corresponding value in the OptionValue column.
R eceiptInform ation
FieldName Size Description
RecordNumber int
StatusInform ation
FieldName Size Description
Status Boolean true = Success; false = Failed
ConvenienceFeeInform ation
FieldName Size Description
ConvenienceFee Decimal
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 21 of 126
BlockABAAccountInform ation
FieldName Size Req Description
ABA 9 X ABA routing number.
AcountNumber 20 X Account number to block in a future transaction.
Reason 255 X Reason for this ABA and account number is being
blocked.
Comments 255 Additional comments.
UserName 16 User blocking account number, defaults to the current
logged in user if not sent.
ProgrammaticRequest Boolean Defaults to false, which indicates that this addition was
performed interactively by a user. True indicates that this
insertion was performed by an automated process.
BlockCreditCardInform ation
FieldName Size Req Description
CreditCardNumber 20 X Account number to block in a future credit card
transaction.
Reason 255 X Reason for this ABA and account number is being
blocked.
Comments 255 Additional comments.
UserName 16 User blocking account number, defaults to the current
logged in user if not sent.
ProgrammaticRequest Boolean Defaults to false, which indicates that this addition was
performed interactively by a user. True indicates that this
insertion was performed by an automated process.
BlockFieldValueInform ation
FieldName Size Req Description
Field Fixed X Name of the field to be blocked, must be one of the
following:
CustomerID
ReferenceCode
UDK1
UDK2
UDK3
FieldValue 64 X Value to be blocked
Reason 255 X Reason for this field value to be blocked
Comments 255 Additional comments
UserName 16 User blocking account number. Defaults to the current
logged in user if not sent
ProgrammaticRequest Boolean Defaults to false, which indicates that this addition was
performed interactively by a user. True indicates that this
insertion was performed by an automated process.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 22 of 126
Electronic Receivable Payment services
SECTION TWO – DATA TYPES
UserAccountInform ation
FieldName Size Description
AccountLockedOut ReadOnly
ActivationStatus Fixed “A” for “Active”, “I” for “Inactive”, or “P” for “Pending”
CreatedBy ReadOnly
CreatedDate ReadOnly
Customers Read Only. Array of Customer elements linked to UserAccount,
(complex type) see CustomerRecord Section.
ID
Email Address
InvalidAttempts ReadOnly
LastAuthenticationDate ReadOnly
LastModifiedDate ReadOnly
Name
NotificationSettings Read Only. See NotificationSettings Section.
Password WriteOnly
PaymentProfiles Read Only. Array of PaymentProfile elements, (complex type) see
PaymentProfiles Section.
NotificationSettings
FieldName Size Description
BillReminder Boolean
EmailAddress
EmailNotification Boolean
EmailType
LastEmailNotificationSent ReadOnly
MobileNotification Boolean
MobileNumber
LastMobileNotificationSent ReadOnly
NotificationSettingsID ReadOnly
PaymentConfirmationNotification Boolean
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 23 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 24 of 126
Response Types
BankR esponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See BankInformation
CheckR esponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See ReceiptInformation
See CheckTransaction
See CheckAuthorizationInformation
GetCheckTransactionsR esponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See CheckTransaction This section occurs for each transaction that is returned.
GetLastACHReturnR esponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See ACHReturnsInformation
IsACHABAR esponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See ACHInformation
BlockAABAAccountResponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
IsBlocked Boolean to indicate if the ABA and account number combination is
blocked from future use.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 25 of 126
Electronic Receivable Payment services
SECTION TWO – DATA TYPES
BlockCreditCardResponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
IsBlocked Boolean to indicate if the credit card account is blocked from
future use.
BlockFieldValueResponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
IsBlocked Boolean to indicate if the field and value combination is blocked
from future use.
IsValidCreditCardR esponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
IsValid Boolean to indicate if this credit card number is valid.
CreditCardResponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See ReceiptInformation
See CreditCardTransaction
See CreditCardAuthorizationInformation
ConvenienceFeeResponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See ConvenienceFeeInformation
GetCreditCardTransactionsResponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See CreditCardTransaction This section occurs for each transaction that is returned.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 26 of 126
CardHolderR esponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See CardHolderInformation This section occurs for each transaction that is returned.
Custom erResponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See CustomerRecord
OptionResponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See OptionInformation
OptionsResponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See OptionsInformation This section occurs for each option that is returned.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 27 of 126
BillsResponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See BillInformation This section occurs for each Bill that is returned.
UserAccountR esponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See ReceiptInformation
See UserAccountInformation
R ecurringPaym entResponse
FieldName Description
See GeneralInformation
See StatusInformation
See ErrorInformation
See ReceiptInformation
See RecurringPaymentInformation
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 28 of 126
Message Types
There are two basic message types the Web Service will process, edit and retrieval messages. The edit
message types include (AddCheckTransaction, DeleteCheckTransaction, AuthorizeCheckTransaction,
AddCheckCreditTransaction, AddCustomerRecord, UpdateCustomerRecord, DeleteCustomerRecord,
AddCreditCardTransaction, AddCreditCardCreditTransaction, VoidCreditCardTransaction, and
ReverseCreditCardTransaction). The retrieval message types include (GetCheckTransaction,
GetCustomerRecord, GetBankInformation, GetCreditCardTransaction, IsACHABA, GetLastACHReturn,
and GetOptionValue). The edit messages perform Insert and Delete data in the Electronic Receivable
Payment services (ERPS) database. The retrieval messages are for inquiry purposes only. More detail
regarding these message types can be found in this section.
The following is a list of messages that are supported by the XML Web Service.
Command Description
AddCheckTransaction Add a check to the ERPS database.
AuthorizeCheckTransaction Add a check to the ERPS database and authorize it.
DeleteCheckTransaction Removes a check from the ERPS database for a supplied record
number.
GetCheckTransaction Get check information for the supplied record number.
GetCheckTransactions Get check transactions for the supplied CustomerID.
AddCheckCreditTransaction Adds a check credit to the ERPS database.
GetCreditCard Get information on the credit card holder by account number.
CalculateConvenienceFee Calculate the convenience fee for a transaction.
AddCreditCardTransaction Add a credit card transaction to the ERPS database.
GetCardHolderInformation Get card holder information by card numer.
GetCreditCardTransaction Get credit card information for the supplied record number.
GetCreditCardTransactions Get credit card transactions for the supplied CustomerID.
VoidCreditCardTransaction Void a transaction for the supplied record number.
ReverseCreditCardTransaction Reverse a transaction for the supplied record number.
AddCreditCardCreditTransaction Adds a credit card credit transaction to the ERPS database.
AddCustomerRecord Add a customer to the ERPS database.
GetCustomerRecord Get customer data for the supplied CustomerID.
DeleteCustomerRecord Removes a customer from the ERPS database for a supplied
CustomerID.
UpdateCustomerRecord Updates a customer record in the ERPS database.
GetBankInformation Get detailed bank information for the supplied bank ABA number.
GetOptionValue Get option value for a supplied option name.
GetOptionValues Get multiple option values for supplied option names.
IsACHABA Checks to see if the provided ABA number has information on file
to indicate if the banking institution can process ACH transactions.
GetLastACHReturn Returns the latest ACH return record for the record number or
ABA/Account number combination passed.
BlockABAAccountNumber Block an ABA and account number combination from being used
again.
UnBlockABAAccountNumber Change the status of a blocked ABA/account number combination.
IsABAAccountNumberBlocked Checks ABA and account number combination and indicates if it is
blocked.
BlockCreditCardNumber Block a credit card number from being used again.
UnblockCreditCardNumber Change the status of a blocked credit card number combination.
IsCreditCardNumberBlocked Checks credit card and indicates if it is blocked.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 29 of 126
Electronic Receivable Payment services
SECTION FOUR – MESSAGE TYPES
The following is a list of messages that are supported by the XML Web Service for EBPP and Embedded
Support.
Command Description
AddBill Add a bill to the ERPS database.
GetBill Get bill information for the supplied Bill ID.
UpdateBill Update bill information for the supplied Bill ID.
DeleteBill Delete bill from the ERPS database.
GetBills Get a collection of Bills for the supplied Customer ID.
GetBillHTML Get HTML version of a bill for the supplied Bill ID.
GetBillPDF Get PDF version of a bill for the supplied Bill ID.
AddUserAccount Add a User Account to the ERPS database.
GetUserAccount
DeleteUserAccount
UpdateUserAccount
LinkCustomertoUserAccount
UnlinkCustomertoUserAccount
AddRecurringPayment
GetRecurringPayment
DeleteRecurringPayment
UpdateRecurringPayment
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 30 of 126
Each command has two parts, a post and a response. Both parts for each message are documented in
the following sections.
AddCheckTransaction
M essage
The following table represents data that can be posted using the AddCheckTransaction message.
FieldName REQ Description
See AuthenticationInformation X
See CheckTransaction X
R esponse
The following table represents the message returned from the web service in response to an
AddCheckTransaction message.
FieldName Description
See CheckResponse CheckTransaction and CheckAuthorizationInformation will not be present.
AuthorizeCheckTransaction
M essage
The following table represents data that can be posted using the AuthorizeCheckTransaction message.
FieldName REQ Description
See AuthenticationInformation X
See CheckTransaction X
R esponse
The following table represents data that can be posted using the AuthorizeCheckTransaction message.
FieldName Description
See CheckResponse CheckTransaction will not be present.
M essage
The following table represents data that can be posted using the AuthorizeCheckTransaction message.
FieldName REQ Description
See AuthenticationInformation X
See CheckTransaction X
RecordNumber X int
R esponse
The following table represents data that can be posted using the AuthorizeCheckTransaction message.
FieldName Description
See CheckResponse CheckTransaction will not be present.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 31 of 126
M essage
The following table represents data that can be posted using the AuthorizeCheckTransaction message.
FieldName REQ Description
See AuthenticationInformation X
RecordNumber X int
R esponse
The following table represents data that can be posted using the AuthorizeCheckTransaction message.
FieldName Description
See CheckResponse CheckTransaction will not be present.
GetCheckTransaction
M essage
The following table represents GetCheckTransaction message.
FieldName REQ Size Description
See AuthenticationInformation X
RecordNumber X Integer
R esponse
The following table represents the message returned from the web service in response to a
GetCheckTransaction message.
FieldName Description
See CheckResponse ReceiptInformation will not be present. CheckAuthorizationInformation will
not be present if the check is a Credit.
GetCheckTransactions
M essage
The following table represents GetCheckTransactions message.
FieldName REQ Size Description
See AuthenticationInformation X
FieldName X 5 Field name for field value lookup. Currently only ‘CustomerID’
is supported.
FieldValue X 15 Field value for the corresponding field name.
R esponse
The following table represents the message returned from the web service in response to a
GetCheckTransactions message.
FieldName Description
See GetCheckTransactionsResponse
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 32 of 126
DeleteCheckTransaction
M essage
The following table represents DeleteCheckTransaction message.
FieldName REQ Size Description
See AuthenticationInformation X
RecordNumber X Integer
R esponse
The following table represents the message returned from the web service in response to a
DeleteCheckTransaction message.
FieldName Description
See CheckResponse CheckTransaction, CheckAuthorizationInformation, and ReceiptInformation will
not be present.
AddCheckCreditTransaction
M essage
The following table represents data that can be posed using the AddCheckCreditTransaction message.
FieldName REQ Description
See AuthenticationInformation X
See CheckCreditTransaction X
R esponse
The following table represents the message returned from the web service in response to an
AddCheckCreditTransaction message.
FieldName Description
See CheckResponse CheckTransaction, CheckAuthorizationInformation, and ReceiptInformation will
not be present.
AddCreditCardTransaction
M essage
The following table represents AddCreditCardTransaction message.
FieldName REQ Description
See AuthenticationInformation X
See CreditCardTransaction X
R esponse
The following table represents the message returned from the web service in response to an
AddCreditCardTransaction message.
FieldName Description
See CreditCardResponse CreditCardTransaction will not be present.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 33 of 126
M essage
The following table represents AddCreditCardTransaction message.
FieldName REQ Description
See AuthenticationInformation X
See CreditCardTransaction X
Recnum X int
R esponse
The following table represents the message returned from the web service in response to an
AddCreditCardTransaction message.
FieldName Description
See CreditCardResponse CreditCardTransaction will not be present.
M essage
The following table represents AddCreditCardTransaction message.
FieldName REQ Description
See AuthenticationInformation X
Recnum X int
R esponse
The following table represents the message returned from the web service in response to an
AddCreditCardTransaction message.
FieldName Description
See CreditCardResponse CreditCardTransaction will not be present.
GetCreditCard
M essage
The following table represents GetCreditCard message.
FieldName REQ Size Description
See AuthenticationInformation X
CreditCardNumber X 20 Credit card number to be used to retrieve card holder
information.
R esponse
The following table represents the message returned from the web service in response to a
GetCreditCard message.
FieldName Description
See CardHolderResponse Card holder information on file.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 34 of 126
CalculateConvenienceFee
Message
The following table represents CalculateConvenienceFee message.
FieldName REQ Size Description
See AuthenticationInformation X
PayToName X
Amount X Decimal
Response
The following table represents the message returned from the web service in response to
a CalculateConvenienceFee message.
FieldName Description
See ConvenienceFeeResponse Convenience Fee Information.
GetCreditCardTransaction
M essage
The following table represents GetCreditCardTransaction message.
FieldName REQ Size Description
See AuthenticationInformation X
RecordNumber X Integer
R esponse
The following table represents the message returned from the web service in response to a
GetCreditCardTransaction message.
FieldName Description
See CreditCardResponse ReceiptInformation will not be present
GetCreditCardTransactions
M essage
The following table represents GetCreditCardTransactions message.
FieldName REQ Size Description
See AuthenticationInformation X
FieldName X 5 Field name for field value lookup. Currently only ‘CustomerID’
is supported.
FieldValue X 15 Field value for the corresponding field name.
R esponse
The following table represents the message returned from the web service in response to a
GetCreditCardTransactions message.
FieldName Description
See GetCreditCardTransactionsResponse
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 35 of 126
VoidCreditCardTransaction
M essage
The following table represents VoidCreditCardTransaction message.
FieldName REQ Size Description
See AuthenticationInformation X
RecordNumber X Integer Record number of the transaction to be voided.
R esponse
The following table represents the message returned from the web service in response to a
VoidCreditCardTransaction message.
FieldName Description
See CreditCardResponse CreditCardTransaction will not be present.
ReverseCreditCardTransaction
M essage
The following table represents ReverseCreditCardTransaction message.
FieldName REQ Size Description
See AuthenticationInformation X
RecordNumber X Integer Record number of the transaction to be reversed.
R esponse
The following table represents the message returned from the web service in response to a
ReverseCreditCardTransaction message.
FieldName Description
See CreditCardResponse CreditCardTransaction will not be present.
M essage
The following table represents AddCreditCardCreditTransaction message.
FieldName REQ Size Description
See AuthenticationInformation X
RecordNumber X Integer Record number of the transaction to be credited.
CreditAmount X Decimal
R esponse
The following table represents the message returned from the web service in response to a
AddCreditCardCreditTransaction message.
FieldName Description
See CreditCardResponse
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 36 of 126
M essage
The following table represents AddCreditCardCreditTransaction message.
FieldName REQ Size Description
See AuthenticationInformation X
RecordNumber X Integer Record number of the transaction to be credited.
R esponse
The following table represents the message returned from the web service in response to a
AddCreditCardCreditTransaction message.
FieldName Description
See CreditCardResponse
GetCardHolderInformation
M essage
The following table represents GetCardHolderInformation message.
FieldName REQ Size Description
See AuthenticationInformation X
CreditCardNumber X 20 Credit card number to be used to retrieve card holder
information.
R esponse
The following table represents the message returned from the web service in response to a
GetCardHolderInformation message.
FieldName Description
See CardHolderResponse Card holder information on file.
AddCustomerRecord
M essage
The following table represents AddCustomerRecord message.
FieldName REQ Description
See AuthenticationInformation X
See CustomerRecord X
R esponse
The following table represents the message returned from the web service in response to an
AddCustomerRecord message.
FieldName Description
See CustomerResponse CustomerRecord will not be present.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 37 of 126
UpdateCustomerRecord
M essage
The following table represents UpdateCustomerRecord message.
FieldName REQ Description
See AuthenticationInformation X
See CustomerRecord X Empty fields will not be updated.
R esponse
The following table represents the message returned from the web service in response to an
UpdateCustomerRecord message.
FieldName Description
See CustomerResponse CustomerRecord will not be present.
GetCustomerRecord
M essage
The following table represents the GetCustomerRecord message.
FieldName REQ Size Description
See AuthenticationInformation X
CustomerID X 32
R esponse
The following table represents the message returned from the web service in response to a GetCustomerRecord
message.
FieldName Description
See CustomerResponse
DeleteCustomerRecord
M essage
The following table represents the DeleteCustomerRecord message.
FieldName REQ Size Description
See AuthenticationInformation X
CustomerID X 32
R esponse
The following table represents the message returned from the web service in response to a
DeleteCustomerRecord message.
FieldName Description
See CustomerResponse CustomerRecord will not be present.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 38 of 126
M essage
FieldName REQ Size Description
See AuthenticationInformation X
Recnum X int Check record number to be used to query for returns. Overrides
ABA and Account Number lookup.
R esponse
FieldName Description
See GetLastACHReturnResponse
M essage
FieldName REQ Size Description
See AuthenticationInformation X
ABA X 9 ABA Required when account number passed.
AccountNumber X 17 Account number required when ABA is passed.
R esponse
FieldName Description
See GetLastACHReturnResponse
IsACHABA
M essage
FieldName REQ Size Description
See AuthenticationInformation X
ABA X 9
R esponse
FieldName Description
See IsACHABAResponse
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 39 of 126
AddPaymentProfile
M essage
The following table represents AddPaymentProfile message.
FieldName REQ Description
See AuthenticationInformation X
See PaymentProfileInformation X
R esponse
The following table represents the message returned from the web service in response to an
AddPaymentProfile message.
FieldName Description
See PaymentProfileResponse PaymentProfileInformation will not be present.
GetPaymentProfile
M essage
FieldName REQ Size Description
See AuthenticationInformation X
PaymentProfileName X 64 Unique PaymentProfile name (per CustomerID)
CustomerID X 32 CustomerID
R esponse
FieldName Description
See PaymentProfileResponse PaymentProfileInformation will be populated.
M essage
FieldName REQ Size Description
See AuthenticationInformation X
PaymentID X 32 Unique PaymentProfileID
R esponse
FieldName Description
See PaymentProfileResponse PaymentProfileInformation will be populated.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 40 of 126
DeletePaymentProfile
M essage
The following table represents the DeleteCustomerRecord message.
FieldName REQ Size Description
See AuthenticationInformation X
PaymentProfileName X 64 Unique PaymentProfile name (per CustomerID)
CustomerID X 32 CustomerID
R esponse
The following table represents the message returned from the web service in response to a
DeletePaymentProfile message.
FieldName Description
See PaymentProfileResponse PaymentProfile will not be present.
M essage
The following table represents the DeleteCustomerRecord message.
FieldName REQ Size Description
See AuthenticationInformation X
PaymentProfileID X 32 Unique PaymentProfileID
R esponse
The following table represents the message returned from the web service in response to a
DeletePaymentProfile message.
FieldName Description
See PaymentProfileResponse PaymentProfile will not be present.
UpdatePaymentProfile
M essage
The following table represents UpdatePaymentProfile message.
FieldName REQ Description
See AuthenticationInformation X
See PaymentProfileInformation X Empty fields will not be updated.
R esponse
The following table represents the message returned from the web service in response to an
UpdatePaymentProfile message.
FieldName Description
See PaymentProfileResponse PaymentProfile will not be present.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 41 of 126
BlockABAAcountNumber
M essage
FieldName REQ Size Description
See AuthenticationInformation X
See X
BlockABAAccountInformation
R esponse
FieldName Description
See
BlockABAAccountResponse
UnBlockABAAccountNumber
M essage
FieldName REQ Size Description
See AuthenticationInformation X
See X
BlockABAAccountInformation
R esponse
FieldName Description
See
BlockABAAccountResponse
IsABAAccountNumberBlocked
M essage
FieldName REQ Size Description
See AuthenticationInformation X
ABA X 9
AccountNumber X 20
R esponse
FieldName Description
See
BlockABAAccountResponse
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 42 of 126
BlockCreditCardNumber
M essage
FieldName REQ Size Description
See AuthenticationInformation X
See X
BlockCreditCardInformation
R esponse
FieldName Description
See BlockCreditCardResponse
UnBlockCreditCardNumber
M essage
FieldName REQ Size Description
See AuthenticationInformation X
See X
BlockCreditCardInformation
R esponse
FieldName Description
See BlockCreditCardResponse
IsCreditCardNumberBlocked
M essage
FieldName REQ Size Description
See AuthenticationInformation X
CreditCardNumber X 20
R esponse
FieldName Description
See
BlockABAAccountResponse
IsABAAccountNumberValid
M essage
FieldName REQ Size Description
See AuthenticationInformation X
ABA X 9
AccountNumber X 20
R esponse
FieldName Description
See
IsABAAccountNumberValidResponse
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 43 of 126
M essage
FieldName REQ Size Description
See AuthenticationInformation X
CreditCardNumber X 20
R esponse
FieldName Description
See IsValidCreditCardResponse
M essage
FieldName REQ Size Description
See AuthenticationInformation X
CreditCardNumber X 20
PaytoName X 40
R esponse
FieldName Description
See IsValidCreditCardResponse
BlockFieldValue
M essage
FieldName REQ Size Description
See AuthenticationInformation X
See X
BlockFieldValueInformation
R esponse
FieldName Description
See BlockFieldValueResponse
UnblockFieldValue
M essage
FieldName REQ Size Description
See AuthenticationInformation X
See X
BlockedFieldValueInformation
R esponse
FieldName Description
See BlockFieldValueResponse
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 44 of 126
IsFieldValueBlocked
M essage
FieldName REQ Size Description
See AuthenticationInformation X
Field X Fixed CustomerID
ReferenceCode
UDK1
UDK2
UDK3
R esponse
FieldName Description
See BlockFieldValueResponse
GetBankInformation
M essage
The following table represents GetBankInformation message.
FieldName REQ Size Description
See AuthenticationInformation X
ABA X 9
R esponse
The following table represents the message returned from the web service in response to a GetBankInformation
message.
FieldName Description
See BankResponse
GetOptionValue
M essage
The following table represents GetOptionValue message.
FieldName REQ Size Description
See AuthenticationInformation X
OptionName X 64 This value is case sensitive and has to match the Option Name
exactly.
R esponse
The following table represents the message returned from the web service in response to a GetOptionValue
message.
FieldName Description
See OptionResponse
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 45 of 126
GetOptionValues
M essage
The following table represents GetOptionValue message.
FieldName REQ Size Description
See AuthenticationInformation X
Option Name DataSet X This DataSet should include one DataTable. The DataTable
should include one Column with a row for each Option Name.
R esponse
The following table represents the message returned from the web service in response to a GetOptionValue
message.
FieldName Description
See OptionsResponse
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 46 of 126
EBPP Support
AddBill
M essage
The following table represents AddBill message.
FieldName REQ Description
See AuthenticationInformation X
See BillInformation X
R esponse
The following table represents the message returned from the web service in response to an AddBill
message.
FieldName Description
See BillResponse BillInformation will not be present.
GetBill
M essage
FieldName REQ Size Description
See AuthenticationInformation X
BillID X Unique BillID
R esponse
FieldName Description
See BillResponse BillInformation will be populated.
DeleteBill
M essage
The following table represents the DeleteCustomerRecord message.
FieldName REQ Size Description
See AuthenticationInformation X
BillID X Unique BillID
R esponse
The following table represents the message returned from the web service in response to a DeleteBill
message.
FieldName Description
See BillResponse BillInformation will not be present.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 47 of 126
UpdateBill
M essage
The following table represents UpdateBill message.
FieldName REQ Description
See AuthenticationInformation X
See BillInformation X Empty fields will not be updated.
R esponse
The following table represents the message returned from the web service in response to an
UpdateBill message.
FieldName Description
See BillResponse BillInformation will not be present.
GetBills
M essage
FieldName REQ Size Description
See AuthenticationInformation X
CustomerID X Unique CustomerID
R esponse
FieldName Description
See BillsResponse
GetBillHTML
M essage
FieldName REQ Size Description
See AuthenticationInformation X
BillID X Unique BillID
R esponse
FieldName Description
See BillRenderedResponse BillInformation will be populated.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 48 of 126
GetBillPDF
M essage
FieldName REQ Size Description
See AuthenticationInformation X
BillID X Unique BillID
PageWidth X
PageSize X
PageOrientation X
LeftMargin X
RightMargin X
TopMargin X
BottomMargin X
LiveUrlsEnabled X Boolean
AutoSizePDFImage X Boolean
EmbedFonts X Boolean
PageNumberText X
ShowPageNumber X Boolean
R esponse
FieldName Description
See BillRenderedResponse BillInformation will be populated.
AddUserAccount
M essage
The following table represents AddUserAccount message.
FieldName REQ Description
See AuthenticationInformation X
See UserAccountInformation X
R esponse
The following table represents the message returned from the web service in response to an
AddUserAccount message.
FieldName Description
See UserAccountResponse UserAccountInformation will not be present.
GetUserAccount
M essage
FieldName REQ Size Description
See AuthenticationInformation X
Name X Unique UserAccount Name
R esponse
FieldName Description
See UserAccountResponse UserAccountInformation will be populated.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 49 of 126
DeleteUserAccount
M essage
The following table represents the DeleteUserAccount message.
FieldName REQ Size Description
See AuthenticationInformation X
Name X Unique UserAccount Name
R esponse
The following table represents the message returned from the web service in response to a
DeleteUserAccount message.
FieldName Description
See UserAccountResponse UserAccountInformation will not be present.
UpdateUserAccount
M essage
The following table represents UpdateUserAccount message.
FieldName REQ Description
See AuthenticationInformation X
See UserAccountInformation X Empty fields will not be updated.
R esponse
The following table represents the message returned from the web service in response to an
UpdateUserAccount message.
FieldName Description
See UserAccountResponse UserAccountInformation will not be present.
LinkCustomerToUserAccount
M essage
The following table represents LinkCustomerToUserAccount message.
FieldName REQ Description
See AuthenticationInformation X
UserAccountName X Unique UserAccountName
CustomerID X Unique CustomerID
R esponse
The following table represents the message returned from the web service in response to an
LinkCustomerToUserAccount message.
FieldName Description
See LinkCustomerToUserAccountResponse
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 50 of 126
UnLinkCustomerToUserAccount
M essage
The following table represents LinkCustomerToUserAccount message.
FieldName REQ Description
See AuthenticationInformation X
UserAccountName X Unique UserAccountName
CustomerID X Unique CustomerID
R esponse
The following table represents the message returned from the web service in response to an
LinkCustomerToUserAccount message.
FieldName Description
See UnLinkCustomerToUserAccountResponse
AddRecurringPayment
M essage
The following table represents AddRecurringPayment message.
FieldName REQ Description
See AuthenticationInformation X
See RecurringPaymentInformation X
CustomerID X Unique CustomerID
R esponse
The following table represents the message returned from the web service in response to an
AddRecurringPayment message.
FieldName Description
See RecurringPaymentResponse RecurringPaymentInformation will not be present.
GetRecurringPayment
M essage
FieldName REQ Size Description
See AuthenticationInformation X
CustomerID X Unique CustomerID
R esponse
FieldName Description
See RecurringPaymentResponse RecurringPaymentInformation will be populated.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 51 of 126
DeleteRecurringPayment
M essage
The following table represents the DeleteRecurringPayment message.
FieldName REQ Size Description
See AuthenticationInformation X
CustomerID X Unique CustomerID
R esponse
The following table represents the message returned from the web service in response to a
DeleteRecurringPayment message.
FieldName Description
See RecurringPaymentResponse RecurringPaymentInformation will not be present.
UpdateRecurringPayment
M essage
The following table represents UpdateRecurringPayment message.
FieldName REQ Description
See AuthenticationInformation X
See RecurringPaymentInformation X Empty fields will not be updated.
CustomerID X Unique CustomerID
R esponse
The following table represents the message returned from the web service in response to an
UpdateRecurringPayment message.
FieldName Description
See RecurringPaymentResponse RecurringPaymentInformation will not be present.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 52 of 126
Programming Considerations
To post messages and parse responses programmatically, a program must be written to post and parse response
messages.
Example 1: The following section provides examples of a SOAP Request and Response involved in posting
messages and obtaining the response message.
Example: Request
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetBankInformation xmlns="http://webservice.cleartran.net/">
<objAuthentication>
<UserName>UserName1</UserName>
<Password>Password1</Password>
<TransactionID>12455</TransactionID>
<ClientID>112233</ClientID>
</objAuthentication>
<ABA>021200012</ABA>
</GetBankInformation>
</soap:Body>
</soap:Envelope>
Example: Response
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetBankInformationResponse xmlns="http://webservice.cleartran.net/">
<GetBankInformationResult>
<GeneralInformation>
<Version>6.3.1.0</Version>
<TransactionID>4564</TransactionID>
<TimeStamp>1/30/2003 12:18:02 PM</TimeStamp>
</GeneralInformation>
<StatusInformation>
<Status>true</Status>
</StatusInformation>
<ErrorInformation />
<BankInformation>
<ABA>021200012</ABA>
<AbbrName>PNC BANK, NATIONAL ASSOCIATION</AbbrName>
<Street>222 RIDGEWOOD AVE</Street>
<City>GLEN RIDGE</City>
<State>NJ</State>
<PhoneNumber>9732252424</PhoneNumber>
<LastUpdate>12:00:00 AM</LastUpdate>
</BankInformation>
</GetBankInformationResult>
</GetBankInformationResponse>
</soap:Body>
</soap:Envelope>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 53 of 126
Electronic Receivable Payment services
SECTION FIVE – PROGRAMMING CONSIDERATIONS
Example 2 & 3: The following section provides examples of VB .NET code involved in posting messages and
obtaining the response message. These samples assume a Web Reference has been added to ERPS WebService
named ctran.
Example: AddCheckTransaction
Dim R As ctran.ClearTranWebService = New ctran.ClearTranWebService()
Dim objAuthentication As New ctran.AuthenticationInformation()
Dim objCheck As New ctran.CheckTransaction()
objAuthentication.UserName = "UserName1"
objAuthentication.Password = "Password1"
objAuthentication.TransactionID = "45645"
objAuthentication.ClientID = "112233"
objCheck.ABA = "021200012"
objCheck.AccountNumber = "1123546"
objCheck.Amount = "5.65"
objCheck.CheckDate = "1/23/03"
objCheck.PaytoName = "ABC Company"
objCheck.City = "City"
objCheck.Name1 = "Name 1 "
objCheck.RequestorName = "M"
objCheck.State = "NJ"
objCheck.Street = "123 Test St."
objCheck.ZipCode = "07024"
Response: AddCheckTransaction
txtVersion.Text = MyResponse.GeneralInformation.Version
txtTransactionID.Text = MyResponse.GeneralInformation.TransactionID
txtTimeStamp.Text = MyResponse.GeneralInformation.TimeStamp
txtStatus.Text = MyResponse.StatusInformation.Status
txtRecordNumber.Text = MyResponse.ReceiptInformation.RecordNumber
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 54 of 126
Example: GetCheckTransaction
objAuthentication.UserName = "UserName1"
objAuthentication.Password = "Password1"
objAuthentication.TransactionID = "2245"
objAuthentication.ClientID = "112233"
intRecordNumber = "2980"
Response: GetCheckTransaction
txtVersion.Text = MyResponse.GeneralInformation.Version
txtTransactionID.Text = MyResponse.GeneralInformation.TransactionID
txtTimeStamp.Text = MyResponse.GeneralInformation.TimeStamp
txtStatus.Text = MyResponse.StatusInformation.Status
txtRecordNumber.Text = MyResponse.ReceiptInformation.RecordNumber
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 55 of 126
XML SCHEMA
The following section is the XML Schema for the ERPS WebService.
<?xml version="1.0" encoding="utf-8" ?>
- <wsdl:definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:tns="http://webservice.cleartran.net"
xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" targetNamespace="http://webservice.cleartran.net"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
- <wsdl:types>
- <s:schema elementFormDefault="qualified" targetNamespace="http://webservice.cleartran.net">
- <s:element name="UnLinkCustomerToUserAccount">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="UserAccountName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CustomerID" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="AuthenticationInformation">
- <s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="UserName" nillable="true" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="Password" nillable="true" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="TransactionID" nillable="true" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="ClientID" nillable="true" type="s:string" />
</s:sequence>
</s:complexType>
- <s:element name="UnLinkCustomerToUserAccountResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UnLinkCustomerToUserAccountResult"
type="tns:LinkCustomerToUserAccountResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="LinkCustomerToUserAccountResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="1" maxOccurs="1" name="IsLinked" type="s:boolean" />
</s:sequence>
</s:complexType>
- <s:complexType name="GeneralInformation">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="Version" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="TransactionID" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="TimeStamp" type="s:string" />
</s:sequence>
</s:complexType>
- <s:complexType name="StatusInformation">
- <s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="Status" type="s:boolean" />
</s:sequence>
</s:complexType>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 56 of 126
Electronic Receivable Payment services
SECTION SIX – ERROR AND RESPONSE CODES
- <s:complexType name="ErrorInformation">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="Text" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="Number" type="s:int" />
</s:sequence>
</s:complexType>
- <s:element name="AddRecurringPayment">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="objRecurringPayment"
type="tns:RecurringPaymentInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CustomerID" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="RecurringPaymentInformation">
- <s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="Amount" type="s:decimal" />
<s:element minOccurs="0" maxOccurs="1" name="CreatedDate" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="EndDate" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Interval" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="LastModifiedDate" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="LastPaymentDate" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="NumberOfPayments" type="s:int" />
<s:element minOccurs="1" maxOccurs="1" name="PaymentProfileID" type="s:int" />
<s:element minOccurs="1" maxOccurs="1" name="RecurringPaymentID" type="s:int" />
<s:element minOccurs="0" maxOccurs="1" name="RecurringType" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="RelativeDaysToDueDate" type="s:int" />
<s:element minOccurs="1" maxOccurs="1" name="RemainingPayments" type="s:int" />
<s:element minOccurs="0" maxOccurs="1" name="StartDate" type="s:string" />
</s:sequence>
</s:complexType>
- <s:element name="AddRecurringPaymentResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="AddRecurringPaymentResult"
type="tns:RecurringPaymentResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="RecurringPaymentResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ReceiptInformation" type="tns:ReceiptInformation" />
<s:element minOccurs="0" maxOccurs="1" name="RecurringPaymentInformation"
type="tns:RecurringPaymentInformation" />
</s:sequence>
</s:complexType>
- <s:complexType name="ReceiptInformation">
- <s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="RecordNumber" type="s:int" />
</s:sequence>
</s:complexType>
- <s:element name="GetRecurringPayment">
- <s:complexType>
- <s:sequence>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 57 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 58 of 126
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="BankResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="0" maxOccurs="1" name="BankInformation" type="tns:BankInformation" />
</s:sequence>
</s:complexType>
- <s:complexType name="BankInformation">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="ABA" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="AbbrName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Street" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="City" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="State" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="PhoneNumber" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Notes" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="LastUpdate" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="UserName" type="s:string" />
</s:sequence>
</s:complexType>
- <s:element name="GetCardHolderInformation">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CreditCardNumber" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="GetCardHolderInformationResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetCardHolderInformationResult"
type="tns:CardHolderResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="CardHolderResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CardHolderInformation" type="tns:CardHolderInformation"
/>
</s:sequence>
</s:complexType>
- <s:complexType name="CardHolderInformation">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CreditCardNumber" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ExpirationDate" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CardType" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="FirstName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="MiddleInitial" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="LastName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="BillingStreet" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="BillingCity" type="s:string" />
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 59 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 60 of 126
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetLastACHReturnByRecnumResult"
type="tns:GetLastACHReturnResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="GetLastACHReturnResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ACHReturnsInformation"
type="tns:ACHReturnsInformation" />
</s:sequence>
</s:complexType>
- <s:complexType name="ACHReturnsInformation">
- <s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="Recnum" type="s:int" />
<s:element minOccurs="0" maxOccurs="1" name="Created" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ImmediateDestination" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ImmediateDestinationName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ImmediateOrigin" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ImmediateOriginName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ReferenceCode" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ServiceClassCode" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CompanyName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CompanyDiscretionaryData" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CompanyIdentification" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="StandardEntryClass" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CompanyEntryDescription" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CompanyDescriptiveDate" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="EffectiveEntryDate" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="SettlementDate" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="OriginatorStatusCode" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="OriginatingDFI" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="BatchNumber" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="TransactionCode" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ReceivingDFI" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="AccountNumber" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="Amount" type="s:decimal" />
<s:element minOccurs="0" maxOccurs="1" name="IndividualIdentificationNumber" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="IndividualName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="DiscretionaryData" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="EntryTraceNumber" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="AddendaTypeCode" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ReturnReasonCode" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="OriginalEntryTraceNumber" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="DateOfDeath" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="OrigReceivingDFIIdentification" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="AddendaInformation" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="AddendaTraceNumber" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ProcessedFlag" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Processed" type="s:string" />
</s:sequence>
</s:complexType>
- <s:element name="GetLastACHReturnByABAAccountNumber">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 61 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 62 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 63 of 126
</s:sequence>
</s:complexType>
- <s:complexType name="CheckAuthorizationInformation">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="AuthorizationApprovalCode" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="AuthorizationResponseCode" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="AuthorizationResponseText" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="AuthorizationStatus" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="AuthorizationTime" type="s:string" />
</s:sequence>
</s:complexType>
- <s:element name="AuthorizeCheckTransaction">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="objCheck" type="tns:CheckTransaction" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="AuthorizeCheckTransactionResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="AuthorizeCheckTransactionResult"
type="tns:CheckResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UpdateAndAuthorizeCheckTransaction">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="1" maxOccurs="1" name="RecordNumber" type="s:int" />
<s:element minOccurs="0" maxOccurs="1" name="objCheck" type="tns:CheckTransaction" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UpdateAndAuthorizeCheckTransactionResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UpdateAndAuthorizeCheckTransactionResult"
type="tns:CheckResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="AuthorizeExistingCheckTransaction">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="1" maxOccurs="1" name="RecordNumber" type="s:int" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="AuthorizeExistingCheckTransactionResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="AuthorizeExistingCheckTransactionResult"
type="tns:CheckResponse" />
</s:sequence>
</s:complexType>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 64 of 126
</s:element>
- <s:element name="GetCheckTransaction">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="1" maxOccurs="1" name="RecordNumber" type="s:int" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="GetCheckTransactionResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetCheckTransactionResult" type="tns:CheckResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="GetCheckTransactions">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="1" maxOccurs="1" name="FieldName" type="tns:FieldParams" />
<s:element minOccurs="0" maxOccurs="1" name="FieldValue" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:simpleType name="FieldParams">
- <s:restriction base="s:string">
<s:enumeration value="CustomerID" />
<s:enumeration value="ReferenceCode" />
<s:enumeration value="UDK1" />
<s:enumeration value="UDK2" />
<s:enumeration value="UDK3" />
<s:enumeration value="UDK4" />
<s:enumeration value="UDK5" />
<s:enumeration value="UDK6" />
</s:restriction>
</s:simpleType>
- <s:element name="GetCheckTransactionsResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetCheckTransactionsResult"
type="tns:CheckTransactionsResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="CheckTransactionsResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CheckTransactions" type="tns:CheckTransactions" />
</s:sequence>
</s:complexType>
- <s:complexType name="CheckTransactions">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="unbounded" name="CheckTransaction" type="tns:CheckTransaction"
/>
</s:sequence>
</s:complexType>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 65 of 126
- <s:element name="DeleteCheckTransaction">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="1" maxOccurs="1" name="RecordNumber" type="s:int" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="DeleteCheckTransactionResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="DeleteCheckTransactionResult" type="tns:CheckResponse"
/>
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="AddCheckCreditTransaction">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="objCheckCredit" type="tns:CheckCreditTransaction" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="CheckCreditTransaction">
- <s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="OriginalDebitRecordNumber" type="s:int" />
<s:element minOccurs="1" maxOccurs="1" name="Amount" type="s:decimal" />
<s:element minOccurs="0" maxOccurs="1" name="CheckDate" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="UseAlternateABAAccountNumber" type="s:boolean" />
</s:sequence>
</s:complexType>
- <s:element name="AddCheckCreditTransactionResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="AddCheckCreditTransactionResult"
type="tns:CheckResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="AddCreditCardTransaction">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="objCreditCard" type="tns:CreditCardTransaction" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="CreditCardTransaction">
- <s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="Amount" type="s:decimal" />
<s:element minOccurs="1" maxOccurs="1" name="CardNumber" nillable="true" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="City" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CreatedDate" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CustomerID" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CVV2" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CVV2PresenceIndicator" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="ExpirationDate" nillable="true" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="FirstName" type="s:string" />
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 66 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 67 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 68 of 126
</s:complexType>
</s:element>
- <s:element name="GetCreditCardTransactionsResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetCreditCardTransactionsResult"
type="tns:CreditCardTransactionsResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="CreditCardTransactionsResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CreditCardTransactions" type="tns:CreditCardTransactions"
/>
</s:sequence>
</s:complexType>
- <s:complexType name="CreditCardTransactions">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="unbounded" name="CreditCardTransaction"
type="tns:CreditCardTransaction" />
</s:sequence>
</s:complexType>
- <s:element name="VoidCreditCardTransaction">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="1" maxOccurs="1" name="RecordNumber" type="s:int" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="VoidCreditCardTransactionResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="VoidCreditCardTransactionResult"
type="tns:CreditCardResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="ReverseCreditCardTransaction">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="1" maxOccurs="1" name="RecordNumber" type="s:int" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="ReverseCreditCardTransactionResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="ReverseCreditCardTransactionResult"
type="tns:CreditCardResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="AddPartialCreditCardCredit">
- <s:complexType>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 69 of 126
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="1" maxOccurs="1" name="RecordNumber" type="s:int" />
<s:element minOccurs="1" maxOccurs="1" name="CreditAmount" type="s:decimal" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="AddPartialCreditCardCreditResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="AddPartialCreditCardCreditResult"
type="tns:CreditCardResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="AddFullCreditCardCredit">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="1" maxOccurs="1" name="RecordNumber" type="s:int" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="AddFullCreditCardCreditResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="AddFullCreditCardCreditResult"
type="tns:CreditCardResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="AddPaymentProfile">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="objPaymentProfile" type="tns:PaymentProfileInformation"
/>
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="PaymentProfileInformation">
- <s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="ID" type="s:int" />
<s:element minOccurs="0" maxOccurs="1" name="Name" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CustomerID" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="PaymentType" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="AccountNumber" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ABA" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Name1" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Name2" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="FirstName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="MiddleInitial" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="LastName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CheckProfileType" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ExpirationDate" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ProcessingType" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="SavingsAccount" type="s:boolean" />
<s:element minOccurs="0" maxOccurs="1" name="Street" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="City" type="s:string" />
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 70 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 71 of 126
/>
<s:element minOccurs="1" maxOccurs="1" name="Name1" nillable="true" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Name2" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Notes" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="PaperEnrolled" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="PaymentProfiles" nillable="true"
type="tns:PaymentProfiles" />
<s:element minOccurs="0" maxOccurs="1" name="PayToName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="PIN" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="RecurringPayment" nillable="true"
type="tns:RecurringPaymentInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ReferenceCode" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="Street" nillable="true" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="State" nillable="true" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ShippingCity" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ShippingStreet" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ShippingState" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="ShippingZipCode" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="SSN" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="TransactionType" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="UDK1" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="UDK2" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="UDK3" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="UDK4" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="UDK5" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="UDK6" type="s:int" />
<s:element minOccurs="0" maxOccurs="1" name="WorkPhoneNumber" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="ZipCode" nillable="true" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="LastPaymentDate" nillable="true" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="LastPaymentAmount" type="s:decimal" />
<s:element minOccurs="1" maxOccurs="1" name="NotificationSettings" nillable="true"
type="tns:NotificationSettingsInformation" />
</s:sequence>
</s:complexType>
- <s:complexType name="BillInformation">
- <s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="Amount" type="s:decimal" />
<s:element minOccurs="1" maxOccurs="1" name="Balance" type="s:decimal" />
<s:element minOccurs="0" maxOccurs="1" name="BillDate" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="BillID" type="s:int" />
<s:element minOccurs="0" maxOccurs="1" name="CreatedDate" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="DueDate" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="GracePeriod" type="s:int" />
<s:element minOccurs="0" maxOccurs="1" name="InputSource" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="LastModifiedDate" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CustomerBillID" type="s:string" />
</s:sequence>
</s:complexType>
- <s:complexType name="PaymentProfiles">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="unbounded" name="PaymentProfile"
type="tns:PaymentProfileInformation" />
</s:sequence>
</s:complexType>
- <s:complexType name="NotificationSettingsInformation">
- <s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="ID" type="s:int" />
<s:element minOccurs="1" maxOccurs="1" name="EmailNotification" type="s:boolean" />
<s:element minOccurs="1" maxOccurs="1" name="EmailType" type="s:int" />
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 72 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 73 of 126
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CustomerID" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="GetCustomerRecordResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetCustomerRecordResult" type="tns:CustomerResponse"
/>
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UpdatePaymentProfile">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="objPaymentProfile" type="tns:PaymentProfileInformation"
/>
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UpdatePaymentProfileResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UpdatePaymentProfileResult"
type="tns:PaymentProfileResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UpdateCustomerRecord">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="objCustomer" type="tns:CustomerRecord" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UpdateCustomerRecordResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UpdateCustomerRecordResult"
type="tns:CustomerResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="DeletePaymentProfile">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="PaymentProfileName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CustomerID" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="DeletePaymentProfileResponse">
- <s:complexType>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 74 of 126
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="DeletePaymentProfileResult"
type="tns:PaymentProfileResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="DeletePaymentProfileByID">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="PaymentProfileID" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="DeletePaymentProfileByIDResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="DeletePaymentProfileByIDResult"
type="tns:PaymentProfileResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="DeleteCustomerRecord">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CustomerID" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="DeleteCustomerRecordResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="DeleteCustomerRecordResult"
type="tns:CustomerResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="GetOptionValue">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="OptionName" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="GetOptionValueResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetOptionValueResult" type="tns:OptionResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="OptionResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="0" maxOccurs="1" name="OptionInformation" type="tns:OptionInformation" />
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 75 of 126
</s:sequence>
</s:complexType>
- <s:complexType name="OptionInformation">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="OptionName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="OptionValue" type="s:string" />
</s:sequence>
</s:complexType>
- <s:element name="GetOptionValues">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
- <s:element minOccurs="0" maxOccurs="1" name="OptionNames">
- <s:complexType>
- <s:sequence>
<s:element ref="s:schema" />
<s:any />
</s:sequence>
</s:complexType>
</s:element>
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="GetOptionValuesResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetOptionValuesResult" type="tns:OptionsResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="OptionsResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
- <s:element minOccurs="0" maxOccurs="1" name="OptionsInformation">
- <s:complexType>
- <s:sequence>
<s:element ref="s:schema" />
<s:any />
</s:sequence>
</s:complexType>
</s:element>
</s:sequence>
</s:complexType>
- <s:element name="CalculateConvenienceFee">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="PaytoName" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="Amount" type="s:decimal" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="CalculateConvenienceFeeResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CalculateConvenienceFeeResult"
type="tns:ConvenienceFeeResponse" />
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 76 of 126
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="ConvenienceFeeResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ConvenienceFeeInformation"
type="tns:ConvenienceFeeInformation" />
</s:sequence>
</s:complexType>
- <s:complexType name="ConvenienceFeeInformation">
- <s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="ConvenienceFee" type="s:decimal" />
</s:sequence>
</s:complexType>
- <s:element name="BlockABAAccountNumber">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ABAAccount" type="tns:BlockABAAccountInformation" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="BlockABAAccountInformation">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="ABA" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="AccountNumber" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Reason" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Comments" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="UserName" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="ProgrammaticRequest" type="s:boolean" />
</s:sequence>
</s:complexType>
- <s:element name="BlockABAAccountNumberResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="BlockABAAccountNumberResult"
type="tns:BlockABAAccountResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="BlockABAAccountResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="1" maxOccurs="1" name="IsBlocked" type="s:boolean" />
</s:sequence>
</s:complexType>
- <s:element name="BlockCreditCardNumber">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CreditCard" type="tns:BlockCreditCardInformation" />
</s:sequence>
</s:complexType>
</s:element>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 77 of 126
- <s:complexType name="BlockCreditCardInformation">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CreditCardNumber" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Reason" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Comments" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="UserName" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="ProgrammaticRequest" type="s:boolean" />
</s:sequence>
</s:complexType>
- <s:element name="BlockCreditCardNumberResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="BlockCreditCardNumberResult"
type="tns:BlockCreditCardResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="BlockCreditCardResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="1" maxOccurs="1" name="IsBlocked" type="s:boolean" />
</s:sequence>
</s:complexType>
- <s:element name="UnBlockABAAccountNumber">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ABAAccount" type="tns:BlockABAAccountInformation" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UnBlockABAAccountNumberResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UnBlockABAAccountNumberResult"
type="tns:BlockABAAccountResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UnBlockCreditCardNumber">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CreditCard" type="tns:BlockCreditCardInformation" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UnBlockCreditCardNumberResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UnBlockCreditCardNumberResult"
type="tns:BlockCreditCardResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="IsABAAccountNumberBlocked">
- <s:complexType>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 78 of 126
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ABA" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="AccountNumber" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="IsABAAccountNumberBlockedResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="IsABAAccountNumberBlockedResult"
type="tns:BlockABAAccountResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="IsCreditCardNumberBlocked">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CreditCardNumber" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="IsCreditCardNumberBlockedResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="IsCreditCardNumberBlockedResult"
type="tns:BlockCreditCardResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="BlockFieldValue">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="BlockedFieldValueInformation"
type="tns:BlockFieldValueInformation" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="BlockFieldValueInformation">
- <s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="Field" type="tns:BlockedDataFieldID" />
<s:element minOccurs="0" maxOccurs="1" name="FieldValue" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Reason" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="Comments" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="UserName" type="s:string" />
<s:element minOccurs="1" maxOccurs="1" name="ProgrammaticRequest" type="s:boolean" />
</s:sequence>
</s:complexType>
- <s:simpleType name="BlockedDataFieldID">
- <s:restriction base="s:string">
<s:enumeration value="CustomerID" />
<s:enumeration value="ReferenceCode" />
<s:enumeration value="UDK1" />
<s:enumeration value="UDK2" />
<s:enumeration value="UDK3" />
</s:restriction>
</s:simpleType>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 79 of 126
- <s:element name="BlockFieldValueResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="BlockFieldValueResult" type="tns:BlockFieldValueResponse"
/>
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="BlockFieldValueResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="1" maxOccurs="1" name="IsBlocked" type="s:boolean" />
</s:sequence>
</s:complexType>
- <s:element name="UnBlockFieldValue">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="BlockFieldValueInformation"
type="tns:BlockFieldValueInformation" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UnBlockFieldValueResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UnBlockFieldValueResult"
type="tns:BlockFieldValueResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="IsFieldValueBlocked">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="1" maxOccurs="1" name="Field" type="tns:BlockedDataFieldID" />
<s:element minOccurs="0" maxOccurs="1" name="FieldValue" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="IsFieldValueBlockedResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="IsFieldValueBlockedResult"
type="tns:BlockFieldValueResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="IsValidCreditCardNumber">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CreditCardNumber" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="IsValidCreditCardNumberResponse">
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 80 of 126
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="IsValidCreditCardNumberResult"
type="tns:IsValidCreditCardResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="IsValidCreditCardResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="1" maxOccurs="1" name="IsValid" type="s:boolean" />
</s:sequence>
</s:complexType>
- <s:element name="IsValidCreditCardNumberForPayto">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CreditCardNumber" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CreditCardPaytoName" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="IsValidCreditCardNumberForPaytoResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="IsValidCreditCardNumberForPaytoResult"
type="tns:IsValidCreditCardResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="IsABAAccountNumberValid">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ABA" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="AccountNumber" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="IsABAAccountNumberValidResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="IsABAAccountNumberValidResult"
type="tns:IsABAAccountNumberValidResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="IsABAAccountNumberValidResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="1" maxOccurs="1" name="IsValid" type="s:boolean" />
</s:sequence>
</s:complexType>
- <s:element name="AddBill">
- <s:complexType>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 81 of 126
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="objBill" type="tns:BillInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CustomerId" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="AddBillResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="AddBillResult" type="tns:BillResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="BillResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ReceiptInformation" type="tns:ReceiptInformation" />
<s:element minOccurs="0" maxOccurs="1" name="BillInformation" type="tns:BillInformation" />
</s:sequence>
</s:complexType>
- <s:element name="GetBill">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="BillID" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="GetBillResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetBillResult" type="tns:BillResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UpdateBill">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="objBill" type="tns:BillInformation" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UpdateBillResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UpdateBillResult" type="tns:BillResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="DeleteBill">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="BillID" type="s:string" />
</s:sequence>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 82 of 126
</s:complexType>
</s:element>
- <s:element name="DeleteBillResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="DeleteBillResult" type="tns:BillResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="GetBills">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="CustomerID" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="GetBillsResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetBillsResult" type="tns:BillsResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="BillsResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="0" maxOccurs="1" name="Bills" type="tns:Bills" />
</s:sequence>
</s:complexType>
- <s:complexType name="Bills">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="unbounded" name="Bill" type="tns:BillInformation" />
</s:sequence>
</s:complexType>
- <s:element name="GetBillHTML">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="BillID" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="GetBillHTMLResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetBillHTMLResult" type="tns:BillRenderedResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="BillRenderedResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="0" maxOccurs="1" name="BillInformation" type="tns:BillInformation" />
<s:element minOccurs="0" maxOccurs="1" name="BillRenderedData" type="s:base64Binary" />
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 83 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 84 of 126
- <s:element name="AddUserAccountResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="AddUserAccountResult" type="tns:UserAccountResponse"
/>
</s:sequence>
</s:complexType>
</s:element>
- <s:complexType name="UserAccountResponse">
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GeneralInformation" type="tns:GeneralInformation" />
<s:element minOccurs="0" maxOccurs="1" name="StatusInformation" type="tns:StatusInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ErrorInformation" type="tns:ErrorInformation" />
<s:element minOccurs="0" maxOccurs="1" name="ReceiptInformation" type="tns:ReceiptInformation" />
<s:element minOccurs="0" maxOccurs="1" name="UserAccountInformation"
type="tns:UserAccountInformation" />
</s:sequence>
</s:complexType>
- <s:element name="GetUserAccount">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="UserAccountName" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="GetUserAccountResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetUserAccountResult" type="tns:UserAccountResponse"
/>
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UpdateUserAccount">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="objUserAccount" type="tns:UserAccountInformation" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="UpdateUserAccountResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UpdateUserAccountResult"
type="tns:UserAccountResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="DeleteUserAccount">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="UserAccountName" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="DeleteUserAccountResponse">
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 85 of 126
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="DeleteUserAccountResult"
type="tns:UserAccountResponse" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="LinkCustomerToUserAccount">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="objAuthentication" type="tns:AuthenticationInformation" />
<s:element minOccurs="0" maxOccurs="1" name="UserAccountName" type="s:string" />
<s:element minOccurs="0" maxOccurs="1" name="CustomerID" type="s:string" />
</s:sequence>
</s:complexType>
</s:element>
- <s:element name="LinkCustomerToUserAccountResponse">
- <s:complexType>
- <s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="LinkCustomerToUserAccountResult"
type="tns:LinkCustomerToUserAccountResponse" />
</s:sequence>
</s:complexType>
</s:element>
</s:schema>
</wsdl:types>
- <wsdl:message name="UnLinkCustomerToUserAccountSoapIn">
<wsdl:part name="parameters" element="tns:UnLinkCustomerToUserAccount" />
</wsdl:message>
- <wsdl:message name="UnLinkCustomerToUserAccountSoapOut">
<wsdl:part name="parameters" element="tns:UnLinkCustomerToUserAccountResponse" />
</wsdl:message>
- <wsdl:message name="AddRecurringPaymentSoapIn">
<wsdl:part name="parameters" element="tns:AddRecurringPayment" />
</wsdl:message>
- <wsdl:message name="AddRecurringPaymentSoapOut">
<wsdl:part name="parameters" element="tns:AddRecurringPaymentResponse" />
</wsdl:message>
- <wsdl:message name="GetRecurringPaymentSoapIn">
<wsdl:part name="parameters" element="tns:GetRecurringPayment" />
</wsdl:message>
- <wsdl:message name="GetRecurringPaymentSoapOut">
<wsdl:part name="parameters" element="tns:GetRecurringPaymentResponse" />
</wsdl:message>
- <wsdl:message name="UpdateRecurringPaymentSoapIn">
<wsdl:part name="parameters" element="tns:UpdateRecurringPayment" />
</wsdl:message>
- <wsdl:message name="UpdateRecurringPaymentSoapOut">
<wsdl:part name="parameters" element="tns:UpdateRecurringPaymentResponse" />
</wsdl:message>
- <wsdl:message name="DeleteRecurringPaymentSoapIn">
<wsdl:part name="parameters" element="tns:DeleteRecurringPayment" />
</wsdl:message>
- <wsdl:message name="DeleteRecurringPaymentSoapOut">
<wsdl:part name="parameters" element="tns:DeleteRecurringPaymentResponse" />
</wsdl:message>
- <wsdl:message name="GetBankInformationSoapIn">
<wsdl:part name="parameters" element="tns:GetBankInformation" />
</wsdl:message>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 86 of 126
- <wsdl:message name="GetBankInformationSoapOut">
<wsdl:part name="parameters" element="tns:GetBankInformationResponse" />
</wsdl:message>
- <wsdl:message name="GetCardHolderInformationSoapIn">
<wsdl:part name="parameters" element="tns:GetCardHolderInformation" />
</wsdl:message>
- <wsdl:message name="GetCardHolderInformationSoapOut">
<wsdl:part name="parameters" element="tns:GetCardHolderInformationResponse" />
</wsdl:message>
- <wsdl:message name="GetCreditCardSoapIn">
<wsdl:part name="parameters" element="tns:GetCreditCard" />
</wsdl:message>
- <wsdl:message name="GetCreditCardSoapOut">
<wsdl:part name="parameters" element="tns:GetCreditCardResponse" />
</wsdl:message>
- <wsdl:message name="IsACHABASoapIn">
<wsdl:part name="parameters" element="tns:IsACHABA" />
</wsdl:message>
- <wsdl:message name="IsACHABASoapOut">
<wsdl:part name="parameters" element="tns:IsACHABAResponse" />
</wsdl:message>
- <wsdl:message name="GetLastACHReturnByRecnumSoapIn">
<wsdl:part name="parameters" element="tns:GetLastACHReturnByRecnum" />
</wsdl:message>
- <wsdl:message name="GetLastACHReturnByRecnumSoapOut">
<wsdl:part name="parameters" element="tns:GetLastACHReturnByRecnumResponse" />
</wsdl:message>
- <wsdl:message name="GetLastACHReturnByABAAccountNumberSoapIn">
<wsdl:part name="parameters" element="tns:GetLastACHReturnByABAAccountNumber" />
</wsdl:message>
- <wsdl:message name="GetLastACHReturnByABAAccountNumberSoapOut">
<wsdl:part name="parameters" element="tns:GetLastACHReturnByABAAccountNumberResponse" />
</wsdl:message>
- <wsdl:message name="AddCheckTransactionSoapIn">
<wsdl:part name="parameters" element="tns:AddCheckTransaction" />
</wsdl:message>
- <wsdl:message name="AddCheckTransactionSoapOut">
<wsdl:part name="parameters" element="tns:AddCheckTransactionResponse" />
</wsdl:message>
- <wsdl:message name="AuthorizeCheckTransactionSoapIn">
<wsdl:part name="parameters" element="tns:AuthorizeCheckTransaction" />
</wsdl:message>
- <wsdl:message name="AuthorizeCheckTransactionSoapOut">
<wsdl:part name="parameters" element="tns:AuthorizeCheckTransactionResponse" />
</wsdl:message>
- <wsdl:message name="UpdateAndAuthorizeCheckTransactionSoapIn">
<wsdl:part name="parameters" element="tns:UpdateAndAuthorizeCheckTransaction" />
</wsdl:message>
- <wsdl:message name="UpdateAndAuthorizeCheckTransactionSoapOut">
<wsdl:part name="parameters" element="tns:UpdateAndAuthorizeCheckTransactionResponse" />
</wsdl:message>
- <wsdl:message name="AuthorizeExistingCheckTransactionSoapIn">
<wsdl:part name="parameters" element="tns:AuthorizeExistingCheckTransaction" />
</wsdl:message>
- <wsdl:message name="AuthorizeExistingCheckTransactionSoapOut">
<wsdl:part name="parameters" element="tns:AuthorizeExistingCheckTransactionResponse" />
</wsdl:message>
- <wsdl:message name="GetCheckTransactionSoapIn">
<wsdl:part name="parameters" element="tns:GetCheckTransaction" />
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 87 of 126
</wsdl:message>
- <wsdl:message name="GetCheckTransactionSoapOut">
<wsdl:part name="parameters" element="tns:GetCheckTransactionResponse" />
</wsdl:message>
- <wsdl:message name="GetCheckTransactionsSoapIn">
<wsdl:part name="parameters" element="tns:GetCheckTransactions" />
</wsdl:message>
- <wsdl:message name="GetCheckTransactionsSoapOut">
<wsdl:part name="parameters" element="tns:GetCheckTransactionsResponse" />
</wsdl:message>
- <wsdl:message name="DeleteCheckTransactionSoapIn">
<wsdl:part name="parameters" element="tns:DeleteCheckTransaction" />
</wsdl:message>
- <wsdl:message name="DeleteCheckTransactionSoapOut">
<wsdl:part name="parameters" element="tns:DeleteCheckTransactionResponse" />
</wsdl:message>
- <wsdl:message name="AddCheckCreditTransactionSoapIn">
<wsdl:part name="parameters" element="tns:AddCheckCreditTransaction" />
</wsdl:message>
- <wsdl:message name="AddCheckCreditTransactionSoapOut">
<wsdl:part name="parameters" element="tns:AddCheckCreditTransactionResponse" />
</wsdl:message>
- <wsdl:message name="AddCreditCardTransactionSoapIn">
<wsdl:part name="parameters" element="tns:AddCreditCardTransaction" />
</wsdl:message>
- <wsdl:message name="AddCreditCardTransactionSoapOut">
<wsdl:part name="parameters" element="tns:AddCreditCardTransactionResponse" />
</wsdl:message>
- <wsdl:message name="UpdateAndResubmitCreditCardTransactionSoapIn">
<wsdl:part name="parameters" element="tns:UpdateAndResubmitCreditCardTransaction" />
</wsdl:message>
- <wsdl:message name="UpdateAndResubmitCreditCardTransactionSoapOut">
<wsdl:part name="parameters" element="tns:UpdateAndResubmitCreditCardTransactionResponse" />
</wsdl:message>
- <wsdl:message name="ResubmitCreditCardTransactionSoapIn">
<wsdl:part name="parameters" element="tns:ResubmitCreditCardTransaction" />
</wsdl:message>
- <wsdl:message name="ResubmitCreditCardTransactionSoapOut">
<wsdl:part name="parameters" element="tns:ResubmitCreditCardTransactionResponse" />
</wsdl:message>
- <wsdl:message name="GetCreditCardTransactionSoapIn">
<wsdl:part name="parameters" element="tns:GetCreditCardTransaction" />
</wsdl:message>
- <wsdl:message name="GetCreditCardTransactionSoapOut">
<wsdl:part name="parameters" element="tns:GetCreditCardTransactionResponse" />
</wsdl:message>
- <wsdl:message name="GetCreditCardTransactionsSoapIn">
<wsdl:part name="parameters" element="tns:GetCreditCardTransactions" />
</wsdl:message>
- <wsdl:message name="GetCreditCardTransactionsSoapOut">
<wsdl:part name="parameters" element="tns:GetCreditCardTransactionsResponse" />
</wsdl:message>
- <wsdl:message name="VoidCreditCardTransactionSoapIn">
<wsdl:part name="parameters" element="tns:VoidCreditCardTransaction" />
</wsdl:message>
- <wsdl:message name="VoidCreditCardTransactionSoapOut">
<wsdl:part name="parameters" element="tns:VoidCreditCardTransactionResponse" />
</wsdl:message>
- <wsdl:message name="ReverseCreditCardTransactionSoapIn">
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 88 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 89 of 126
- <wsdl:message name="DeletePaymentProfileSoapIn">
<wsdl:part name="parameters" element="tns:DeletePaymentProfile" />
</wsdl:message>
- <wsdl:message name="DeletePaymentProfileSoapOut">
<wsdl:part name="parameters" element="tns:DeletePaymentProfileResponse" />
</wsdl:message>
- <wsdl:message name="DeletePaymentProfileByIDSoapIn">
<wsdl:part name="parameters" element="tns:DeletePaymentProfileByID" />
</wsdl:message>
- <wsdl:message name="DeletePaymentProfileByIDSoapOut">
<wsdl:part name="parameters" element="tns:DeletePaymentProfileByIDResponse" />
</wsdl:message>
- <wsdl:message name="DeleteCustomerRecordSoapIn">
<wsdl:part name="parameters" element="tns:DeleteCustomerRecord" />
</wsdl:message>
- <wsdl:message name="DeleteCustomerRecordSoapOut">
<wsdl:part name="parameters" element="tns:DeleteCustomerRecordResponse" />
</wsdl:message>
- <wsdl:message name="GetOptionValueSoapIn">
<wsdl:part name="parameters" element="tns:GetOptionValue" />
</wsdl:message>
- <wsdl:message name="GetOptionValueSoapOut">
<wsdl:part name="parameters" element="tns:GetOptionValueResponse" />
</wsdl:message>
- <wsdl:message name="GetOptionValuesSoapIn">
<wsdl:part name="parameters" element="tns:GetOptionValues" />
</wsdl:message>
- <wsdl:message name="GetOptionValuesSoapOut">
<wsdl:part name="parameters" element="tns:GetOptionValuesResponse" />
</wsdl:message>
- <wsdl:message name="CalculateConvenienceFeeSoapIn">
<wsdl:part name="parameters" element="tns:CalculateConvenienceFee" />
</wsdl:message>
- <wsdl:message name="CalculateConvenienceFeeSoapOut">
<wsdl:part name="parameters" element="tns:CalculateConvenienceFeeResponse" />
</wsdl:message>
- <wsdl:message name="BlockABAAccountNumberSoapIn">
<wsdl:part name="parameters" element="tns:BlockABAAccountNumber" />
</wsdl:message>
- <wsdl:message name="BlockABAAccountNumberSoapOut">
<wsdl:part name="parameters" element="tns:BlockABAAccountNumberResponse" />
</wsdl:message>
- <wsdl:message name="BlockCreditCardNumberSoapIn">
<wsdl:part name="parameters" element="tns:BlockCreditCardNumber" />
</wsdl:message>
- <wsdl:message name="BlockCreditCardNumberSoapOut">
<wsdl:part name="parameters" element="tns:BlockCreditCardNumberResponse" />
</wsdl:message>
- <wsdl:message name="UnBlockABAAccountNumberSoapIn">
<wsdl:part name="parameters" element="tns:UnBlockABAAccountNumber" />
</wsdl:message>
- <wsdl:message name="UnBlockABAAccountNumberSoapOut">
<wsdl:part name="parameters" element="tns:UnBlockABAAccountNumberResponse" />
</wsdl:message>
- <wsdl:message name="UnBlockCreditCardNumberSoapIn">
<wsdl:part name="parameters" element="tns:UnBlockCreditCardNumber" />
</wsdl:message>
- <wsdl:message name="UnBlockCreditCardNumberSoapOut">
<wsdl:part name="parameters" element="tns:UnBlockCreditCardNumberResponse" />
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 90 of 126
</wsdl:message>
- <wsdl:message name="IsABAAccountNumberBlockedSoapIn">
<wsdl:part name="parameters" element="tns:IsABAAccountNumberBlocked" />
</wsdl:message>
- <wsdl:message name="IsABAAccountNumberBlockedSoapOut">
<wsdl:part name="parameters" element="tns:IsABAAccountNumberBlockedResponse" />
</wsdl:message>
- <wsdl:message name="IsCreditCardNumberBlockedSoapIn">
<wsdl:part name="parameters" element="tns:IsCreditCardNumberBlocked" />
</wsdl:message>
- <wsdl:message name="IsCreditCardNumberBlockedSoapOut">
<wsdl:part name="parameters" element="tns:IsCreditCardNumberBlockedResponse" />
</wsdl:message>
- <wsdl:message name="BlockFieldValueSoapIn">
<wsdl:part name="parameters" element="tns:BlockFieldValue" />
</wsdl:message>
- <wsdl:message name="BlockFieldValueSoapOut">
<wsdl:part name="parameters" element="tns:BlockFieldValueResponse" />
</wsdl:message>
- <wsdl:message name="UnBlockFieldValueSoapIn">
<wsdl:part name="parameters" element="tns:UnBlockFieldValue" />
</wsdl:message>
- <wsdl:message name="UnBlockFieldValueSoapOut">
<wsdl:part name="parameters" element="tns:UnBlockFieldValueResponse" />
</wsdl:message>
- <wsdl:message name="IsFieldValueBlockedSoapIn">
<wsdl:part name="parameters" element="tns:IsFieldValueBlocked" />
</wsdl:message>
- <wsdl:message name="IsFieldValueBlockedSoapOut">
<wsdl:part name="parameters" element="tns:IsFieldValueBlockedResponse" />
</wsdl:message>
- <wsdl:message name="IsValidCreditCardNumberSoapIn">
<wsdl:part name="parameters" element="tns:IsValidCreditCardNumber" />
</wsdl:message>
- <wsdl:message name="IsValidCreditCardNumberSoapOut">
<wsdl:part name="parameters" element="tns:IsValidCreditCardNumberResponse" />
</wsdl:message>
- <wsdl:message name="IsValidCreditCardNumberForPaytoSoapIn">
<wsdl:part name="parameters" element="tns:IsValidCreditCardNumberForPayto" />
</wsdl:message>
- <wsdl:message name="IsValidCreditCardNumberForPaytoSoapOut">
<wsdl:part name="parameters" element="tns:IsValidCreditCardNumberForPaytoResponse" />
</wsdl:message>
- <wsdl:message name="IsABAAccountNumberValidSoapIn">
<wsdl:part name="parameters" element="tns:IsABAAccountNumberValid" />
</wsdl:message>
- <wsdl:message name="IsABAAccountNumberValidSoapOut">
<wsdl:part name="parameters" element="tns:IsABAAccountNumberValidResponse" />
</wsdl:message>
- <wsdl:message name="AddBillSoapIn">
<wsdl:part name="parameters" element="tns:AddBill" />
</wsdl:message>
- <wsdl:message name="AddBillSoapOut">
<wsdl:part name="parameters" element="tns:AddBillResponse" />
</wsdl:message>
- <wsdl:message name="GetBillSoapIn">
<wsdl:part name="parameters" element="tns:GetBill" />
</wsdl:message>
- <wsdl:message name="GetBillSoapOut">
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 91 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 92 of 126
- <wsdl:message name="LinkCustomerToUserAccountSoapOut">
<wsdl:part name="parameters" element="tns:LinkCustomerToUserAccountResponse" />
</wsdl:message>
- <wsdl:portType name="ClearTranWebServiceSoap">
- <wsdl:operation name="UnLinkCustomerToUserAccount">
<wsdl:input message="tns:UnLinkCustomerToUserAccountSoapIn" />
<wsdl:output message="tns:UnLinkCustomerToUserAccountSoapOut" />
</wsdl:operation>
- <wsdl:operation name="AddRecurringPayment">
<wsdl:input message="tns:AddRecurringPaymentSoapIn" />
<wsdl:output message="tns:AddRecurringPaymentSoapOut" />
</wsdl:operation>
- <wsdl:operation name="GetRecurringPayment">
<wsdl:input message="tns:GetRecurringPaymentSoapIn" />
<wsdl:output message="tns:GetRecurringPaymentSoapOut" />
</wsdl:operation>
- <wsdl:operation name="UpdateRecurringPayment">
<wsdl:input message="tns:UpdateRecurringPaymentSoapIn" />
<wsdl:output message="tns:UpdateRecurringPaymentSoapOut" />
</wsdl:operation>
- <wsdl:operation name="DeleteRecurringPayment">
<wsdl:input message="tns:DeleteRecurringPaymentSoapIn" />
<wsdl:output message="tns:DeleteRecurringPaymentSoapOut" />
</wsdl:operation>
- <wsdl:operation name="GetBankInformation">
<wsdl:input message="tns:GetBankInformationSoapIn" />
<wsdl:output message="tns:GetBankInformationSoapOut" />
</wsdl:operation>
- <wsdl:operation name="GetCardHolderInformation">
<wsdl:input message="tns:GetCardHolderInformationSoapIn" />
<wsdl:output message="tns:GetCardHolderInformationSoapOut" />
</wsdl:operation>
- <wsdl:operation name="GetCreditCard">
<wsdl:input message="tns:GetCreditCardSoapIn" />
<wsdl:output message="tns:GetCreditCardSoapOut" />
</wsdl:operation>
- <wsdl:operation name="IsACHABA">
<wsdl:input message="tns:IsACHABASoapIn" />
<wsdl:output message="tns:IsACHABASoapOut" />
</wsdl:operation>
- <wsdl:operation name="GetLastACHReturn">
<wsdl:input name="GetLastACHReturnByRecnum" message="tns:GetLastACHReturnByRecnumSoapIn" />
<wsdl:output name="GetLastACHReturnByRecnum" message="tns:GetLastACHReturnByRecnumSoapOut" />
</wsdl:operation>
- <wsdl:operation name="GetLastACHReturn">
<wsdl:input name="GetLastACHReturnByABAAccountNumber"
message="tns:GetLastACHReturnByABAAccountNumberSoapIn" />
<wsdl:output name="GetLastACHReturnByABAAccountNumber"
message="tns:GetLastACHReturnByABAAccountNumberSoapOut" />
</wsdl:operation>
- <wsdl:operation name="AddCheckTransaction">
<wsdl:input message="tns:AddCheckTransactionSoapIn" />
<wsdl:output message="tns:AddCheckTransactionSoapOut" />
</wsdl:operation>
- <wsdl:operation name="AuthorizeCheckTransaction">
<wsdl:input message="tns:AuthorizeCheckTransactionSoapIn" />
<wsdl:output message="tns:AuthorizeCheckTransactionSoapOut" />
</wsdl:operation>
- <wsdl:operation name="AuthorizeCheckTransaction">
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 93 of 126
<wsdl:input name="UpdateAndAuthorizeCheckTransaction"
message="tns:UpdateAndAuthorizeCheckTransactionSoapIn" />
<wsdl:output name="UpdateAndAuthorizeCheckTransaction"
message="tns:UpdateAndAuthorizeCheckTransactionSoapOut" />
</wsdl:operation>
- <wsdl:operation name="AuthorizeCheckTransaction">
<wsdl:input name="AuthorizeExistingCheckTransaction"
message="tns:AuthorizeExistingCheckTransactionSoapIn" />
<wsdl:output name="AuthorizeExistingCheckTransaction"
message="tns:AuthorizeExistingCheckTransactionSoapOut" />
</wsdl:operation>
- <wsdl:operation name="GetCheckTransaction">
<wsdl:input message="tns:GetCheckTransactionSoapIn" />
<wsdl:output message="tns:GetCheckTransactionSoapOut" />
</wsdl:operation>
- <wsdl:operation name="GetCheckTransactions">
<wsdl:input message="tns:GetCheckTransactionsSoapIn" />
<wsdl:output message="tns:GetCheckTransactionsSoapOut" />
</wsdl:operation>
- <wsdl:operation name="DeleteCheckTransaction">
<wsdl:input message="tns:DeleteCheckTransactionSoapIn" />
<wsdl:output message="tns:DeleteCheckTransactionSoapOut" />
</wsdl:operation>
- <wsdl:operation name="AddCheckCreditTransaction">
<wsdl:input message="tns:AddCheckCreditTransactionSoapIn" />
<wsdl:output message="tns:AddCheckCreditTransactionSoapOut" />
</wsdl:operation>
- <wsdl:operation name="AddCreditCardTransaction">
<wsdl:input message="tns:AddCreditCardTransactionSoapIn" />
<wsdl:output message="tns:AddCreditCardTransactionSoapOut" />
</wsdl:operation>
- <wsdl:operation name="AddCreditCardTransaction">
<wsdl:input name="UpdateAndResubmitCreditCardTransaction"
message="tns:UpdateAndResubmitCreditCardTransactionSoapIn" />
<wsdl:output name="UpdateAndResubmitCreditCardTransaction"
message="tns:UpdateAndResubmitCreditCardTransactionSoapOut" />
</wsdl:operation>
- <wsdl:operation name="AddCreditCardTransaction">
<wsdl:input name="ResubmitCreditCardTransaction" message="tns:ResubmitCreditCardTransactionSoapIn" />
<wsdl:output name="ResubmitCreditCardTransaction" message="tns:ResubmitCreditCardTransactionSoapOut"
/>
</wsdl:operation>
- <wsdl:operation name="GetCreditCardTransaction">
<wsdl:input message="tns:GetCreditCardTransactionSoapIn" />
<wsdl:output message="tns:GetCreditCardTransactionSoapOut" />
</wsdl:operation>
- <wsdl:operation name="GetCreditCardTransactions">
<wsdl:input message="tns:GetCreditCardTransactionsSoapIn" />
<wsdl:output message="tns:GetCreditCardTransactionsSoapOut" />
</wsdl:operation>
- <wsdl:operation name="VoidCreditCardTransaction">
<wsdl:input message="tns:VoidCreditCardTransactionSoapIn" />
<wsdl:output message="tns:VoidCreditCardTransactionSoapOut" />
</wsdl:operation>
- <wsdl:operation name="ReverseCreditCardTransaction">
<wsdl:input message="tns:ReverseCreditCardTransactionSoapIn" />
<wsdl:output message="tns:ReverseCreditCardTransactionSoapOut" />
</wsdl:operation>
- <wsdl:operation name="AddCreditCardCreditTransaction">
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 94 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 95 of 126
- <wsdl:operation name="BlockABAAccountNumber">
<wsdl:input message="tns:BlockABAAccountNumberSoapIn" />
<wsdl:output message="tns:BlockABAAccountNumberSoapOut" />
</wsdl:operation>
- <wsdl:operation name="BlockCreditCardNumber">
<wsdl:input message="tns:BlockCreditCardNumberSoapIn" />
<wsdl:output message="tns:BlockCreditCardNumberSoapOut" />
</wsdl:operation>
- <wsdl:operation name="UnBlockABAAccountNumber">
<wsdl:input message="tns:UnBlockABAAccountNumberSoapIn" />
<wsdl:output message="tns:UnBlockABAAccountNumberSoapOut" />
</wsdl:operation>
- <wsdl:operation name="UnBlockCreditCardNumber">
<wsdl:input message="tns:UnBlockCreditCardNumberSoapIn" />
<wsdl:output message="tns:UnBlockCreditCardNumberSoapOut" />
</wsdl:operation>
- <wsdl:operation name="IsABAAccountNumberBlocked">
<wsdl:input message="tns:IsABAAccountNumberBlockedSoapIn" />
<wsdl:output message="tns:IsABAAccountNumberBlockedSoapOut" />
</wsdl:operation>
- <wsdl:operation name="IsCreditCardNumberBlocked">
<wsdl:input message="tns:IsCreditCardNumberBlockedSoapIn" />
<wsdl:output message="tns:IsCreditCardNumberBlockedSoapOut" />
</wsdl:operation>
- <wsdl:operation name="BlockFieldValue">
<wsdl:input message="tns:BlockFieldValueSoapIn" />
<wsdl:output message="tns:BlockFieldValueSoapOut" />
</wsdl:operation>
- <wsdl:operation name="UnBlockFieldValue">
<wsdl:input message="tns:UnBlockFieldValueSoapIn" />
<wsdl:output message="tns:UnBlockFieldValueSoapOut" />
</wsdl:operation>
- <wsdl:operation name="IsFieldValueBlocked">
<wsdl:input message="tns:IsFieldValueBlockedSoapIn" />
<wsdl:output message="tns:IsFieldValueBlockedSoapOut" />
</wsdl:operation>
- <wsdl:operation name="IsValidCreditCard">
<wsdl:input name="IsValidCreditCardNumber" message="tns:IsValidCreditCardNumberSoapIn" />
<wsdl:output name="IsValidCreditCardNumber" message="tns:IsValidCreditCardNumberSoapOut" />
</wsdl:operation>
- <wsdl:operation name="IsValidCreditCard">
<wsdl:input name="IsValidCreditCardNumberForPayto"
message="tns:IsValidCreditCardNumberForPaytoSoapIn" />
<wsdl:output name="IsValidCreditCardNumberForPayto"
message="tns:IsValidCreditCardNumberForPaytoSoapOut" />
</wsdl:operation>
- <wsdl:operation name="IsABAAccountNumberValid">
<wsdl:input message="tns:IsABAAccountNumberValidSoapIn" />
<wsdl:output message="tns:IsABAAccountNumberValidSoapOut" />
</wsdl:operation>
- <wsdl:operation name="AddBill">
<wsdl:input message="tns:AddBillSoapIn" />
<wsdl:output message="tns:AddBillSoapOut" />
</wsdl:operation>
- <wsdl:operation name="GetBill">
<wsdl:input message="tns:GetBillSoapIn" />
<wsdl:output message="tns:GetBillSoapOut" />
</wsdl:operation>
- <wsdl:operation name="UpdateBill">
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 96 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 97 of 126
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetRecurringPayment">
<soap:operation soapAction="http://webservice.cleartran.net/GetRecurringPayment" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="UpdateRecurringPayment">
<soap:operation soapAction="http://webservice.cleartran.net/UpdateRecurringPayment" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="DeleteRecurringPayment">
<soap:operation soapAction="http://webservice.cleartran.net/DeleteRecurringPayment" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetBankInformation">
<soap:operation soapAction="http://webservice.cleartran.net/GetBankInformation" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetCardHolderInformation">
<soap:operation soapAction="http://webservice.cleartran.net/GetCardHolderInformation" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetCreditCard">
<soap:operation soapAction="http://webservice.cleartran.net/GetCreditCard" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="IsACHABA">
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 98 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 99 of 126
- <wsdl:input name="AuthorizeExistingCheckTransaction">
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output name="AuthorizeExistingCheckTransaction">
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetCheckTransaction">
<soap:operation soapAction="http://webservice.cleartran.net/GetCheckTransaction" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetCheckTransactions">
<soap:operation soapAction="http://webservice.cleartran.net/GetCheckTransactions" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="DeleteCheckTransaction">
<soap:operation soapAction="http://webservice.cleartran.net/DeleteCheckTransaction" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="AddCheckCreditTransaction">
<soap:operation soapAction="http://webservice.cleartran.net/AddCheckCreditTransaction" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="AddCreditCardTransaction">
<soap:operation soapAction="http://webservice.cleartran.net/AddCreditCardTransaction" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="AddCreditCardTransaction">
<soap:operation soapAction="http://webservice.cleartran.net/UpdateAndResubmitCreditCardTransaction"
style="document" />
- <wsdl:input name="UpdateAndResubmitCreditCardTransaction">
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output name="UpdateAndResubmitCreditCardTransaction">
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 100 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 101 of 126
- <wsdl:operation name="AddCreditCardCreditTransaction">
<soap:operation soapAction="http://webservice.cleartran.net/AddFullCreditCardCredit" style="document" />
- <wsdl:input name="AddFullCreditCardCredit">
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output name="AddFullCreditCardCredit">
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="AddPaymentProfile">
<soap:operation soapAction="http://webservice.cleartran.net/AddPaymentProfile" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="AddCustomerRecord">
<soap:operation soapAction="http://webservice.cleartran.net/AddCustomerRecord" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetPaymentProfile">
<soap:operation soapAction="http://webservice.cleartran.net/GetPaymentProfile" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetPaymentProfile">
<soap:operation soapAction="http://webservice.cleartran.net/GetPaymentProfileByID" style="document" />
- <wsdl:input name="GetPaymentProfileByID">
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output name="GetPaymentProfileByID">
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetCustomerRecord">
<soap:operation soapAction="http://webservice.cleartran.net/GetCustomerRecord" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="UpdatePaymentProfile">
<soap:operation soapAction="http://webservice.cleartran.net/UpdatePaymentProfile" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 102 of 126
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="UpdateCustomerRecord">
<soap:operation soapAction="http://webservice.cleartran.net/UpdateCustomerRecord" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="DeletePaymentProfile">
<soap:operation soapAction="http://webservice.cleartran.net/DeletePaymentProfile" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="DeletePaymentProfile">
<soap:operation soapAction="http://webservice.cleartran.net/DeletePaymentProfileByID" style="document" />
- <wsdl:input name="DeletePaymentProfileByID">
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output name="DeletePaymentProfileByID">
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="DeleteCustomerRecord">
<soap:operation soapAction="http://webservice.cleartran.net/DeleteCustomerRecord" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetOptionValue">
<soap:operation soapAction="http://webservice.cleartran.net/GetOptionValue" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetOptionValues">
<soap:operation soapAction="http://webservice.cleartran.net/GetOptionValues" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="CalculateConvenienceFee">
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 103 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 104 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 105 of 126
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="AddBill">
<soap:operation soapAction="http://webservice.cleartran.net/AddBill" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetBill">
<soap:operation soapAction="http://webservice.cleartran.net/GetBill" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="UpdateBill">
<soap:operation soapAction="http://webservice.cleartran.net/UpdateBill" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="DeleteBill">
<soap:operation soapAction="http://webservice.cleartran.net/DeleteBill" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetBills">
<soap:operation soapAction="http://webservice.cleartran.net/GetBills" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetBillHTML">
<soap:operation soapAction="http://webservice.cleartran.net/GetBillHTML" style="document" />
- <wsdl:input>
<soap:body use="literal" />
</wsdl:input>
- <wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name="GetBillPDF">
<soap:operation soapAction="http://webservice.cleartran.net/GetBillPDF" style="document" />
- <wsdl:input>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 106 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 107 of 126
<wsdl:service name="ClearTranWebService">
<wsdl:port name="ClearTranWebServiceSoap" binding="tns:ClearTranWebServiceSoap">
<soap:address
location="https://cleartran.qa.mellon.com/qa_ws_centralizedtesting_a/ClearTranWebService.asmx" />
</wsdl:port>
<wsdl:port name="ClearTranWebServiceHttpGet" binding="tns:ClearTranWebServiceHttpGet">
<http:address
location="https://cleartran.qa.mellon.com/qa_ws_centralizedtesting_a/ClearTranWebService.asmx" />
</wsdl:port>
<wsdl:port name="ClearTranWebServiceHttpPost" binding="tns:ClearTranWebServiceHttpPost">
<http:address
location="https://cleartran.qa.mellon.com/qa_ws_centralizedtesting_a/ClearTranWebService.asmx" />
</wsdl:port>
</wsdl:service
</wsdl:definitions>
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 108 of 126
Error
Error Description
Code
100 Invalid Field Length
101 Invalid Check Date
102 Invalid Account Number
103 Invalid Check ABA Number
104 Invalid Check Amount
105 Invalid Check Name1
106 Invalid Payto Name
107 Invalid Check Fee
108 Invalid Check Date Posted
109 Check Amount > MaxCheckAmount (MaxCheckAmount replaced by actual number)
110 Invalid Check Number
111 Invalid Option
112 Invalid MICR Line
113 Invalid Group ID
114 Invalid Requestor
115 Invalid ZipCode
116 Invalid Check Surcharge
117 Invalid Check Additional Principal
118 Invalid Transaction Type
119 Invalid Memo
120 Invalid CustomerID
121 Invalid Reference Code
122 Invalid Street
123 Invalid City
124 Invalid State
125 Invalid UDK1
126 Invalid UDK2
127 Invalid UDK3
128 Invalid SSN.
129 Invalid DOB.
130 Invalid Phone Number
131 Invalid Drivers License
132 Invalid Check Type
133 Invalid Station ID
134 Invalid ACH Entry Class
135 Invalid Transaction Source Code
136 Invalid Email Address
137 Invalid Sales Tax
150 Invalid Method Call for current Mode
160 Batch Not Found.
180 Duplicate ACH Profile.
200 Record Not Found.
201 Can't Edit a frozen check.
300 Duplicate Check encountered
301 Credit Not Allowed on non-ACHable Check
302 Credit Not Allowed on Unprinted Check
303 No Further Credits Allowed on Check
304 Credit Only Allowed on Debit Check
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 109 of 126
Error
Error Description
Code
305 Can Only Edit a Credit
306 Credit Not Allowed When a Hard Return Exists
307 ABA/Account Number is blocked
308 CustomerID is blocked
309 ReferenceCode is blocked
310 UDK1 is blocked
311 UDK2 is blocked
312 UDK3 is blocked
313 Credit can not be issued using alternate ABA logic. Option not enabled.
315 ABA/Account Number is invalid
400 Can't Authorize a Frozen Check. Already Printed or Authorized.
401 Invalid Authorization Status.
501 Duplicate Customer ID.
502 Invalid Settled Date.
600 Duplicate Username.
601 Invalid Username.
700 Duplicate Group Name.
701 Invalid Group Name.
803 Invalid Credit Amount
901 Invalid Login Account.
902 Not Logged In.
903 Already Logged In.
904 Password Expired.
905 Password Change Failure
906 Invalid Permissions for Current Operation.
907 ACH Credits Not Enabled.
908 Check Date Exceeds Max Post Date Value.
909 Check Date Does Not Exceed Min Pre-Date Value.
910 Unable to Connect to Electronic Receivable Payment services
911 Unable to Read System Information
912 Unable to Read Payto Information.
913 Connection to Database lost.
915 Max Users Exceeded
916 Convenience fee not enabled.
920 Electronic Receivable Payment services Application not initialized
925 No Checks Remaining in meter
930 No Printer
935 File Not Found.
936 Invalid Filename.
945 Internal Error.
950 Program Expired
960 Database version older than software version.
975 Authorization Service Not Found.
976 Send Receipt Failed.
980 Custom Output DLL not found.
990 Invalid Operation
999 Invalid System Information
1100 Record number parameter missing in GetLastACHReturn
1101 Check information missing
1102 Invalid ClientID
1103 Check credit information missing.
1104 Credit card information missing.
1005 Customer information missing.
1006 CustomerID Missing
1107 Option value missing
1108 Payto name missing.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 110 of 126
Error
Error Description
Code
1109 Dollar amount exceeds 20 bytes after formatting.
1110 Invalid lookup field type
1111 Invalid status for a transaction resubmission. Transaction must have an “E” error status.
1112 Cannot delete a frozen check
1113 Reason required for field level transaction blocking.
1114 Invalid Where Clause.
1115 Split amounts do not match transaction amount.
1116 Invalid Split Amount.
1200 PaymentProfile Name Required.
1201 Payment Profile AccountNumber Required.
1202 Payment Profile Type Required.
1203 Duplicate Payment Profile Name.
1204 Payment Profile ABA Required.
1205 Payment Profile Check Type Required.
1206 Payment Profile Processing Type Must Be Assigned.
1208 Payment Profile CustomerID Required.
1209 Payment Profile Street Required.
1210 Payment Profile City Required.
1211 Payment Profile State Required.
1212 Payment Profile Name1 Required.
1213 Payment Profile First Name Required.
1214 Payment Profile Last Name Required.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 111 of 126
Error
Error Description
Code
20000 Card Number Supplied must be a numeric values only.
20001 Card Number Supplied 16 digits ( 15 AMEX ).
20002 Card Number Supplied failed the MOD10 check.
20003 Can Only Credit Settled Transactions. StatusCode = ‘S’
20010 Amount supplied must be numeric.
20011 Transaction Amount must between $0.99 and $99,999.99.
20011 Transaction Amount must between $0.00 and $99,999.99 for VISA authorization reversal transactions.
20021 Authorization Code must be between 1 and 999999.
20030 Zipcode must be either 5 or 9 digits.
20031 Zipcode must be numeric digits.
20061 Must set the card type before this transaction can be submitted.
20062 Must set the Terminal number before this transaction can be submitted.
20063 Must set the Merchant number before this transaction can be submitted.
20064 Must set the Client number before this transaction can be submitted.
20065 Must set the account number before this transaction can be submitted.
20066 Must set the transaction amount before this transaction can be submitted.
20067 Must set the authorization code before a prior force sale/VISA authorization transaction type can be
submitted.
20068 Must set the address property before this transaction can be submitted.
20069 Must set the address property before this transaction can be submitted.
20070 Must set the Industry Code adding a transaction to this collection.
20071 Must set the Processing Center adding a transaction to this collection.
20072 Order Number is required.
20073 ECommerce Indicator is required.
20074 Order Type is required.
20075 Must set the expiration date of the credit card before this transaction can be submitted.
20076 Must set the RetrievalReferenceNumber property to the ResponseRetReferNumber of the transaction that
is to be voided.
20077 Must set the LastRetrievalReferenceNumber property to the ResponseRetReferNumber of the prevoiusly
executed transaction.
20078 Must set the CVV2 presence indicator for VISA card transactions.
20079 Must set the CVV2 Indicator for VISA card transactions.
20210 Order Number supplied must be numeric.
20211 Order Number must be betweeen 0 and 999999999.
20212 Batch Number supplied must be numeric.
20213 Batch Number must be betweeen 0 and 999999.
20214 Retrieval Reference Number supplied must be numeric.
20215 Retrieval Reference Number must be betweeen 0 and 9999999.
20216 Last Retrieval Reference Number supplied must be numeric.
20217 Last Retrieval Reference Number must be betweeen 0 and 9999999
20700 This transaction batch has already been submitted.
20701 CVV2 Indicator supplied must be numeric.
20702 CVV2 Indicator must be betweeen 0000 and 9999.
20703 Transaction Type is not supported by <Processor Name >
20704 Expiration Date must be provided in the following format MM/YY. Month digits are not within the proper
range.
20705 Expiration Date must be provided in the following format MM/YY. Year digits are not within the valid range
( 00 - 32 ).
20706 Expiration Date must be provided in the following format MM/YY.
20707 Must set transaction type.
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 112 of 126
Error
Error Description
Code
20708 Unable able to connect to processor.
21001 Error occurred retreiving transac tion type description.
21002 No open batches exist.
21003 Failed to open batch.
21004 Unexpected error occurred retrieving credit card information.
21005 Unexpected error occurred retrieving transaction information.
21006 Error occurred executing database query.
21007 Error occurred executing database query.
21008 Error occurred executing database query.
21009 Error occurred executing database query.
21010 Unexpected Error occurred loading INI file.
21016 PayToID cannot be found with the PayToName provided.
21111 Credit card has expired.
21102 Must supply an amount.
21103 Must supply an expiration date.
21104 Must supply an order number.
21105 Must supply the transaction type.
21106 Must supply a credit card number.
21107 Must supply the transaction type.
21110 Invalid value supplied for transaction type property.
21120 Invalid credit card number. Please re-enter number.
21121 Card Number Supplied 16 digits ( 15 AMEX ).
21122 Zip code must be 5 digits.
21123 Expiration Date must be provided in the following format MM/YY. Month digits are not within the valid
range( 0 - 12 ).
21124 Expiration Date must be provided in the following format MM/YY. Year digits are not within the valid range
( 00 - 32 ).
21125 Expiration Date must be provided in the following format MM/YY.
Failed to acquire unique ID from Electronic Receivable Payment services database. Credit Card Update
21126 failed.
21127 Unexpected error.
21128 City must be lesss than or equal to 25 characters.
21129 State must be equal to 2 characters.
21130 Street must be less than or equal to 40 characters.
21131 Customer ID must be less than or equal to 32 characters.
21132 Reference Code must be less than or equal to 32 characters.
21133 User Defined Key 1 must be less than or equal to 8 characters.
21134 User Defined Key 2 must be less than or equal to 16 characters.
21135 User Defined Key 3 must be less than or equal to 32 characters.
21136 This transaction cannot be voided at this time.
21137 A deleted transaction cannot be vioded.
21138 Transaction cannot be voided because it has already been settled.
21139 Unexpected error occurred during manual approval.
21140 Unexpected error occurred during attempt to void a transaction.
21141 Unexpected error occurred during attempt to load the transaction object.
21142 Credit Card Validation Error
21147 Invalid Transaction Source.
21400 Undefined Error or Undefined Error retrieving Credit Card Transaction ID:
21401 Undefined Error or Undefined Error retrieving Batch ID
21402 Invalid property value found for the PhoneNumber entry in the INI FILE under section [Processor Name]
21403 Invalid property value found for the Industry entry in the INI FILE under section [Processor Name]
21404 Invalid property value found for the ClientNumber entry in the INI FILE under section [Processor Name]]
21405 Invalid property value found for the TerminalNumber entry in the INI FILE under section [Processor Name]
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 113 of 126
Error
Error Description
Code
21406 Invalid property value found for the MerchantNumber entry in the INI FILE under section [Processor Name]
21407 Invalid property value found for the ECommerceIndicator entry in the INI FILE under section [Processor
Name]
21408 Invalid property value found for the TerminalType entry in the INI FILE under section [Processor Name]
21409 Invalid property value found for the BankIDNumber entry in the INI FILE under section [Processor Name]
21410 Invalid property value found for the CommPort entry in the INI FILE under section [Processor Name]
21411 Invalid status for a transaction resubmission. Transaction must have an “E” error status.
Failed to acquire unique ID from Electronic Receivable Payment services database. Batch Info Update
22001 failed."
22003 Can only credit settled transactions (Status Code = S)
22007 Original transaction could not be found.
22008 Duplicate transaction encountered.
22009 Credits can only be performed on purchases.
22010 Processor Error Message. See Error Message for exact Error Code.
22011 Submission failed. Indicates that the processor did not approve the transaction, and that no action code
was returned. Can also indicate that the CC comm driver is not installed properly.
22012 Transaction cannot be reversed because it has already been settled
Error
Error Description
Code
00 User authenticated
01 Approved
02 Hard negative information on file
03 Over maximum face value or excessive activity
04 Invalid identification or id/DOB mismatch
05 Authentication system not available or face value exceeds max
10 Failed authentication
11 Failed authentication by score
12 Failed authentication by score
91 Invalid transaction id
92 Invalid amount
93 Invalid merchant id
94 Transaction aborted
95 System unavailable
96 Warranty limit exceeded
97 Invalid check information
98 Invalid station id
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 114 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 115 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 116 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 117 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 118 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 119 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 120 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 121 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 122 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 123 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 124 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 125 of 126
©2013 The Bank of New York Mellon Corporation – All Rights Reserved page 126 of 126