Billhighway Cloud API

CreditCardReference

The following routes are available for this service:
POST	/payments/creditcard/token	(Deprecated)	(Deprecated)
POST	/payments/creditcard/ref

import 'package:servicestack/servicestack.dart';

class CreditCardReferenceReply implements IHaveErrorField, IConvertible
{
    /**
    * Same as CardReference, however this field is deprecated
    */
    // @ApiMember(Description="Same as CardReference, however this field is deprecated")
    String? CardToken;

    String? ErrorMessage;
    int? ErrorCode;
    // @ApiMember(ExcludeInSchema=true)
    bool? IsError;

    String? CardReference;

    CreditCardReferenceReply({this.CardToken,this.ErrorMessage,this.ErrorCode,this.IsError,this.CardReference});
    CreditCardReferenceReply.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CardToken = json['CardToken'];
        ErrorMessage = json['ErrorMessage'];
        ErrorCode = json['ErrorCode'];
        IsError = json['IsError'];
        CardReference = json['CardReference'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CardToken': CardToken,
        'ErrorMessage': ErrorMessage,
        'ErrorCode': ErrorCode,
        'IsError': IsError,
        'CardReference': CardReference
    };

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

class CreditCardReference implements IConvertible
{
    // @ApiMember(IsRequired=true)
    String? GroupId;

    // @ApiMember(IsRequired=true)
    String? CardNumber;

    // @ApiMember(IsRequired=true)
    String? CardType;

    // @ApiMember(IsRequired=true)
    int? ExpirationMonth;

    // @ApiMember(IsRequired=true)
    int? ExpirationYear;

    CreditCardReference({this.GroupId,this.CardNumber,this.CardType,this.ExpirationMonth,this.ExpirationYear});
    CreditCardReference.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        GroupId = json['GroupId'];
        CardNumber = json['CardNumber'];
        CardType = json['CardType'];
        ExpirationMonth = json['ExpirationMonth'];
        ExpirationYear = json['ExpirationYear'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'GroupId': GroupId,
        'CardNumber': CardNumber,
        'CardType': CardType,
        'ExpirationMonth': ExpirationMonth,
        'ExpirationYear': ExpirationYear
    };

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

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

Dart CreditCardReference DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /payments/creditcard/token HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreditCardReference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <CardNumber>String</CardNumber>
  <CardType>String</CardType>
  <ExpirationMonth>0</ExpirationMonth>
  <ExpirationYear>0</ExpirationYear>
  <GroupId>String</GroupId>
</CreditCardReference>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreditCardReferenceReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <CardReference>String</CardReference>
  <CardToken>String</CardToken>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <IsError>false</IsError>
</CreditCardReferenceReply>