Billhighway Cloud API

CoreChargeDonationRq

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

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


open class CoreChargeDonationRq : IChargeRequest
{
    @ApiMember(ParameterType="path")
    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 UserId:Int? = null
    var AuthenticationId:Int? = null
    var ChargeType:String? = null
    var Token:String? = null
    @ApiMember(Format="decimal", ParameterType="model")
    var Amount:BigDecimal? = null

    var Description:String? = null
    var CampaignId:Int? = null
    var CreatedById:Int? = null
    var TransactionId:Long? = null
    var PartnerReferenceId:String? = null
    var EventItems:ArrayList<EventItem> = ArrayList<EventItem>()
}

open class EventItem
{
    var CustomerFeeItemTypeId:String? = null
    var Quantity:String? = null
}

open class CoreChargeDonationRs
{
    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:CoreChargeGatewaySaleResponse? = null
    var ChargeDetails:CoreChargeDetails? = null
}

open class CoreChargeGatewaySaleResponse
{
    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 CoreChargeDetails
{
    var PaymentType:String? = null
    var Amount:Int? = null
    var IntegrationType:String? = null
    var Currency:String? = null
    var CardDetails:CoreCreditCardChargeDetails? = null
}

open class CoreCreditCardChargeDetails
{
    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
}

Kotlin CoreChargeDonationRq 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 /integrations/api/{integrationType}/core/donationcharge HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"integrationType":"String","NationalId":0,"ChapterId":0,"StoredAccountId":0,"ContextIntegrationPartnerId":0,"CallerIntegrationPartnerId":0,"UserId":0,"AuthenticationId":0,"ChargeType":"String","Token":"String","Amount":0,"Description":"String","CampaignId":0,"CreatedById":0,"TransactionId":0,"PartnerReferenceId":"String","EventItems":[{"CustomerFeeItemTypeId":"String","Quantity":"String"}]}

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}}