Billhighway Cloud API

<back to all web services

CoreChargeRq

export class CoreChargeGatewaySaleResponse
{
    public FailureType?: string;
    public IsDuplicate?: boolean;
    public IsSuccessful?: boolean;
    public ErrorCode?: string;
    public Message?: string;
    public GatewayId?: number;
    public ConfirmationNumber?: string;
    public NetworkTransactionId?: string;

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

export class AttributeItem
{
    public Name?: string;
    public Value?: string;

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

export class CreditCardBillingAddressItem
{
    public Address1?: string;
    public Address2?: string;
    public City?: string;
    public PostalCode?: string;
    public Region?: string;
    public Country?: string;
    public Attributes?: AttributeItem[];

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

export class CreditCardChargeVerificationResult
{
    public NetworkVerificationAttempted?: boolean;
    public CvvVerificationResult?: string;
    public AddressVerificationResult?: string;
    public PostalCodeVerificationResult?: string;

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

export class CoreCreditCardChargeDetails
{
    public CardType?: string;
    public ExpMonth?: number;
    public ExpYear?: number;
    public Last4?: string;
    public Address?: CreditCardBillingAddressItem;
    public VerificationResult?: CreditCardChargeVerificationResult;

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

export class CoreChargeDetails
{
    public PaymentType?: string;
    public Amount?: number;
    public IntegrationType?: string;
    public Currency?: string;
    public CardDetails?: CoreCreditCardChargeDetails;

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

export class CoreChargeRs
{
    public TransactionId?: string;
    public StoredAccountId?: number;
    public NationalId?: number;
    public ChapterId?: number;
    public ChargeType?: string;
    public IntegrationType?: string;
    public ContextIntegrationPartnerId?: number;
    public CallerIntegrationPartnerId?: number;
    public GatewayResponse?: CoreChargeGatewaySaleResponse;
    public ChargeDetails?: CoreChargeDetails;

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

export class ReferenceIdTypedAssociationItem
{
    public Value?: string;
    public Type?: string;

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

export class CoreChargeRq implements IChargeRequest
{
    // @ApiMember(ParameterType="path")
    public integrationType?: string;

    public NationalId?: number;
    public ChapterId?: number;
    public StoredAccountId?: number;
    public ContextIntegrationPartnerId?: number;
    public CallerIntegrationPartnerId?: number;
    public UserId?: number;
    public AuthenticationId?: number;
    public ChargeType?: string;
    public Token?: string;
    // @ApiMember(Format="decimal", ParameterType="model")
    public Amount?: number;

    public Description?: string;
    public Invoices?: { [index: number]: number; };
    public CreatedById?: number;
    public ReferenceIds?: ReferenceIdTypedAssociationItem[];
    public TransactionId?: number;

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

TypeScript CoreChargeRq DTOs

POST /integrations/api/{integrationType}/core/charge HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	integrationType: String,
	NationalId: 0,
	ChapterId: 0,
	StoredAccountId: 0,
	ContextIntegrationPartnerId: 0,
	CallerIntegrationPartnerId: 0,
	UserId: 0,
	AuthenticationId: 0,
	ChargeType: String,
	Token: String,
	Amount: 0,
	Description: String,
	Invoices: 
	{
		0: 0
	},
	CreatedById: 0,
	ReferenceIds: 
	[
		{
			Value: String,
			Type: String
		}
	],
	TransactionId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TransactionId: String,
	StoredAccountId: 0,
	NationalId: 0,
	ChapterId: 0,
	ChargeType: String,
	IntegrationType: String,
	ContextIntegrationPartnerId: 0,
	CallerIntegrationPartnerId: 0,
	GatewayResponse: 
	{
		FailureType: String,
		IsDuplicate: False,
		IsSuccessful: False,
		ErrorCode: String,
		Message: String,
		GatewayId: 0,
		ConfirmationNumber: String,
		NetworkTransactionId: String
	},
	ChargeDetails: 
	{
		PaymentType: String,
		Amount: 0,
		IntegrationType: String,
		Currency: String,
		CardDetails: 
		{
			CardType: String,
			ExpMonth: 0,
			ExpYear: 0,
			Last4: String,
			Address: 
			{
				Address1: String,
				Address2: String,
				City: String,
				PostalCode: String,
				Region: String,
				Country: String,
				Attributes: 
				[
					{
						Name: String,
						Value: String
					}
				]
			},
			VerificationResult: 
			{
				NetworkVerificationAttempted: False,
				CvvVerificationResult: String,
				AddressVerificationResult: String,
				PostalCodeVerificationResult: String
			}
		}
	}
}