Billhighway Cloud API

<back to all web services

CreditCardSale

The following routes are available for this service:
POST/api/CreditCard/SalePerforms a credit card salePerforms a low level credit card charge WITHOUT recording credit the as a deposit or payment. This shouldbe used only in conjunction with code that records the credit.
namespace BH.CloudAPI.Common.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CreditCardCloudServiceResponse() = 
        member val IsDuplicate:Boolean = new Boolean() with get,set
        member val IsSuccessful:Boolean = new Boolean() with get,set
        member val ErrorCode:String = null with get,set
        member val Message:String = null with get,set
        member val GatewayId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ConfirmationNumber:String = null with get,set
        member val NetworkTransactionId:String = null with get,set
        member val IsError:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CreditCardSaleResult() = 
        inherit CreditCardCloudServiceResponse()

    [<AllowNullLiteral>]
    type CreditCardSale() = 
        inherit CreditCardSale()

F# CreditCardSale 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 /api/CreditCard/Sale HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClientId: 0,
	GroupId: String,
	UserId: String,
	BhUserId: 0,
	UniqueId: String,
	Location: String,
	CurrencyCode: String,
	NameOnCard: String,
	Address1: String,
	Address2: String,
	City: String,
	State: String,
	PostalCode: String,
	Country: String,
	CardType: 0,
	CardNumber: String,
	ExpMonth: 0,
	ExpYear: 0,
	CVV: String,
	Amount: 0,
	ChapAndUser: String,
	Description: String,
	PayLinkID: 0,
	AutoPay: False,
	StoreCardInfo: False,
	PaymentSourceTypeID: 0,
	PaymentSourceID: 0,
	ProcessingType: 0,
	NetworkTransactionID: String,
	ReCaptchaScore: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsDuplicate: False,
	IsSuccessful: False,
	ErrorCode: String,
	Message: String,
	GatewayId: 0,
	ConfirmationNumber: String,
	NetworkTransactionId: String,
	IsError: True
}