Gateway Web Service

Gateway

Click here for a complete list of operations.

BillingInformation

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 /Gateway.asmx HTTP/1.1
Host: api.equiant.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.equiant.com/BillingInformation"

<?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:Header>
    <Credentials xmlns="http://www.equiant.com/">
      <UserName>string</UserName>
      <Password>string</Password>
    </Credentials>
  </soap:Header>
  <soap:Body>
    <BillingInformation xmlns="http://www.equiant.com/">
      <AccountNumber>string</AccountNumber>
    </BillingInformation>
  </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>
    <BillingInformationResponse xmlns="http://www.equiant.com/">
      <BillingInformationResult>
        <PaymentAmount>double</PaymentAmount>
        <PaymentFreq>string</PaymentFreq>
        <LastApplyCodeDesc>string</LastApplyCodeDesc>
        <Description>string</Description>
        <PaymentFreqDesc>string</PaymentFreqDesc>
        <LateChargeCode>string</LateChargeCode>
        <LateChargeDesc>string</LateChargeDesc>
        <DispositionCode>string</DispositionCode>
        <DispositionCodeDescription>string</DispositionCodeDescription>
        <ActiveDisposition>string</ActiveDisposition>
        <Client>string</Client>
        <PaymentMethod>string</PaymentMethod>
        <Unit>string</Unit>
        <Week>string</Week>
        <Currency>string</Currency>
        <TotalDue>double</TotalDue>
        <CurrentDue>double</CurrentDue>
        <FutureRateAmount>double</FutureRateAmount>
        <LastApplyAmount>double</LastApplyAmount>
        <PastDue>double</PastDue>
        <DaysDelinquent>double</DaysDelinquent>
        <LateChargeDue>double</LateChargeDue>
        <FinanceChargeDue>double</FinanceChargeDue>
        <FinanceChargeRate>double</FinanceChargeRate>
        <PerDiem>double</PerDiem>
        <FutureRateDate>dateTime</FutureRateDate>
        <LastApplyDate>dateTime</LastApplyDate>
        <NextStatementDueDate>dateTime</NextStatementDueDate>
        <CurrentBilledDueDate>dateTime</CurrentBilledDueDate>
        <NextBillDueDate>dateTime</NextBillDueDate>
        <Settings>
          <Fees>
            <Consumer>double</Consumer>
            <IVR>double</IVR>
            <OTCC>double</OTCC>
            <OTSP>double</OTSP>
            <IP>double</IP>
            <Client>double</Client>
          </Fees>
          <CategoryCodes>string</CategoryCodes>
          <Currency>string</Currency>
          <AllowPaymentsReason>string</AllowPaymentsReason>
          <MerchantMessage>string</MerchantMessage>
          <AchTypes>string</AchTypes>
          <CreditCardTypes>string</CreditCardTypes>
          <AllowPayments>boolean</AllowPayments>
          <AllowACH>boolean</AllowACH>
          <AllowCheck>boolean</AllowCheck>
          <AllowCreditCard>boolean</AllowCreditCard>
          <CreditCardAuthsRequired>boolean</CreditCardAuthsRequired>
          <MerchantId>string</MerchantId>
          <CreditCardAuthDays>int</CreditCardAuthDays>
          <MaxRegularPayment>double</MaxRegularPayment>
          <MaxPRCRPayment>double</MaxPRCRPayment>
          <MaxOTCCPayment>double</MaxOTCCPayment>
          <MaxOTSPpayment>double</MaxOTSPpayment>
          <SurePay>boolean</SurePay>
          <ServiceFee>decimal</ServiceFee>
          <AutoCreditCard>boolean</AutoCreditCard>
          <SurePayOnAmount>double</SurePayOnAmount>
          <AutoCreditCardOnAmount>double</AutoCreditCardOnAmount>
          <MinSurePayPayment>double</MinSurePayPayment>
          <MinCreditCardPayment>double</MinCreditCardPayment>
          <AutoPaidAhead>boolean</AutoPaidAhead>
          <PostDateDays>int</PostDateDays>
          <AutoCCDaysOfMonth>string</AutoCCDaysOfMonth>
          <SurePayDaysOfMonth>string</SurePayDaysOfMonth>
          <CreditCardBank>string</CreditCardBank>
          <SurePayBank>string</SurePayBank>
          <ExtraPaymentType>
            <string>string</string>
            <string>string</string>
          </ExtraPaymentType>
          <ExtraPaymentTypeDescription>
            <string>string</string>
            <string>string</string>
          </ExtraPaymentTypeDescription>
          <ExtraPaymentTypeMinAmount>
            <double>double</double>
            <double>double</double>
          </ExtraPaymentTypeMinAmount>
          <ExtraPaymentTypeMaxAmount>
            <double>double</double>
            <double>double</double>
          </ExtraPaymentTypeMaxAmount>
          <GatewayFields>
            <string>string</string>
            <string>string</string>
          </GatewayFields>
          <GatewayValues>
            <string>string</string>
            <string>string</string>
          </GatewayValues>
        </Settings>
      </BillingInformationResult>
    </BillingInformationResponse>
  </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 /Gateway.asmx HTTP/1.1
Host: api.equiant.com
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:Header>
    <Credentials xmlns="http://www.equiant.com/">
      <UserName>string</UserName>
      <Password>string</Password>
    </Credentials>
  </soap12:Header>
  <soap12:Body>
    <BillingInformation xmlns="http://www.equiant.com/">
      <AccountNumber>string</AccountNumber>
    </BillingInformation>
  </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>
    <BillingInformationResponse xmlns="http://www.equiant.com/">
      <BillingInformationResult>
        <PaymentAmount>double</PaymentAmount>
        <PaymentFreq>string</PaymentFreq>
        <LastApplyCodeDesc>string</LastApplyCodeDesc>
        <Description>string</Description>
        <PaymentFreqDesc>string</PaymentFreqDesc>
        <LateChargeCode>string</LateChargeCode>
        <LateChargeDesc>string</LateChargeDesc>
        <DispositionCode>string</DispositionCode>
        <DispositionCodeDescription>string</DispositionCodeDescription>
        <ActiveDisposition>string</ActiveDisposition>
        <Client>string</Client>
        <PaymentMethod>string</PaymentMethod>
        <Unit>string</Unit>
        <Week>string</Week>
        <Currency>string</Currency>
        <TotalDue>double</TotalDue>
        <CurrentDue>double</CurrentDue>
        <FutureRateAmount>double</FutureRateAmount>
        <LastApplyAmount>double</LastApplyAmount>
        <PastDue>double</PastDue>
        <DaysDelinquent>double</DaysDelinquent>
        <LateChargeDue>double</LateChargeDue>
        <FinanceChargeDue>double</FinanceChargeDue>
        <FinanceChargeRate>double</FinanceChargeRate>
        <PerDiem>double</PerDiem>
        <FutureRateDate>dateTime</FutureRateDate>
        <LastApplyDate>dateTime</LastApplyDate>
        <NextStatementDueDate>dateTime</NextStatementDueDate>
        <CurrentBilledDueDate>dateTime</CurrentBilledDueDate>
        <NextBillDueDate>dateTime</NextBillDueDate>
        <Settings>
          <Fees>
            <Consumer>double</Consumer>
            <IVR>double</IVR>
            <OTCC>double</OTCC>
            <OTSP>double</OTSP>
            <IP>double</IP>
            <Client>double</Client>
          </Fees>
          <CategoryCodes>string</CategoryCodes>
          <Currency>string</Currency>
          <AllowPaymentsReason>string</AllowPaymentsReason>
          <MerchantMessage>string</MerchantMessage>
          <AchTypes>string</AchTypes>
          <CreditCardTypes>string</CreditCardTypes>
          <AllowPayments>boolean</AllowPayments>
          <AllowACH>boolean</AllowACH>
          <AllowCheck>boolean</AllowCheck>
          <AllowCreditCard>boolean</AllowCreditCard>
          <CreditCardAuthsRequired>boolean</CreditCardAuthsRequired>
          <MerchantId>string</MerchantId>
          <CreditCardAuthDays>int</CreditCardAuthDays>
          <MaxRegularPayment>double</MaxRegularPayment>
          <MaxPRCRPayment>double</MaxPRCRPayment>
          <MaxOTCCPayment>double</MaxOTCCPayment>
          <MaxOTSPpayment>double</MaxOTSPpayment>
          <SurePay>boolean</SurePay>
          <ServiceFee>decimal</ServiceFee>
          <AutoCreditCard>boolean</AutoCreditCard>
          <SurePayOnAmount>double</SurePayOnAmount>
          <AutoCreditCardOnAmount>double</AutoCreditCardOnAmount>
          <MinSurePayPayment>double</MinSurePayPayment>
          <MinCreditCardPayment>double</MinCreditCardPayment>
          <AutoPaidAhead>boolean</AutoPaidAhead>
          <PostDateDays>int</PostDateDays>
          <AutoCCDaysOfMonth>string</AutoCCDaysOfMonth>
          <SurePayDaysOfMonth>string</SurePayDaysOfMonth>
          <CreditCardBank>string</CreditCardBank>
          <SurePayBank>string</SurePayBank>
          <ExtraPaymentType>
            <string>string</string>
            <string>string</string>
          </ExtraPaymentType>
          <ExtraPaymentTypeDescription>
            <string>string</string>
            <string>string</string>
          </ExtraPaymentTypeDescription>
          <ExtraPaymentTypeMinAmount>
            <double>double</double>
            <double>double</double>
          </ExtraPaymentTypeMinAmount>
          <ExtraPaymentTypeMaxAmount>
            <double>double</double>
            <double>double</double>
          </ExtraPaymentTypeMaxAmount>
          <GatewayFields>
            <string>string</string>
            <string>string</string>
          </GatewayFields>
          <GatewayValues>
            <string>string</string>
            <string>string</string>
          </GatewayValues>
        </Settings>
      </BillingInformationResult>
    </BillingInformationResponse>
  </soap12:Body>
</soap12:Envelope>