Billhighway Cloud API

<back to all web services

AchPaymentCollection

The following routes are available for this service:
POST/api/SalesForce/AchPaymentProcesses the ACH Payments.Validates the input values and processes the ACH Payments.
POST/payments/achProcesses the ACH Payments.Validates the input values and processes the ACH Payments.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class AchPaymentCollection
    {
        public ArrayList<AchPayment> AchPaymentList = null;
        
        public ArrayList<AchPayment> getAchPaymentList() { return AchPaymentList; }
        public AchPaymentCollection setAchPaymentList(ArrayList<AchPayment> value) { this.AchPaymentList = value; return this; }
    }

    public static class AchPayment
    {
        public String ClassName = null;
        public String UniqueId = null;
        public Date CreatedDateTime = null;
        public Integer ClientId = null;
        public String GroupId = null;
        public String UserId = null;
        public Integer BhUserId = null;
        public BigDecimal Amount = null;
        public String CurrencyType = null;
        public String Country = null;
        public String RoutingNumber = null;
        public String AccountNumber = null;
        public String AchReference = null;
        public String AccountType = null;
        public Boolean IsSavingsAccount = null;
        public String PayerName = null;
        public String CheckNumber = null;
        public String PreferredEmailAddress = null;
        public String Memo = null;
        public ArrayList<SalesForceMemberPaymentInvoiceDetail> InvoiceList = null;
        public Boolean AutoPay = null;
        public Boolean StoreAchInfo = null;
        public Integer EncryptionTypeId = null;
        
        public String getClassName() { return ClassName; }
        public AchPayment setClassName(String value) { this.ClassName = value; return this; }
        public String getUniqueId() { return UniqueId; }
        public AchPayment setUniqueId(String value) { this.UniqueId = value; return this; }
        public Date getCreatedDateTime() { return CreatedDateTime; }
        public AchPayment setCreatedDateTime(Date value) { this.CreatedDateTime = value; return this; }
        public Integer getClientId() { return ClientId; }
        public AchPayment setClientId(Integer value) { this.ClientId = value; return this; }
        public String getGroupId() { return GroupId; }
        public AchPayment setGroupId(String value) { this.GroupId = value; return this; }
        public String getUserId() { return UserId; }
        public AchPayment setUserId(String value) { this.UserId = value; return this; }
        public Integer getBhUserId() { return BhUserId; }
        public AchPayment setBhUserId(Integer value) { this.BhUserId = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public AchPayment setAmount(BigDecimal value) { this.Amount = value; return this; }
        public String getCurrencyType() { return CurrencyType; }
        public AchPayment setCurrencyType(String value) { this.CurrencyType = value; return this; }
        public String getCountry() { return Country; }
        public AchPayment setCountry(String value) { this.Country = value; return this; }
        public String getRoutingNumber() { return RoutingNumber; }
        public AchPayment setRoutingNumber(String value) { this.RoutingNumber = value; return this; }
        public String getAccountNumber() { return AccountNumber; }
        public AchPayment setAccountNumber(String value) { this.AccountNumber = value; return this; }
        public String getAchReference() { return AchReference; }
        public AchPayment setAchReference(String value) { this.AchReference = value; return this; }
        public String getAccountType() { return AccountType; }
        public AchPayment setAccountType(String value) { this.AccountType = value; return this; }
        public Boolean getIsSavingsAccount() { return IsSavingsAccount; }
        public AchPayment setIsSavingsAccount(Boolean value) { this.IsSavingsAccount = value; return this; }
        public String getPayerName() { return PayerName; }
        public AchPayment setPayerName(String value) { this.PayerName = value; return this; }
        public String getCheckNumber() { return CheckNumber; }
        public AchPayment setCheckNumber(String value) { this.CheckNumber = value; return this; }
        public String getPreferredEmailAddress() { return PreferredEmailAddress; }
        public AchPayment setPreferredEmailAddress(String value) { this.PreferredEmailAddress = value; return this; }
        public String getMemo() { return Memo; }
        public AchPayment setMemo(String value) { this.Memo = value; return this; }
        public ArrayList<SalesForceMemberPaymentInvoiceDetail> getInvoiceList() { return InvoiceList; }
        public AchPayment setInvoiceList(ArrayList<SalesForceMemberPaymentInvoiceDetail> value) { this.InvoiceList = value; return this; }
        public Boolean isAutoPay() { return AutoPay; }
        public AchPayment setAutoPay(Boolean value) { this.AutoPay = value; return this; }
        public Boolean isStoreAchInfo() { return StoreAchInfo; }
        public AchPayment setStoreAchInfo(Boolean value) { this.StoreAchInfo = value; return this; }
        public Integer getEncryptionTypeId() { return EncryptionTypeId; }
        public AchPayment setEncryptionTypeId(Integer value) { this.EncryptionTypeId = value; return this; }
    }

    public static class SalesForceMemberPaymentInvoiceDetail
    {
        public String ClassName = null;
        public String UniqueId = null;
        public Date CreatedDateTime = null;
        public Integer ClientId = null;
        public Integer Invoice = null;
        public String AmountPaid = null;
        
        public String getClassName() { return ClassName; }
        public SalesForceMemberPaymentInvoiceDetail setClassName(String value) { this.ClassName = value; return this; }
        public String getUniqueId() { return UniqueId; }
        public SalesForceMemberPaymentInvoiceDetail setUniqueId(String value) { this.UniqueId = value; return this; }
        public Date getCreatedDateTime() { return CreatedDateTime; }
        public SalesForceMemberPaymentInvoiceDetail setCreatedDateTime(Date value) { this.CreatedDateTime = value; return this; }
        public Integer getClientId() { return ClientId; }
        public SalesForceMemberPaymentInvoiceDetail setClientId(Integer value) { this.ClientId = value; return this; }
        public Integer getInvoice() { return Invoice; }
        public SalesForceMemberPaymentInvoiceDetail setInvoice(Integer value) { this.Invoice = value; return this; }
        public String getAmountPaid() { return AmountPaid; }
        public SalesForceMemberPaymentInvoiceDetail setAmountPaid(String value) { this.AmountPaid = value; return this; }
    }

    public static class AchPaymentReplyCollection
    {
        public ArrayList<AchPaymentReply> AchReplyCollection = null;
        
        public ArrayList<AchPaymentReply> getAchReplyCollection() { return AchReplyCollection; }
        public AchPaymentReplyCollection setAchReplyCollection(ArrayList<AchPaymentReply> value) { this.AchReplyCollection = value; return this; }
    }

    public static class AchPaymentReply implements IHaveErrorField
    {
        public String ClassName = null;
        public String UniqueId = null;
        public Date CreatedDateTime = null;
        public Integer ClientId = null;
        public String TransactionId = null;
        public Integer ErrorCode = null;
        public String ErrorMessage = null;
        @ApiMember(ExcludeInSchema=true)
        public Boolean IsError = null;
        
        public String getClassName() { return ClassName; }
        public AchPaymentReply setClassName(String value) { this.ClassName = value; return this; }
        public String getUniqueId() { return UniqueId; }
        public AchPaymentReply setUniqueId(String value) { this.UniqueId = value; return this; }
        public Date getCreatedDateTime() { return CreatedDateTime; }
        public AchPaymentReply setCreatedDateTime(Date value) { this.CreatedDateTime = value; return this; }
        public Integer getClientId() { return ClientId; }
        public AchPaymentReply setClientId(Integer value) { this.ClientId = value; return this; }
        public String getTransactionId() { return TransactionId; }
        public AchPaymentReply setTransactionId(String value) { this.TransactionId = value; return this; }
        public Integer getErrorCode() { return ErrorCode; }
        public AchPaymentReply setErrorCode(Integer value) { this.ErrorCode = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public AchPaymentReply setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public Boolean getIsError() { return IsError; }
        public AchPaymentReply setIsError(Boolean value) { this.IsError = value; return this; }
    }

}

Java AchPaymentCollection DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/SalesForce/AchPayment HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AchPaymentCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AchPaymentList>
    <AchPayment>
      <AccountNumber>String</AccountNumber>
      <AccountType>String</AccountType>
      <AchReference>String</AchReference>
      <Amount>0</Amount>
      <AutoPay>false</AutoPay>
      <BhUserId>0</BhUserId>
      <CheckNumber>String</CheckNumber>
      <ClassName>String</ClassName>
      <ClientId>0</ClientId>
      <Country>String</Country>
      <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
      <CurrencyType>String</CurrencyType>
      <EncryptionTypeId>0</EncryptionTypeId>
      <GroupId>String</GroupId>
      <InvoiceList>
        <SalesForceMemberPaymentInvoiceDetail>
          <AmountPaid>String</AmountPaid>
          <ClassName>String</ClassName>
          <ClientId>0</ClientId>
          <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
          <Invoice>0</Invoice>
          <UniqueId>String</UniqueId>
        </SalesForceMemberPaymentInvoiceDetail>
      </InvoiceList>
      <Memo>String</Memo>
      <PayerName>String</PayerName>
      <PreferredEmailAddress>String</PreferredEmailAddress>
      <RoutingNumber>String</RoutingNumber>
      <StoreAchInfo>false</StoreAchInfo>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </AchPayment>
  </AchPaymentList>
</AchPaymentCollection>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AchPaymentReplyCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AchReplyCollection>
    <AchPaymentReply>
      <ClientId>0</ClientId>
      <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
      <ErrorCode>0</ErrorCode>
      <ErrorMessage>String</ErrorMessage>
      <TransactionId>String</TransactionId>
      <UniqueId>String</UniqueId>
    </AchPaymentReply>
  </AchReplyCollection>
</AchPaymentReplyCollection>