Billhighway Cloud API

<back to all web services

CoreChargeVerifyRq

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

export class CreditCardVerificationDetails
{
    public IsError?: boolean;
    public IsDuplicate?: boolean;
    public GatewayResponseCode?: string;
    public GatewayMessage?: string;
    public NetworkVerificationAttempted?: boolean;
    public CvvVerificationResult?: string;
    public AddressVerificationResult?: string;
    public PostalCodeVerificationResult?: string;
    public NetworkTransactionId?: string;

    public constructor(init?: Partial<CreditCardVerificationDetails>) { (Object as any).assign(this, init); }
}

export class AchVerificationDetails
{
    public IsError?: boolean;
    public NetworkVerificationAttempted?: boolean;
    public Result?: string;
    public Code?: string;
    public Message?: string;

    public constructor(init?: Partial<AchVerificationDetails>) { (Object as any).assign(this, init); }
}

export class CoreChargeVerifyRs
{
    public Token?: string;
    public CardVerificationDetails?: CreditCardVerificationDetails;
    public AchVerificationDetails?: AchVerificationDetails;

    public constructor(init?: Partial<CoreChargeVerifyRs>) { (Object as any).assign(this, init); }
}

export class CoreChargeVerifyRq
{
    public reCaptchaScore?: number;
    public integrationType?: string;
    public NationalId?: number;
    public ChapterId?: number;
    public ContextIntegrationPartnerId?: number;
    public AuthenticationId?: number;
    public Token?: string;

    public constructor(init?: Partial<CoreChargeVerifyRq>) { (Object as any).assign(this, init); }
}

TypeScript 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
	}
}