Billhighway Cloud API

<back to all web services

CoreChargeVerifyRq

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

namespace BH.CloudAPI.DTO
{
    public partial class AchVerificationDetails
    {
        public virtual bool IsError { get; set; }
        public virtual bool NetworkVerificationAttempted { get; set; }
        public virtual string Result { get; set; }
        public virtual string Code { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class CreditCardVerificationDetails
    {
        public virtual bool IsError { get; set; }
        public virtual bool IsDuplicate { get; set; }
        public virtual string GatewayResponseCode { get; set; }
        public virtual string GatewayMessage { get; set; }
        public virtual bool NetworkVerificationAttempted { get; set; }
        public virtual string CvvVerificationResult { get; set; }
        public virtual string AddressVerificationResult { get; set; }
        public virtual string PostalCodeVerificationResult { get; set; }
        public virtual string NetworkTransactionId { get; set; }
    }

}

namespace BH.CloudAPI.DTO.CoreCharges.Api.Request
{
    public partial class CoreChargeVerifyRq
    {
        public virtual decimal? reCaptchaScore { get; set; }
        public virtual string integrationType { get; set; }
        public virtual int NationalId { get; set; }
        public virtual int ChapterId { get; set; }
        public virtual int ContextIntegrationPartnerId { get; set; }
        public virtual int AuthenticationId { get; set; }
        public virtual string Token { get; set; }
    }

}

namespace BH.CloudAPI.DTO.CoreCharges.Api.Response
{
    public partial class CoreChargeVerifyRs
    {
        public virtual string Token { get; set; }
        public virtual CreditCardVerificationDetails CardVerificationDetails { get; set; }
        public virtual AchVerificationDetails AchVerificationDetails { get; set; }
    }

}

C# 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
	}
}