Billhighway Cloud API

HeldPaymentChargeRefundRq

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

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


open class HeldPaymentChargeRefundRq
{
    var integrationType:String? = null
    var NationalId:Int? = null
    var ChapterId:Int? = null
    var UserId:Int? = null
    var ContextIntegrationPartnerId:Int? = null
    var CallerIntegrationPartnerId:Int? = null
    var AuthenticationId:Int? = null
    var Amount:BigDecimal? = null
    var Description:String? = null
    var GatewayConfirmation:String? = null
    var CardInfo:HeldPaymentCreditCardChargeRefundDetails? = null
}

open class HeldPaymentCreditCardChargeRefundDetails
{
    var CardRef:String? = null
    var ExpMonth:Int? = null
    var ExpYear:Int? = null
    var CVV:String? = null
    var CardType:String? = null
    var NameOnCard:String? = null
    var Address1:String? = null
    var Address2:String? = null
    var City:String? = null
    var State:String? = null
    var PostalCode:String? = null
    var Country:String? = null
}

open class HeldPaymentChargeRefundRs
{
    var NationalId:Int? = null
    var ChapterId:Int? = null
    var IntegrationType:String? = null
    var ContextIntegrationPartnerId:Int? = null
    var CallerIntegrationPartnerId:Int? = null
    var GatewayResponse:HeldPaymentGatewaySaleResponse? = null
    var ChargeDetails:HeldPaymentChargeDetails? = null
}

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 HeldPaymentChargeRefundRq 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}/heldpayment/chargerefund HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"integrationType":"String","NationalId":0,"ChapterId":0,"UserId":0,"ContextIntegrationPartnerId":0,"CallerIntegrationPartnerId":0,"AuthenticationId":0,"Amount":0,"Description":"String","GatewayConfirmation":"String","CardInfo":{"CardRef":"String","ExpMonth":0,"ExpYear":0,"CVV":"String","CardType":"String","NameOnCard":"String","Address1":"String","Address2":"String","City":"String","State":"String","PostalCode":"String","Country":"String"}}

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

{"NationalId":0,"ChapterId":0,"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"}}}}