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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"GroupId":"String","CardNumber":"String","CardType":"String","ExpirationMonth":0,"ExpirationYear":0}

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

{"CardToken":"String","ErrorMessage":"String","ErrorCode":0,"IsError":false,"CardReference":"String"}