Billhighway Cloud API

ChargeTokenRq

The following routes are available for this service:
POST	/integrations/api/{tokenType}/charge/token

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.DTO.Charges.Api.Request;
using BH.CloudAPI.DTO.Charges;
using BH.CloudAPI.DTO.Charges.Api;
using BH.CloudAPI.Common4.DTO;
using BH.CloudAPI.DTO;
using BH.CloudAPI.DTO.Charges.Api.Response;

namespace BH.CloudAPI.Common4.DTO
{
    public partial class AttributeItem
    {
        public virtual string Name { get; set; }
        public virtual string Value { get; set; }
    }

}

namespace BH.CloudAPI.DTO
{
    public partial class ReferenceIdTypedAssociationItem
    {
        public virtual string Value { get; set; }
        public virtual string Type { get; set; }
    }

}

namespace BH.CloudAPI.DTO.Charges
{
    public partial class ChargeTokenOptions
    {
        public virtual int Usages { get; set; }
        public virtual int Duration { get; set; }
    }

}

namespace BH.CloudAPI.DTO.Charges.Api
{
    public partial class AchChargeDetails
    {
        public virtual string AccountType { get; set; }
        public virtual string RoutingNumber { get; set; }
        public virtual string AccountNumberLast4 { get; set; }
        public virtual string BankName { get; set; }
        public virtual AchChargeVerificationResult VerificationResult { get; set; }
    }

    public partial class AchChargeItem
    {
        public virtual string AccountNumber { get; set; }
        public virtual string RoutingNumber { get; set; }
        public virtual string AccountType { get; set; }
        public virtual string AccountHolderName { get; set; }
    }

    public partial class AchChargeVerificationResult
    {
        public virtual bool NetworkVerificationAttempted { get; set; }
        public virtual string Result { get; set; }
    }

    public partial class CreditCardBillingAddressItem
    {
        public CreditCardBillingAddressItem()
        {
            Attributes = new List<AttributeItem>{};
        }

        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string City { get; set; }
        public virtual string PostalCode { get; set; }
        public virtual string Region { get; set; }
        public virtual string Country { get; set; }
        public virtual List<AttributeItem> Attributes { get; set; }
    }

    public partial class CreditCardChargeDetails
    {
        public virtual string CardType { get; set; }
        public virtual int ExpMonth { get; set; }
        public virtual int ExpYear { get; set; }
        public virtual string Last4 { get; set; }
        public virtual CreditCardBillingAddressItem Address { get; set; }
        public virtual CreditCardChargeVerificationResult VerificationResult { get; set; }
    }

    public partial class CreditCardChargeItem
    {
        public virtual string NameOnCard { get; set; }
        public virtual int ExpMonth { get; set; }
        public virtual int ExpYear { get; set; }
        public virtual string CardNumber { get; set; }
        public virtual string Cvv { get; set; }
        public virtual CreditCardBillingAddressItem Address { get; set; }
    }

    public partial class CreditCardChargeVerificationResult
    {
        public virtual bool NetworkVerificationAttempted { get; set; }
        public virtual string CvvVerificationResult { get; set; }
        public virtual string AddressVerificationResult { get; set; }
        public virtual string PostalCodeVerificationResult { get; set; }
    }

}

namespace BH.CloudAPI.DTO.Charges.Api.Request
{
    public partial class ChargeTokenRq
        : ChargeTokenRqBase
    {
    }

    public partial class ChargeTokenRqBase
        : IChapterAuthorizationRequest, IApiResultErrorService
    {
        public ChargeTokenRqBase()
        {
            ReferenceIds = new List<ReferenceIdTypedAssociationItem>{};
        }

        public virtual string tokenType { get; set; }
        public virtual int Amount { get; set; }
        public virtual string Description { get; set; }
        public virtual ChargeTokenOptions Options { get; set; }
        public virtual CreditCardChargeItem CardInfo { get; set; }
        public virtual AchChargeItem AchInfo { get; set; }
        public virtual List<ReferenceIdTypedAssociationItem> ReferenceIds { get; set; }
    }

}

namespace BH.CloudAPI.DTO.Charges.Api.Response
{
    public partial class ChargeTokenRs
    {
        public virtual string Token { get; set; }
        public virtual int OrganizationId { get; set; }
        public virtual int ChapterId { get; set; }
        public virtual int Amount { get; set; }
        public virtual string TokenType { get; set; }
        public virtual string Description { get; set; }
        public virtual DateTime ExpiresOn { get; set; }
        public virtual string Currency { get; set; }
        public virtual int Usages { get; set; }
        public virtual CreditCardChargeDetails CardDetails { get; set; }
        public virtual AchChargeDetails AchDetails { get; set; }
    }

}

C# ChargeTokenRq 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/{tokenType}/charge/token HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	tokenType: String,
	Amount: 0,
	Description: String,
	Options: 
	{
		Usages: 0,
		Duration: 0
	},
	CardInfo: 
	{
		NameOnCard: String,
		ExpMonth: 0,
		ExpYear: 0,
		CardNumber: String,
		Cvv: String,
		Address: 
		{
			Address1: String,
			Address2: String,
			City: String,
			PostalCode: String,
			Region: String,
			Country: String,
			Attributes: 
			[
				{
					Name: String,
					Value: String
				}
			]
		}
	},
	AchInfo: 
	{
		AccountNumber: String,
		RoutingNumber: String,
		AccountType: String,
		AccountHolderName: String
	},
	ReferenceIds: 
	[
		{
			Value: String,
			Type: String
		}
	]
}

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

{
	Token: String,
	OrganizationId: 0,
	ChapterId: 0,
	Amount: 0,
	TokenType: String,
	Description: String,
	ExpiresOn: 0001-01-01,
	Currency: String,
	Usages: 0,
	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
		}
	},
	AchDetails: 
	{
		AccountType: String,
		RoutingNumber: String,
		AccountNumberLast4: String,
		BankName: String,
		VerificationResult: 
		{
			NetworkVerificationAttempted: False,
			Result: String
		}
	}
}