Billhighway Cloud API

HeldPaymentChargeRefundRq

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

import Foundation
import ServiceStack

public class HeldPaymentChargeRefundRq : Codable
{
    public var integrationType:String?
    public var nationalId:Int?
    public var chapterId:Int?
    public var userId:Int?
    public var contextIntegrationPartnerId:Int?
    public var callerIntegrationPartnerId:Int?
    public var authenticationId:Int?
    public var amount:Double?
    public var Description:String?
    public var gatewayConfirmation:String?
    public var cardInfo:HeldPaymentCreditCardChargeRefundDetails?

    required public init(){}
}

public class HeldPaymentCreditCardChargeRefundDetails : Codable
{
    public var cardRef:String?
    public var expMonth:Int?
    public var expYear:Int?
    public var cvv:String?
    public var cardType:String?
    public var nameOnCard:String?
    public var address1:String?
    public var address2:String?
    public var city:String?
    public var state:String?
    public var postalCode:String?
    public var country:String?

    required public init(){}
}

public class HeldPaymentChargeRefundRs : Codable
{
    public var nationalId:Int?
    public var chapterId:Int?
    public var integrationType:String?
    public var contextIntegrationPartnerId:Int?
    public var callerIntegrationPartnerId:Int?
    public var gatewayResponse:HeldPaymentGatewaySaleResponse?
    public var chargeDetails:HeldPaymentChargeDetails?

    required public init(){}
}

public class HeldPaymentGatewaySaleResponse : Codable
{
    public var failureType:String?
    public var isDuplicate:Bool?
    public var isSuccessful:Bool?
    public var errorCode:String?
    public var message:String?
    public var gatewayId:Int?
    public var confirmationNumber:String?
    public var networkTransactionId:String?

    required public init(){}
}

public class HeldPaymentChargeDetails : Codable
{
    public var paymentType:String?
    public var amount:Double?
    public var integrationType:String?
    public var currency:String?
    public var cardDetails:HeldPaymentCreditCardChargeDetails?
    public var achDetails:HeldPaymentAchChargeDetails?

    required public init(){}
}

public class HeldPaymentCreditCardChargeDetails : Codable
{
    public var cardType:String?
    public var expMonth:Int?
    public var expYear:Int?
    public var last4:String?
    public var address:CreditCardBillingAddressItem?
    public var verificationResult:CreditCardChargeVerificationResult?

    required public init(){}
}

public class CreditCardBillingAddressItem : Codable
{
    public var address1:String?
    public var address2:String?
    public var city:String?
    public var postalCode:String?
    public var region:String?
    public var country:String?
    public var attributes:[AttributeItem] = []

    required public init(){}
}

public class AttributeItem : Codable
{
    public var name:String?
    public var value:String?

    required public init(){}
}

public class CreditCardChargeVerificationResult : Codable
{
    public var networkVerificationAttempted:Bool?
    public var cvvVerificationResult:String?
    public var addressVerificationResult:String?
    public var postalCodeVerificationResult:String?

    required public init(){}
}

public class HeldPaymentAchChargeDetails : Codable
{
    public var accountType:String?
    public var routingNumber:String?
    public var accountNumberLast4:String?
    public var bankName:String?
    public var verificationResult:AchChargeVerificationResult?

    required public init(){}
}

public class AchChargeVerificationResult : Codable
{
    public var networkVerificationAttempted:Bool?
    public var result:String?

    required public init(){}
}

Swift HeldPaymentChargeRefundRq 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/chargerefund HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv
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
			}
		}
	}
}