Billhighway Cloud API

HeldPaymentChargeRq

The following routes are available for this service:
POST	/integrations/api/{integrationType}/heldpayment/charge

import java.math.*
import java.util.*
import net.servicestack.client.*


open class HeldPaymentChargeRq : IChargeRequest
{
    var integrationType:String? = null
    var NationalId:Int? = null
    var ChapterId:Int? = null
    var StoredAccountId:Long? = null
    var ContextIntegrationPartnerId:Int? = null
    var CallerIntegrationPartnerId:Int? = null
    var AuthenticationId:Int? = null
    var ChargeType:String? = null
    var Token:String? = null
    var Amount:BigDecimal? = null
    var Description:String? = null
    var CreatedById:Int? = null
    var TransactionId:Long? = null
    var StoreChargeAccount:Boolean? = null
    var ChargeItems:ArrayList<HeldPaymentChargeItem> = ArrayList<HeldPaymentChargeItem>()
    var CreatedBy:Int? = null
}

open class HeldPaymentChargeItem
{
    var Type:String? = null
    var Description:String? = null
    var Amount:BigDecimal? = null
    var ClientInvoiceId:String? = null
    var ClientInvoiceOwnerTypeId:Int? = null
}

open class HeldPaymentChargeRs
{
    var TransactionId:String? = null
    var StoredAccountId:Long? = null
    var NationalId:Int? = null
    var ChapterId:Int? = null
    var ChargeType:String? = null
    var IntegrationType:String? = null
    var ContextIntegrationPartnerId:Int? = null
    var CallerIntegrationPartnerId:Int? = null
    var GatewayResponse:HeldPaymentGatewaySaleResponse? = null
    var ChargeDetails:HeldPaymentChargeDetails? = null
    var ChargeItems:ArrayList<HeldPaymentChargeItem> = ArrayList<HeldPaymentChargeItem>()
}

open class HeldPaymentGatewaySaleResponse
{
    var FailureType:String? = null
    var IsDuplicate:Boolean? = null
    var IsSuccessful:Boolean? = null
    var ErrorCode:String? = null
    var Message:String? = null
    var GatewayId:Int? = null
    var ConfirmationNumber:String? = null
    var NetworkTransactionId:String? = null
}

open class HeldPaymentChargeDetails
{
    var PaymentType:String? = null
    var Amount:BigDecimal? = null
    var IntegrationType:String? = null
    var Currency:String? = null
    var CardDetails:HeldPaymentCreditCardChargeDetails? = null
    var AchDetails:HeldPaymentAchChargeDetails? = null
}

open class HeldPaymentCreditCardChargeDetails
{
    var CardType:String? = null
    var ExpMonth:Int? = null
    var ExpYear:Int? = null
    var Last4:String? = null
    var Address:CreditCardBillingAddressItem? = null
    var VerificationResult:CreditCardChargeVerificationResult? = null
}

open class CreditCardBillingAddressItem
{
    var Address1:String? = null
    var Address2:String? = null
    var City:String? = null
    var PostalCode:String? = null
    var Region:String? = null
    var Country:String? = null
    var Attributes:ArrayList<AttributeItem> = ArrayList<AttributeItem>()
}

open class AttributeItem
{
    var Name:String? = null
    var Value:String? = null
}

open class CreditCardChargeVerificationResult
{
    var NetworkVerificationAttempted:Boolean? = null
    var CvvVerificationResult:String? = null
    var AddressVerificationResult:String? = null
    var PostalCodeVerificationResult:String? = null
}

open class HeldPaymentAchChargeDetails
{
    var AccountType:String? = null
    var RoutingNumber:String? = null
    var AccountNumberLast4:String? = null
    var BankName:String? = null
    var VerificationResult:AchChargeVerificationResult? = null
}

open class AchChargeVerificationResult
{
    var NetworkVerificationAttempted:Boolean? = null
    var Result:String? = null
}

Kotlin HeldPaymentChargeRq 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 /integrations/api/{integrationType}/heldpayment/charge HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	integrationType: String,
	NationalId: 0,
	ChapterId: 0,
	StoredAccountId: 0,
	ContextIntegrationPartnerId: 0,
	CallerIntegrationPartnerId: 0,
	AuthenticationId: 0,
	ChargeType: String,
	Token: String,
	Amount: 0,
	Description: String,
	CreatedById: 0,
	TransactionId: 0,
	StoreChargeAccount: False,
	ChargeItems: 
	[
		{
			Type: String,
			Description: String,
			Amount: 0,
			ClientInvoiceId: String,
			ClientInvoiceOwnerTypeId: 0
		}
	],
	CreatedBy: 0
}

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

{
	TransactionId: String,
	StoredAccountId: 0,
	NationalId: 0,
	ChapterId: 0,
	ChargeType: String,
	IntegrationType: String,
	ContextIntegrationPartnerId: 0,
	CallerIntegrationPartnerId: 0,
	GatewayResponse: 
	{
		FailureType: String,
		IsDuplicate: False,
		IsSuccessful: False,
		ErrorCode: String,
		Message: String,
		GatewayId: 0,
		ConfirmationNumber: String,
		NetworkTransactionId: String
	},
	ChargeDetails: 
	{
		PaymentType: String,
		Amount: 0,
		IntegrationType: String,
		Currency: String,
		CardDetails: 
		{
			CardType: String,
			ExpMonth: 0,
			ExpYear: 0,
			Last4: String,
			Address: 
			{
				Address1: String,
				Address2: String,
				City: String,
				PostalCode: String,
				Region: String,
				Country: String,
				Attributes: 
				[
					{
						Name: String,
						Value: String
					}
				]
			},
			VerificationResult: 
			{
				NetworkVerificationAttempted: False,
				CvvVerificationResult: String,
				AddressVerificationResult: String,
				PostalCodeVerificationResult: String
			}
		},
		AchDetails: 
		{
			AccountType: String,
			RoutingNumber: String,
			AccountNumberLast4: String,
			BankName: String,
			VerificationResult: 
			{
				NetworkVerificationAttempted: False,
				Result: String
			}
		}
	},
	ChargeItems: 
	[
		{
			Type: String,
			Description: String,
			Amount: 0,
			ClientInvoiceId: String,
			ClientInvoiceOwnerTypeId: 0
		}
	]
}