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.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.SalesForce;

namespace BH.CloudAPI.Common4.DTO.SalesForce
{
    public partial class AchPayment
    {
        public AchPayment()
        {
            InvoiceList = new List<SalesForceMemberPaymentInvoiceDetail>{};
        }

        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual string UserId { get; set; }
        public virtual int BhUserId { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string CurrencyType { get; set; }
        public virtual string Country { get; set; }
        public virtual string RoutingNumber { get; set; }
        public virtual string AccountNumber { get; set; }
        public virtual string AchReference { get; set; }
        public virtual string AccountType { get; set; }
        public virtual bool IsSavingsAccount { get; set; }
        public virtual string PayerName { get; set; }
        public virtual string CheckNumber { get; set; }
        public virtual string PreferredEmailAddress { get; set; }
        public virtual string Memo { get; set; }
        public virtual List<SalesForceMemberPaymentInvoiceDetail> InvoiceList { get; set; }
        public virtual bool AutoPay { get; set; }
        public virtual bool StoreAchInfo { get; set; }
        public virtual int EncryptionTypeId { get; set; }
    }

    public partial class AchPaymentCollection
    {
        public AchPaymentCollection()
        {
            AchPaymentList = new List<AchPayment>{};
        }

        public virtual List<AchPayment> AchPaymentList { get; set; }
    }

    public partial class AchPaymentReply
        : IHaveErrorField
    {
        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string TransactionId { get; set; }
        public virtual int ErrorCode { get; set; }
        public virtual string ErrorMessage { get; set; }
        [ApiMember(ExcludeInSchema=true)]
        public virtual bool IsError { get; set; }
    }

    public partial class AchPaymentReplyCollection
    {
        public AchPaymentReplyCollection()
        {
            AchReplyCollection = new List<AchPaymentReply>{};
        }

        public virtual List<AchPaymentReply> AchReplyCollection { get; set; }
    }

    public partial class SalesForceMemberPaymentInvoiceDetail
    {
        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual int Invoice { get; set; }
        public virtual string AmountPaid { get; set; }
    }

}

C# 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>