Billhighway Cloud API

<back to all web services

CoreChargeVerifyRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/core/verifycharge
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.DTO.CoreCharges.Api.Request
Imports BH.CloudAPI.DTO.CoreCharges.Api.Response
Imports BH.CloudAPI.DTO

Namespace Global

    Namespace BH.CloudAPI.DTO

        Public Partial Class AchVerificationDetails
            Public Overridable Property IsError As Boolean
            Public Overridable Property NetworkVerificationAttempted As Boolean
            Public Overridable Property Result As String
            Public Overridable Property Code As String
            Public Overridable Property Message As String
        End Class

        Public Partial Class CreditCardVerificationDetails
            Public Overridable Property IsError As Boolean
            Public Overridable Property IsDuplicate As Boolean
            Public Overridable Property GatewayResponseCode As String
            Public Overridable Property GatewayMessage As String
            Public Overridable Property NetworkVerificationAttempted As Boolean
            Public Overridable Property CvvVerificationResult As String
            Public Overridable Property AddressVerificationResult As String
            Public Overridable Property PostalCodeVerificationResult As String
            Public Overridable Property NetworkTransactionId As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.DTO.CoreCharges.Api.Request

        Public Partial Class CoreChargeVerifyRq
            Public Overridable Property reCaptchaScore As Nullable(Of Decimal)
            Public Overridable Property integrationType As String
            Public Overridable Property NationalId As Integer
            Public Overridable Property ChapterId As Integer
            Public Overridable Property ContextIntegrationPartnerId As Integer
            Public Overridable Property AuthenticationId As Integer
            Public Overridable Property Token As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.DTO.CoreCharges.Api.Response

        Public Partial Class CoreChargeVerifyRs
            Public Overridable Property Token As String
            Public Overridable Property CardVerificationDetails As CreditCardVerificationDetails
            Public Overridable Property AchVerificationDetails As AchVerificationDetails
        End Class
    End Namespace
End Namespace

VB.NET 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
	}
}