Billhighway Cloud API

AchPaymentCollection

The following routes are available for this service:
POST	/api/SalesForce/AchPayment	Processes the ACH Payments.	Validates the input values and processes the ACH Payments.
POST	/payments/ach	Processes the ACH Payments.	Validates the input values and processes the ACH Payments.

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchPaymentReply(IHaveErrorField):
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    transaction_id: Optional[str] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None
    # @ApiMember(ExcludeInSchema=true)
    is_error: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchPaymentReplyCollection:
    ach_reply_collection: Optional[List[AchPaymentReply]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesForceMemberPaymentInvoiceDetail:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    invoice: Optional[int] = None
    amount_paid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchPayment:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    user_id: Optional[str] = None
    bh_user_id: Optional[int] = None
    amount: Optional[Decimal] = None
    currency_type: Optional[str] = None
    country: Optional[str] = None
    routing_number: Optional[str] = None
    account_number: Optional[str] = None
    ach_reference: Optional[str] = None
    account_type: Optional[str] = None
    is_savings_account: Optional[bool] = None
    payer_name: Optional[str] = None
    check_number: Optional[str] = None
    preferred_email_address: Optional[str] = None
    memo: Optional[str] = None
    invoice_list: Optional[List[SalesForceMemberPaymentInvoiceDetail]] = None
    auto_pay: Optional[bool] = None
    store_ach_info: Optional[bool] = None
    encryption_type_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchPaymentCollection:
    ach_payment_list: Optional[List[AchPayment]] = None

Python AchPaymentCollection DTOs

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

HTTP + JSV

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

{
	AchPaymentList: 
	[
		{
			ClassName: String,
			UniqueId: String,
			CreatedDateTime: 0001-01-01,
			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-01,
					ClientId: 0,
					Invoice: 0,
					AmountPaid: String
				}
			],
			AutoPay: False,
			StoreAchInfo: False,
			EncryptionTypeId: 0
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	AchReplyCollection: 
	[
		{
			ClassName: String,
			UniqueId: String,
			CreatedDateTime: 0001-01-01,
			ClientId: 0,
			TransactionId: String,
			ErrorCode: 0,
			ErrorMessage: String,
			IsError: False
		}
	]
}