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.

export class AchPaymentReply implements IHaveErrorField
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public TransactionId?: string;
    public ErrorCode?: number;
    public ErrorMessage?: string;
    // @ApiMember(ExcludeInSchema=true)
    public IsError?: boolean;

    public constructor(init?: Partial<AchPaymentReply>) { (Object as any).assign(this, init); }
}

export class AchPaymentReplyCollection
{
    public AchReplyCollection?: AchPaymentReply[];

    public constructor(init?: Partial<AchPaymentReplyCollection>) { (Object as any).assign(this, init); }
}

export class SalesForceMemberPaymentInvoiceDetail
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public Invoice?: number;
    public AmountPaid?: string;

    public constructor(init?: Partial<SalesForceMemberPaymentInvoiceDetail>) { (Object as any).assign(this, init); }
}

export class AchPayment
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserId?: string;
    public BhUserId?: number;
    public Amount?: number;
    public CurrencyType?: string;
    public Country?: string;
    public RoutingNumber?: string;
    public AccountNumber?: string;
    public AchReference?: string;
    public AccountType?: string;
    public IsSavingsAccount?: boolean;
    public PayerName?: string;
    public CheckNumber?: string;
    public PreferredEmailAddress?: string;
    public Memo?: string;
    public InvoiceList?: SalesForceMemberPaymentInvoiceDetail[];
    public AutoPay?: boolean;
    public StoreAchInfo?: boolean;
    public EncryptionTypeId?: number;

    public constructor(init?: Partial<AchPayment>) { (Object as any).assign(this, init); }
}

export class AchPaymentCollection
{
    public AchPaymentList?: AchPayment[];

    public constructor(init?: Partial<AchPaymentCollection>) { (Object as any).assign(this, init); }
}

TypeScript AchPaymentCollection DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
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}]}