Billhighway Cloud API

<back to all web services

CreditCardReference

The following routes are available for this service:
POST/payments/creditcard/token(Deprecated)(Deprecated)
POST/payments/creditcard/ref
namespace BH.CloudAPI.Common4.DTO.SalesForce

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

    [<AllowNullLiteral>]
    type CreditCardReferenceReply() = 
        ///<summary>
        ///Same as CardReference, however this field is deprecated
        ///</summary>
        [<ApiMember(Description="Same as CardReference, however this field is deprecated")>]
        member val CardToken:String = null with get,set

        member val ErrorMessage:String = null with get,set
        member val ErrorCode:Int32 = new Int32() with get,set
        [<ApiMember(ExcludeInSchema=true)>]
        member val IsError:Boolean = new Boolean() with get,set

        member val CardReference:String = null with get,set

    [<AllowNullLiteral>]
    type CreditCardReference() = 
        [<ApiMember(IsRequired=true)>]
        member val GroupId:String = null with get,set

        [<ApiMember(IsRequired=true)>]
        member val CardNumber:String = null with get,set

        [<ApiMember(IsRequired=true)>]
        member val CardType:String = null with get,set

        [<ApiMember(IsRequired=true)>]
        member val ExpirationMonth:Int32 = new Int32() with get,set

        [<ApiMember(IsRequired=true)>]
        member val ExpirationYear:Int32 = new Int32() with get,set

F# 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>