H2OAPIv20 Web Service

H2OAPIv20

Click here for a complete list of operations.

Payments_Create

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v20/default.asmx HTTP/1.1
Host: api.rev.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.myh2o.com/v20/Payments_Create"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Payments_Create xmlns="http://api.myh2o.com/v20">
      <Request>
        <Credentials>
          <Username>string</Username>
          <Password>string</Password>
          <Client>string</Client>
          <ImpersonationKey>string</ImpersonationKey>
        </Credentials>
        <Session>
          <SessionKey>string</SessionKey>
        </Session>
        <Debug>boolean</Debug>
        <CustomerID>int</CustomerID>
        <Amount>decimal</Amount>
        <Options>
          <AgentID>int</AgentID>
          <Method>string</Method>
          <AgentNumber>string</AgentNumber>
          <ReceivedDate>dateTime</ReceivedDate>
          <ReferenceNumber>string</ReferenceNumber>
        </Options>
        <CreditCard>
          <NameOnCard>string</NameOnCard>
          <CreditCardNumber>string</CreditCardNumber>
          <ExpirationDate>dateTime</ExpirationDate>
          <CVV2>string</CVV2>
          <PaymentAccountID>int</PaymentAccountID>
        </CreditCard>
        <ACH>
          <NameOnAccount>string</NameOnAccount>
          <AccountNumber>string</AccountNumber>
          <RoutingNumber>string</RoutingNumber>
          <Type>CHECKING or SAVINGS</Type>
          <PaymentAccountID>int</PaymentAccountID>
        </ACH>
        <Type>CREDIT_CARD or ACH or MANUAL or MANUAL_ELECTRONIC</Type>
        <ManualElectronic>
          <AuthCode>string</AuthCode>
          <EBillingProfileID>int</EBillingProfileID>
          <MerchantProfileID>int</MerchantProfileID>
        </ManualElectronic>
      </Request>
    </Payments_Create>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Payments_CreateResponse xmlns="http://api.myh2o.com/v20">
      <Payments_CreateResult>
        <Header>
          <Success>boolean</Success>
          <Message>string</Message>
          <SessionKey>string</SessionKey>
          <Impersonated>boolean</Impersonated>
          <Error_Code>string</Error_Code>
          <Error_Description>string</Error_Description>
        </Header>
        <Debug>
          <Request>
            <Credentials>
              <Username>string</Username>
              <Password>string</Password>
              <Client>string</Client>
              <ImpersonationKey>string</ImpersonationKey>
            </Credentials>
            <Session>
              <SessionKey>string</SessionKey>
            </Session>
            <Debug>boolean</Debug>
            <CustomerID>int</CustomerID>
            <Amount>decimal</Amount>
            <Options>
              <AgentID>int</AgentID>
              <Method>string</Method>
              <AgentNumber>string</AgentNumber>
              <ReceivedDate>dateTime</ReceivedDate>
              <ReferenceNumber>string</ReferenceNumber>
            </Options>
            <CreditCard>
              <NameOnCard>string</NameOnCard>
              <CreditCardNumber>string</CreditCardNumber>
              <ExpirationDate>dateTime</ExpirationDate>
              <CVV2>string</CVV2>
              <PaymentAccountID>int</PaymentAccountID>
            </CreditCard>
            <ACH>
              <NameOnAccount>string</NameOnAccount>
              <AccountNumber>string</AccountNumber>
              <RoutingNumber>string</RoutingNumber>
              <Type>CHECKING or SAVINGS</Type>
              <PaymentAccountID>int</PaymentAccountID>
            </ACH>
            <Type>CREDIT_CARD or ACH or MANUAL or MANUAL_ELECTRONIC</Type>
            <ManualElectronic>
              <AuthCode>string</AuthCode>
              <EBillingProfileID>int</EBillingProfileID>
              <MerchantProfileID>int</MerchantProfileID>
            </ManualElectronic>
          </Request>
        </Debug>
        <ID>int</ID>
        <Options>
          <AgentID>int</AgentID>
          <Method>string</Method>
          <AgentNumber>string</AgentNumber>
          <ReceivedDate>dateTime</ReceivedDate>
          <ReferenceNumber>string</ReferenceNumber>
        </Options>
        <CreditCardResult>
          <Message>string</Message>
          <TransactionNumber>string</TransactionNumber>
          <AuthCode>string</AuthCode>
          <Approved>boolean</Approved>
          <EBillingProfileID>int</EBillingProfileID>
          <MerchantProfileID>int</MerchantProfileID>
          <PaymentLogID>int</PaymentLogID>
        </CreditCardResult>
        <ACHResult>
          <Message>string</Message>
          <TransactionNumber>string</TransactionNumber>
          <AuthCode>string</AuthCode>
          <Approved>boolean</Approved>
          <EBillingProfileID>int</EBillingProfileID>
          <MerchantProfileID>int</MerchantProfileID>
          <PaymentLogID>int</PaymentLogID>
        </ACHResult>
      </Payments_CreateResult>
    </Payments_CreateResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v20/default.asmx HTTP/1.1
Host: api.rev.io
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Payments_Create xmlns="http://api.myh2o.com/v20">
      <Request>
        <Credentials>
          <Username>string</Username>
          <Password>string</Password>
          <Client>string</Client>
          <ImpersonationKey>string</ImpersonationKey>
        </Credentials>
        <Session>
          <SessionKey>string</SessionKey>
        </Session>
        <Debug>boolean</Debug>
        <CustomerID>int</CustomerID>
        <Amount>decimal</Amount>
        <Options>
          <AgentID>int</AgentID>
          <Method>string</Method>
          <AgentNumber>string</AgentNumber>
          <ReceivedDate>dateTime</ReceivedDate>
          <ReferenceNumber>string</ReferenceNumber>
        </Options>
        <CreditCard>
          <NameOnCard>string</NameOnCard>
          <CreditCardNumber>string</CreditCardNumber>
          <ExpirationDate>dateTime</ExpirationDate>
          <CVV2>string</CVV2>
          <PaymentAccountID>int</PaymentAccountID>
        </CreditCard>
        <ACH>
          <NameOnAccount>string</NameOnAccount>
          <AccountNumber>string</AccountNumber>
          <RoutingNumber>string</RoutingNumber>
          <Type>CHECKING or SAVINGS</Type>
          <PaymentAccountID>int</PaymentAccountID>
        </ACH>
        <Type>CREDIT_CARD or ACH or MANUAL or MANUAL_ELECTRONIC</Type>
        <ManualElectronic>
          <AuthCode>string</AuthCode>
          <EBillingProfileID>int</EBillingProfileID>
          <MerchantProfileID>int</MerchantProfileID>
        </ManualElectronic>
      </Request>
    </Payments_Create>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Payments_CreateResponse xmlns="http://api.myh2o.com/v20">
      <Payments_CreateResult>
        <Header>
          <Success>boolean</Success>
          <Message>string</Message>
          <SessionKey>string</SessionKey>
          <Impersonated>boolean</Impersonated>
          <Error_Code>string</Error_Code>
          <Error_Description>string</Error_Description>
        </Header>
        <Debug>
          <Request>
            <Credentials>
              <Username>string</Username>
              <Password>string</Password>
              <Client>string</Client>
              <ImpersonationKey>string</ImpersonationKey>
            </Credentials>
            <Session>
              <SessionKey>string</SessionKey>
            </Session>
            <Debug>boolean</Debug>
            <CustomerID>int</CustomerID>
            <Amount>decimal</Amount>
            <Options>
              <AgentID>int</AgentID>
              <Method>string</Method>
              <AgentNumber>string</AgentNumber>
              <ReceivedDate>dateTime</ReceivedDate>
              <ReferenceNumber>string</ReferenceNumber>
            </Options>
            <CreditCard>
              <NameOnCard>string</NameOnCard>
              <CreditCardNumber>string</CreditCardNumber>
              <ExpirationDate>dateTime</ExpirationDate>
              <CVV2>string</CVV2>
              <PaymentAccountID>int</PaymentAccountID>
            </CreditCard>
            <ACH>
              <NameOnAccount>string</NameOnAccount>
              <AccountNumber>string</AccountNumber>
              <RoutingNumber>string</RoutingNumber>
              <Type>CHECKING or SAVINGS</Type>
              <PaymentAccountID>int</PaymentAccountID>
            </ACH>
            <Type>CREDIT_CARD or ACH or MANUAL or MANUAL_ELECTRONIC</Type>
            <ManualElectronic>
              <AuthCode>string</AuthCode>
              <EBillingProfileID>int</EBillingProfileID>
              <MerchantProfileID>int</MerchantProfileID>
            </ManualElectronic>
          </Request>
        </Debug>
        <ID>int</ID>
        <Options>
          <AgentID>int</AgentID>
          <Method>string</Method>
          <AgentNumber>string</AgentNumber>
          <ReceivedDate>dateTime</ReceivedDate>
          <ReferenceNumber>string</ReferenceNumber>
        </Options>
        <CreditCardResult>
          <Message>string</Message>
          <TransactionNumber>string</TransactionNumber>
          <AuthCode>string</AuthCode>
          <Approved>boolean</Approved>
          <EBillingProfileID>int</EBillingProfileID>
          <MerchantProfileID>int</MerchantProfileID>
          <PaymentLogID>int</PaymentLogID>
        </CreditCardResult>
        <ACHResult>
          <Message>string</Message>
          <TransactionNumber>string</TransactionNumber>
          <AuthCode>string</AuthCode>
          <Approved>boolean</Approved>
          <EBillingProfileID>int</EBillingProfileID>
          <MerchantProfileID>int</MerchantProfileID>
          <PaymentLogID>int</PaymentLogID>
        </ACHResult>
      </Payments_CreateResult>
    </Payments_CreateResponse>
  </soap12:Body>
</soap12:Envelope>