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

<HeldPaymentChargeRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.HeldPayments.Api.Request">
  <Amount>0</Amount>
  <AuthenticationId>0</AuthenticationId>
  <CallerIntegrationPartnerId>0</CallerIntegrationPartnerId>
  <ChapterId>0</ChapterId>
  <ChargeItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.HeldPayments">
    <d2p1:HeldPaymentChargeItem>
      <d2p1:_x003C_Amount_x003E_k__BackingField>0</d2p1:_x003C_Amount_x003E_k__BackingField>
      <d2p1:_x003C_ClientInvoiceId_x003E_k__BackingField>String</d2p1:_x003C_ClientInvoiceId_x003E_k__BackingField>
      <d2p1:_x003C_ClientInvoiceOwnerTypeId_x003E_k__BackingField>0</d2p1:_x003C_ClientInvoiceOwnerTypeId_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_Type_x003E_k__BackingField>String</d2p1:_x003C_Type_x003E_k__BackingField>
    </d2p1:HeldPaymentChargeItem>
  </ChargeItems>
  <ChargeType>String</ChargeType>
  <ContextIntegrationPartnerId>0</ContextIntegrationPartnerId>
  <CreatedBy>0</CreatedBy>
  <CreatedById>0</CreatedById>
  <Description>String</Description>
  <NationalId>0</NationalId>
  <StoreChargeAccount>false</StoreChargeAccount>
  <StoredAccountId>0</StoredAccountId>
  <Token>String</Token>
  <TransactionId>0</TransactionId>
  <integrationType>String</integrationType>
</HeldPaymentChargeRq>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<HeldPaymentChargeRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.HeldPayments.Api.Response">
  <CallerIntegrationPartnerId>0</CallerIntegrationPartnerId>
  <ChapterId>0</ChapterId>
  <ChargeDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.HeldPayments.Api">
    <d2p1:AchDetails>
      <d2p1:_x003C_AccountNumberLast4_x003E_k__BackingField>String</d2p1:_x003C_AccountNumberLast4_x003E_k__BackingField>
      <d2p1:_x003C_AccountType_x003E_k__BackingField>String</d2p1:_x003C_AccountType_x003E_k__BackingField>
      <d2p1:_x003C_BankName_x003E_k__BackingField>String</d2p1:_x003C_BankName_x003E_k__BackingField>
      <d2p1:_x003C_RoutingNumber_x003E_k__BackingField>String</d2p1:_x003C_RoutingNumber_x003E_k__BackingField>
      <d2p1:_x003C_VerificationResult_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api">
        <d4p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>false</d4p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>
        <d4p1:_x003C_Result_x003E_k__BackingField>String</d4p1:_x003C_Result_x003E_k__BackingField>
      </d2p1:_x003C_VerificationResult_x003E_k__BackingField>
    </d2p1:AchDetails>
    <d2p1:Amount>0</d2p1:Amount>
    <d2p1:CardDetails>
      <d2p1:_x003C_Address_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api">
        <d4p1:Address1>String</d4p1:Address1>
        <d4p1:Address2>String</d4p1:Address2>
        <d4p1:Attributes xmlns:d5p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO">
          <d5p1:AttributeItem>
            <d5p1:Name>String</d5p1:Name>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:AttributeItem>
        </d4p1:Attributes>
        <d4p1:City>String</d4p1:City>
        <d4p1:Country>String</d4p1:Country>
        <d4p1:PostalCode>String</d4p1:PostalCode>
        <d4p1:Region>String</d4p1:Region>
      </d2p1:_x003C_Address_x003E_k__BackingField>
      <d2p1:_x003C_CardType_x003E_k__BackingField>String</d2p1:_x003C_CardType_x003E_k__BackingField>
      <d2p1:_x003C_ExpMonth_x003E_k__BackingField>0</d2p1:_x003C_ExpMonth_x003E_k__BackingField>
      <d2p1:_x003C_ExpYear_x003E_k__BackingField>0</d2p1:_x003C_ExpYear_x003E_k__BackingField>
      <d2p1:_x003C_Last4_x003E_k__BackingField>String</d2p1:_x003C_Last4_x003E_k__BackingField>
      <d2p1:_x003C_VerificationResult_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api">
        <d4p1:_x003C_AddressVerificationResult_x003E_k__BackingField>String</d4p1:_x003C_AddressVerificationResult_x003E_k__BackingField>
        <d4p1:_x003C_CvvVerificationResult_x003E_k__BackingField>String</d4p1:_x003C_CvvVerificationResult_x003E_k__BackingField>
        <d4p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>false</d4p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>
        <d4p1:_x003C_PostalCodeVerificationResult_x003E_k__BackingField>String</d4p1:_x003C_PostalCodeVerificationResult_x003E_k__BackingField>
      </d2p1:_x003C_VerificationResult_x003E_k__BackingField>
    </d2p1:CardDetails>
    <d2p1:Currency>String</d2p1:Currency>
    <d2p1:IntegrationType>String</d2p1:IntegrationType>
    <d2p1:PaymentType>String</d2p1:PaymentType>
  </ChargeDetails>
  <ChargeItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.HeldPayments">
    <d2p1:HeldPaymentChargeItem>
      <d2p1:_x003C_Amount_x003E_k__BackingField>0</d2p1:_x003C_Amount_x003E_k__BackingField>
      <d2p1:_x003C_ClientInvoiceId_x003E_k__BackingField>String</d2p1:_x003C_ClientInvoiceId_x003E_k__BackingField>
      <d2p1:_x003C_ClientInvoiceOwnerTypeId_x003E_k__BackingField>0</d2p1:_x003C_ClientInvoiceOwnerTypeId_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_Type_x003E_k__BackingField>String</d2p1:_x003C_Type_x003E_k__BackingField>
    </d2p1:HeldPaymentChargeItem>
  </ChargeItems>
  <ChargeType>String</ChargeType>
  <ContextIntegrationPartnerId>0</ContextIntegrationPartnerId>
  <GatewayResponse xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.HeldPayments">
    <d2p1:_x003C_ConfirmationNumber_x003E_k__BackingField>String</d2p1:_x003C_ConfirmationNumber_x003E_k__BackingField>
    <d2p1:_x003C_ErrorCode_x003E_k__BackingField>String</d2p1:_x003C_ErrorCode_x003E_k__BackingField>
    <d2p1:_x003C_FailureType_x003E_k__BackingField>String</d2p1:_x003C_FailureType_x003E_k__BackingField>
    <d2p1:_x003C_GatewayId_x003E_k__BackingField>0</d2p1:_x003C_GatewayId_x003E_k__BackingField>
    <d2p1:_x003C_IsDuplicate_x003E_k__BackingField>false</d2p1:_x003C_IsDuplicate_x003E_k__BackingField>
    <d2p1:_x003C_IsSuccessful_x003E_k__BackingField>false</d2p1:_x003C_IsSuccessful_x003E_k__BackingField>
    <d2p1:_x003C_Message_x003E_k__BackingField>String</d2p1:_x003C_Message_x003E_k__BackingField>
    <d2p1:_x003C_NetworkTransactionId_x003E_k__BackingField>String</d2p1:_x003C_NetworkTransactionId_x003E_k__BackingField>
  </GatewayResponse>
  <IntegrationType>String</IntegrationType>
  <NationalId>0</NationalId>
  <StoredAccountId>0</StoredAccountId>
  <TransactionId>String</TransactionId>
</HeldPaymentChargeRs>