Billhighway Cloud API

<back to all web services

CoreChargeVerifyRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/core/verifycharge
CoreChargeVerifyRq Parameters:
NameParameterData TypeRequiredDescription
reCaptchaScorebodydecimal?No
integrationTypepathstringNo
NationalIdbodyintNo
ChapterIdbodyintNo
ContextIntegrationPartnerIdbodyintNo
AuthenticationIdbodyintNo
TokenbodystringNo
CoreChargeVerifyRs Parameters:
NameParameterData TypeRequiredDescription
TokenformstringNo
CardVerificationDetailsformCreditCardVerificationDetailsNo
AchVerificationDetailsformAchVerificationDetailsNo
CreditCardVerificationDetails Parameters:
NameParameterData TypeRequiredDescription
IsErrorformboolNo
IsDuplicateformboolNo
GatewayResponseCodeformstringNo
GatewayMessageformstringNo
NetworkVerificationAttemptedformboolNo
CvvVerificationResultformstringNo
AddressVerificationResultformstringNo
PostalCodeVerificationResultformstringNo
NetworkTransactionIdformstringNo
AchVerificationDetails Parameters:
NameParameterData TypeRequiredDescription
IsErrorformboolNo
NetworkVerificationAttemptedformboolNo
ResultformstringNo
CodeformstringNo
MessageformstringNo

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}/core/verifycharge HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reCaptchaScore: 0,
	integrationType: String,
	NationalId: 0,
	ChapterId: 0,
	ContextIntegrationPartnerId: 0,
	AuthenticationId: 0,
	Token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Token: String,
	CardVerificationDetails: 
	{
		IsError: False,
		IsDuplicate: False,
		GatewayResponseCode: String,
		GatewayMessage: String,
		NetworkVerificationAttempted: False,
		CvvVerificationResult: String,
		AddressVerificationResult: String,
		PostalCodeVerificationResult: String,
		NetworkTransactionId: String
	},
	AchVerificationDetails: 
	{
		IsError: False,
		NetworkVerificationAttempted: False,
		Result: String,
		Code: String,
		Message: String
	}
}