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 Foundation
import ServiceStack

public class AchPaymentCollection : Codable
{
    public var achPaymentList:[AchPayment] = []

    required public init(){}
}

public class AchPayment : Codable
{
    public var className:String?
    public var uniqueId:String?
    public var createdDateTime:Date?
    public var clientId:Int?
    public var groupId:String?
    public var userId:String?
    public var bhUserId:Int?
    public var amount:Double?
    public var currencyType:String?
    public var country:String?
    public var routingNumber:String?
    public var accountNumber:String?
    public var achReference:String?
    public var accountType:String?
    public var isSavingsAccount:Bool?
    public var payerName:String?
    public var checkNumber:String?
    public var preferredEmailAddress:String?
    public var memo:String?
    public var invoiceList:[SalesForceMemberPaymentInvoiceDetail] = []
    public var autoPay:Bool?
    public var storeAchInfo:Bool?
    public var encryptionTypeId:Int?

    required public init(){}
}

public class SalesForceMemberPaymentInvoiceDetail : Codable
{
    public var className:String?
    public var uniqueId:String?
    public var createdDateTime:Date?
    public var clientId:Int?
    public var invoice:Int?
    public var amountPaid:String?

    required public init(){}
}

public class AchPaymentReplyCollection : Codable
{
    public var achReplyCollection:[AchPaymentReply] = []

    required public init(){}
}

public class AchPaymentReply : IHaveErrorField, Codable
{
    public var className:String?
    public var uniqueId:String?
    public var createdDateTime:Date?
    public var clientId:Int?
    public var transactionId:String?
    public var errorCode:Int?
    public var errorMessage:String?
    // @ApiMember(ExcludeInSchema=true)
    public var isError:Bool?

    required public init(){}
}


Swift AchPaymentCollection DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"AchPaymentList":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","BhUserId":0,"Amount":0,"CurrencyType":"String","Country":"String","RoutingNumber":"String","AccountNumber":"String","AchReference":"String","AccountType":"String","IsSavingsAccount":false,"PayerName":"String","CheckNumber":"String","PreferredEmailAddress":"String","Memo":"String","InvoiceList":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"Invoice":0,"AmountPaid":"String"}],"AutoPay":false,"StoreAchInfo":false,"EncryptionTypeId":0}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"AchReplyCollection":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"TransactionId":"String","ErrorCode":0,"ErrorMessage":"String","IsError":false}]}