Web Service: CreateValidatedCheck

Bret Hillbun -

Overview

Create a new transaction in the system. This service can be used to create check with or without images. If images are sent, the transaction will be routed via the Check21 system if possible. The check will first be run through the check verification system (see ValidateCheck for more information) and will only create the new transaction if the verification system comes back Approved.  This method effectively combines both ValidateCheck and CreateCheck into a single method call.

Security

The user must have the Gateway.E-Check role (for transactions without images) or the Gateway.Check21 role (for transactions with images); and the ClientID must be in the Client Tree for the authenticated user.

 

SOAP Service

Request

<CreateValidatedCheck xmlns="https://gateway.acheck21.com/GlobalGateway/">
    <Username>string</Username>
    <Password>string</Password>
    <ClientID>string</ClientID>
    <ClientTag>string</ClientTag>
    <IndividualName>string</IndividualName>
    <CheckNumber>string</CheckNumber>
    <TransitNumber>string</TransitNumber>
    <DDANumber>string</DDANumber>
    <AccountType>Checking, Savings, or GeneralLedger</AccountType>
    <CheckAmount>string</CheckAmount>
    <EntryClass>TELPPDARCRCKCCDWEB or BOC</EntryClass>
    <FrontImage>Base64-encoded TIFF G4 image @200bpi</FrontImage>
    <RearImage>Base64-encoded TIFF G4 image @200bpi</RearImage>
    <MICR>Optional – string</MICR>
    <DLNumber>string</DLNumber>
    <PhoneNumber>string</PhoneNumber>
    <PostingDate>Optional – datetime</PostingDate>
    <Addenda>
        <Addendum>value</Addendum>
    </Addenda>
</CreateValidatedCheck>

Response

<CreateValidatedCheckResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
<CreateValidatedCheckResult>     <Code>int</Code>      <Message>string</Message>     <ValidationData>          <Response>Authorized or Declined or Warning or Error</Response>         <AuthorizationCode>string</AuthorizationCode>          <DetailLines>              <string>string</string>             ...              <string>string</string>          </DetailLines>      </ValidationData>     <CreateData>          <CheckID>int</CheckID>      </CreateData> </CreateValidatedCheckResult>
</CreateValidatedCheckResponse>

 

REST Service

No REST support, please use a combination of ValidateCheck and CreateCheck to achieve the desired results.

 

Have more questions? Submit a request

Comments