Overview

RetrieveBlockedAccounts is a web service method allowing an external system to search for blocked bank accounts using a date range.

Input

From your application call:

FieldExplanation
Service KeyDebit Order Service Key
Start_dateCCYYMMDD
End_dateCCYYMMDD

Output

Failed requests will return one of the following codes.

 Numeric ResponseDescription
000Success

Successful

requests will return

FieldValue
AccountNameAN
AccountNumberN
ActionDateN
BankAccountNumberN
BlackListTypeA
BranchCodeN
DateBlockedN
DescriptionAN
UnpaidCodeN

Examples

Request

<RetrieveBlockedAccounts>
 <MethodParameters>
   <ServiceKey>B06317BA-XXX-4295-AAAA-E16A01234950</ServiceKey>
   <StartDate>20250601</StartDate>
   <EndDate>20250610</EndDate>
 </MethodParameters>
</RetrieveBlockedAccounts>

Response

<RetrieveBlockedAccounts>
  <MethodParameters>
    <RetrieveBlockedAccountsResponse>
      <BlockedAccounts>
        <BlockedAccount>
          <AccountName>ABC SHOES</AccountName>
          <AccountNumber>52100000076</AccountNumber>
          <ActionDate>20250601</ActionDate>
          <BankAccountNumber>1310XXXX36</BankAccountNumber>
          <BlackListType>Consecutive Unpaids</BlackListType>
          <BranchCode>632005</BranchCode>
          <DateBlocked>20250602</DateBlocked>
          <Description>RZAB500 - MR XYZ - Code: 2</Description>
          <UnpaidCode>2</UnpaidCode>
        </BlockedAccount>
        <BlockedAccount>
          <AccountName>ABC SHOES</AccountName>
          <AccountNumber>52100000076</AccountNumber>
          <ActionDate>20250602</ActionDate>
          <BankAccountNumber>127XXXXX85</BankAccountNumber>
          <BlackListType>Consecutive Unpaids</BlackListType>
          <BranchCode>632005</BranchCode>
          <DateBlocked>20250603</DateBlocked>
          <Description>RZ5XX2PL - MRS YZ - Code: 2</Description>
          <UnpaidCode>2</UnpaidCode>
        </BlockedAccount>
      </BlockedAccounts>
      <ErrorCode>000</ErrorCode>
    </RetrieveBlockedAccountsResponse>
  </MethodParameters>
</RetrieveBlockedAccounts>

If there are no records, then only display “There are no records to display”

Should the request be unsuccessful, the following code(s)

CodeDescription
100Authentication error (Service key supplied is not valid and active or the Account or service is not Active)
200General web service error, contact support.

Netcash brand guidelines

Please refer to the Netcash brand guidelines here when using any logos, images, icons, labels, descriptions, and references to Netcash in your software.

Testing

See the Testing section for more details. If you require any integration assistance contact our technical support team

Netcash may provide example/sample/demo ‘code snippets’ and/or external links in this Technical Document. Such are for guidance purposes only and may not function on every developer’s system/s. Netcash disclaims any and all liability for the usage of guidance resources provided -and you as the Developer; must accept full responsibility for the usage of such. While every possible effort has been taken to ensure compatibility across multiple system configurations, the contents of this document cannot be guaranteed to work on all systems, with all operating systems -and/or with all system configuration/s.