Difference between revisions of "API/Account/StoreBankDetails"

Latest revision as of 12:44, 5 July 2016

Purpose

The purpose of this API call is to permit the caller to store bank account details on behalf of their customer..

WSDL: AccountAPI.wsdl

Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <acc:StoreBankDetails>
        <acc:AccountID>9999999</acc:AccountID>
        <acc:AutomatedPaymentConfig>StoreOverrideAndEnable</acc:AutomatedPaymentConfig>
        <acc:BankAccountName>test</acc:BankAccountName>
        <acc:BankAccountBSB>999999</acc:BankAccountBSB>
        <acc:BankAccountNumber>999999999</acc:BankAccountNumber>
        <acc:Bank>9999</acc:Bank>
     </acc:StoreBankDetails>
  </soapenv:Body>

Output

  <SOAP-ENV:Body>
     <ns1:storeBankDetailsResponse>
        <ns1:Token>9999999999999999999</ns1:Token>
     </ns1:storeBankDetailsResponse>
  </SOAP-ENV:Body>

Error Strings

• "Missing Account ID" - Customer Account ID is not provided
• "Invalid Format for Account ID" - Customer Account ID is in Invalid Format (Either non-numeric or exceeding 17 digits)
• "Provided Account ID does not exist" - Provided Account ID does not exist in the system
• "Account ID should be a child of Calling Account" - Account ID provided is not a child account of the Calling Customer Account
• "Missing Automated Payment Config" - Automated Payment Config Flag is not provided
• "Value of Automated Payment Config should be StoreOnly, StoreAndOverride or StoreOverrideAndEnable" - Value of Automated Payment Config Flag is not in predefined values
• "Missing Bank Account Name" - Bank Account Name is not provided
• "Bank Account Name should be limited to 48 characters" - Bank Account Name provided exceeds the allowed limit of 48 characters
• "Missing Bank Account BSB" - Bank Account BSB is not provided
• "Bank Account BSB should consist of 6 digits" - Bank Account BSB length is not 6
• "BSB should not contain non-numeric characters" - BSB contains non-digits
• "Missing Bank Account Number" - Bank Account Number is not provided
• "Bank Account Number should be limited to 24 characters" - Bank Account Number provided exceeds the allowed limit of 24 characters
• "Bank Account Number should not contain non-numeric characters" - Bank Account Number contains non-digits
• "Bank not found by Bank ID" - Parameter Bank is provided as an Integer; however, such a Bank ID does not exist in the system
• "Bank not found by Bank Name" - Parameter Bank is provided as a string; however, such a Bank Name does not exist in the system
• "Direct Debit Payment Gateway Map Not Found for Customer" - There is no Valid Direct Debit Payment Gateway Map for the Customer
• "Please contact Emersion Support with details of your request" - Unable to connect to EPS due to Server Side or Connectivity issues