Billhighway Cloud API

<back to all web services

CoreChargeVerifyRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/core/verifycharge
namespace BH.CloudAPI.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CreditCardVerificationDetails() = 
        member val IsError:Boolean = new Boolean() with get,set
        member val IsDuplicate:Boolean = new Boolean() with get,set
        member val GatewayResponseCode:String = null with get,set
        member val GatewayMessage:String = null with get,set
        member val NetworkVerificationAttempted:Boolean = new Boolean() with get,set
        member val CvvVerificationResult:String = null with get,set
        member val AddressVerificationResult:String = null with get,set
        member val PostalCodeVerificationResult:String = null with get,set
        member val NetworkTransactionId:String = null with get,set

    [<AllowNullLiteral>]
    type AchVerificationDetails() = 
        member val IsError:Boolean = new Boolean() with get,set
        member val NetworkVerificationAttempted:Boolean = new Boolean() with get,set
        member val Result:String = null with get,set
        member val Code:String = null with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type CoreChargeVerifyRs() = 
        member val Token:String = null with get,set
        member val CardVerificationDetails:CreditCardVerificationDetails = null with get,set
        member val AchVerificationDetails:AchVerificationDetails = null with get,set

    [<AllowNullLiteral>]
    type CoreChargeVerifyRq() = 
        member val reCaptchaScore:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val integrationType:String = null with get,set
        member val NationalId:Int32 = new Int32() with get,set
        member val ChapterId:Int32 = new Int32() with get,set
        member val ContextIntegrationPartnerId:Int32 = new Int32() with get,set
        member val AuthenticationId:Int32 = new Int32() with get,set
        member val Token:String = null with get,set

F# CoreChargeVerifyRq 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}/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
	}
}