Reference for https://payments.usiopay.com/2.0/payments.svc/JSON/GetACHReturns

Url: https://payments.usiopay.com/2.0/payments.svc/JSON/GetACHReturns

HTTP Method: POST

Message direction Format Body
Request Xml Example,Schema
Request Json Example
Response Xml Example,Schema
Response Json Example

The following is an example request Xml body:

<ACHReturnsRequest xmlns="http://schemas.datacontract.org/2004/07/">
  <IncludeTransactionDetails>true</IncludeTransactionDetails>
  <Login>String content</Login>
  <MerchantID>String content</MerchantID>
  <Password>String content</Password>
  <ReturnDate>String content</ReturnDate>
</ACHReturnsRequest>

The following is an example request Json body:

{
	"IncludeTransactionDetails":true,
	"Login":"String content",
	"MerchantID":"String content",
	"Password":"String content",
	"ReturnDate":"String content"
}

The following is an example response Xml body:

<ACHReturnsResponse xmlns="http://schemas.datacontract.org/2004/07/">
  <Status>String content</Status>
  <Message>String content</Message>
  <CreditCount>2147483647</CreditCount>
  <CreditAmount>12678967.543233</CreditAmount>
  <DebitCount>2147483647</DebitCount>
  <DebitAmount>12678967.543233</DebitAmount>
  <Transactions>
    <ACHReturnsResponse.ACHReturnTransaction>
      <ConfirmationID>String content</ConfirmationID>
      <ReturnCode>String content</ReturnCode>
      <NOCMessage>String content</NOCMessage>
      <ExtendedFields>
        <ACHOpt1>String content</ACHOpt1>
        <AccountCode1>String content</AccountCode1>
        <AccountCode2>String content</AccountCode2>
        <AccountCode3>String content</AccountCode3>
        <AccountMask>String content</AccountMask>
        <AccountType>String content</AccountType>
        <AdditionalSearch>String content</AdditionalSearch>
        <Address1>String content</Address1>
        <Address2>String content</Address2>
        <Amount>12678967.543233</Amount>
        <City>String content</City>
        <EmailAddress>String content</EmailAddress>
        <FirstName>String content</FirstName>
        <LastName>String content</LastName>
        <MerchantPayAccount>String content</MerchantPayAccount>
        <PaymentAccountID>String content</PaymentAccountID>
        <SecondaryAmount>12678967.543233</SecondaryAmount>
        <State>String content</State>
        <SubmitDate>String content</SubmitDate>
        <TransactionCode>String content</TransactionCode>
        <Zip>String content</Zip>
      </ExtendedFields>
    </ACHReturnsResponse.ACHReturnTransaction>
    <ACHReturnsResponse.ACHReturnTransaction>
      <ConfirmationID>String content</ConfirmationID>
      <ReturnCode>String content</ReturnCode>
      <NOCMessage>String content</NOCMessage>
      <ExtendedFields>
        <ACHOpt1>String content</ACHOpt1>
        <AccountCode1>String content</AccountCode1>
        <AccountCode2>String content</AccountCode2>
        <AccountCode3>String content</AccountCode3>
        <AccountMask>String content</AccountMask>
        <AccountType>String content</AccountType>
        <AdditionalSearch>String content</AdditionalSearch>
        <Address1>String content</Address1>
        <Address2>String content</Address2>
        <Amount>12678967.543233</Amount>
        <City>String content</City>
        <EmailAddress>String content</EmailAddress>
        <FirstName>String content</FirstName>
        <LastName>String content</LastName>
        <MerchantPayAccount>String content</MerchantPayAccount>
        <PaymentAccountID>String content</PaymentAccountID>
        <SecondaryAmount>12678967.543233</SecondaryAmount>
        <State>String content</State>
        <SubmitDate>String content</SubmitDate>
        <TransactionCode>String content</TransactionCode>
        <Zip>String content</Zip>
      </ExtendedFields>
    </ACHReturnsResponse.ACHReturnTransaction>
  </Transactions>
</ACHReturnsResponse>

The following is an example response Json body:

{
	"Status":"String content",
	"Message":"String content",
	"CreditCount":2147483647,
	"CreditAmount":12678967.543233,
	"DebitCount":2147483647,
	"DebitAmount":12678967.543233,
	"Transactions":[{
		"ConfirmationID":"String content",
		"ReturnCode":"String content",
		"NOCMessage":"String content",
		"ExtendedFields":{
			"ACHOpt1":"String content",
			"AccountCode1":"String content",
			"AccountCode2":"String content",
			"AccountCode3":"String content",
			"AccountMask":"String content",
			"AccountType":"String content",
			"AdditionalSearch":"String content",
			"Address1":"String content",
			"Address2":"String content",
			"Amount":12678967.543233,
			"City":"String content",
			"EmailAddress":"String content",
			"FirstName":"String content",
			"LastName":"String content",
			"MerchantPayAccount":"String content",
			"PaymentAccountID":"String content",
			"SecondaryAmount":12678967.543233,
			"State":"String content",
			"SubmitDate":"String content",
			"TransactionCode":"String content",
			"Zip":"String content"
		}
	}]
}

The following is the request Xml Schema:

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="ACHReturnsRequest">
    <xs:sequence>
      <xs:element minOccurs="0" name="IncludeTransactionDetails" type="xs:boolean" />
      <xs:element minOccurs="0" name="Login" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="MerchantID" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Password" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="ReturnDate" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ACHReturnsRequest" nillable="true" type="tns:ACHReturnsRequest" />
</xs:schema>

Additional request Xml Schemas:

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
  <tns:element name="schema">
    <tns:complexType />
  </tns:element>
</tns:schema>

The following is the response Xml Schema:

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="ACHReturnsResponse">
    <xs:sequence>
      <xs:element minOccurs="0" name="Status" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="CreditCount" type="xs:int" />
      <xs:element minOccurs="0" name="CreditAmount" type="xs:decimal" />
      <xs:element minOccurs="0" name="DebitCount" type="xs:int" />
      <xs:element minOccurs="0" name="DebitAmount" type="xs:decimal" />
      <xs:element minOccurs="0" name="Transactions" nillable="true" type="tns:ArrayOfACHReturnsResponse.ACHReturnTransaction" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ACHReturnsResponse" nillable="true" type="tns:ACHReturnsResponse" />
  <xs:complexType name="ArrayOfACHReturnsResponse.ACHReturnTransaction">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="ACHReturnsResponse.ACHReturnTransaction" nillable="true" type="tns:ACHReturnsResponse.ACHReturnTransaction" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfACHReturnsResponse.ACHReturnTransaction" nillable="true" type="tns:ArrayOfACHReturnsResponse.ACHReturnTransaction" />
  <xs:complexType name="ACHReturnsResponse.ACHReturnTransaction">
    <xs:sequence>
      <xs:element minOccurs="0" name="ConfirmationID" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="ReturnCode" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="NOCMessage" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="ExtendedFields" nillable="true" type="tns:ACHReturnsResponse.ACHReturnTransaction.ACHReturnTransactionExtendedFields">
        <xs:annotation>
          <xs:appinfo>
            <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
          </xs:appinfo>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ACHReturnsResponse.ACHReturnTransaction" nillable="true" type="tns:ACHReturnsResponse.ACHReturnTransaction" />
  <xs:complexType name="ACHReturnsResponse.ACHReturnTransaction.ACHReturnTransactionExtendedFields">
    <xs:sequence>
      <xs:element minOccurs="0" name="ACHOpt1" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="AccountCode1" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="AccountCode2" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="AccountCode3" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="AccountMask" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="AccountType" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="AdditionalSearch" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Address1" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Address2" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Amount" type="xs:decimal" />
      <xs:element minOccurs="0" name="City" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="EmailAddress" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="FirstName" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="LastName" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="MerchantPayAccount" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="PaymentAccountID" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="SecondaryAmount" type="xs:decimal" />
      <xs:element minOccurs="0" name="State" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="SubmitDate" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="TransactionCode" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Zip" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ACHReturnsResponse.ACHReturnTransaction.ACHReturnTransactionExtendedFields" nillable="true" type="tns:ACHReturnsResponse.ACHReturnTransaction.ACHReturnTransactionExtendedFields" />
</xs:schema>

Additional response Xml Schemas:

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
  <tns:element name="schema">
    <tns:complexType />
  </tns:element>
</tns:schema>