Billhighway Cloud API

CreditCardSale

The following routes are available for this service:
POST	/api/CreditCard/Sale	Performs a credit card sale	Performs 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.

import 'package:servicestack/servicestack.dart';

class CreditCardCloudServiceResponse implements IHaveErrorField, IConvertible
{
    bool? IsDuplicate;
    bool? IsSuccessful;
    String? ErrorCode;
    String? Message;
    int? GatewayId;
    String? ConfirmationNumber;
    String? NetworkTransactionId;
    bool? IsError;

    CreditCardCloudServiceResponse({this.IsDuplicate,this.IsSuccessful,this.ErrorCode,this.Message,this.GatewayId,this.ConfirmationNumber,this.NetworkTransactionId,this.IsError});
    CreditCardCloudServiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        IsDuplicate = json['IsDuplicate'];
        IsSuccessful = json['IsSuccessful'];
        ErrorCode = json['ErrorCode'];
        Message = json['Message'];
        GatewayId = json['GatewayId'];
        ConfirmationNumber = json['ConfirmationNumber'];
        NetworkTransactionId = json['NetworkTransactionId'];
        IsError = json['IsError'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'IsDuplicate': IsDuplicate,
        'IsSuccessful': IsSuccessful,
        'ErrorCode': ErrorCode,
        'Message': Message,
        'GatewayId': GatewayId,
        'ConfirmationNumber': ConfirmationNumber,
        'NetworkTransactionId': NetworkTransactionId,
        'IsError': IsError
    };

    getTypeName() => "CreditCardCloudServiceResponse";
    TypeContext? context = _ctx;
}

class CreditCardSaleResult extends CreditCardCloudServiceResponse implements IConvertible
{
    CreditCardSaleResult();
    CreditCardSaleResult.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "CreditCardSaleResult";
    TypeContext? context = _ctx;
}

class CreditCardSale extends CreditCardSale implements IConvertible
{
    CreditCardSale();
    CreditCardSale.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "CreditCardSale";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'CreditCardCloudServiceResponse': TypeInfo(TypeOf.Class, create:() => CreditCardCloudServiceResponse()),
    'CreditCardSaleResult': TypeInfo(TypeOf.Class, create:() => CreditCardSaleResult()),
    'CreditCardSale': TypeInfo(TypeOf.Class, create:() => CreditCardSale()),
});

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