Billhighway Cloud API

CreditCardVerify

The following routes are available for this service:
POST	/api/v2/PaymentMethods/CC/Verification	Performs 0 dollar verify of a credit card.	Validates the credit card type, expiration date and performs credit card address verification against the credit card networks.

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 CreditCardVerifyResult() = 
        inherit CreditCardCloudServiceResponse()
        member val CardRef:String = null with get,set

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

F# CreditCardVerify 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 /api/v2/PaymentMethods/CC/Verification HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreditCardVerify xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <Address1 xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Address1>
  <Address2 xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Address2>
  <Amount xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</Amount>
  <CVV xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CVV>
  <CardNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CardNumber>
  <CardType xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">AmericanExpress</CardType>
  <ChapAndUser xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ChapAndUser>
  <City xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</City>
  <Country xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Country>
  <CurrencyCode xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CurrencyCode>
  <Description xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Description>
  <EnsureValidZipAndCvc xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">false</EnsureValidZipAndCvc>
  <ExpMonth xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ExpMonth>
  <ExpYear xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ExpYear>
  <GroupId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</GroupId>
  <Location xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Location>
  <NameOnCard xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</NameOnCard>
  <PayLinkID xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</PayLinkID>
  <PostalCode xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</PostalCode>
  <ReCaptchaScore xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ReCaptchaScore>
  <State xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</State>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</UserId>
</CreditCardVerify>

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

<CreditCardVerifyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <ConfirmationNumber>String</ConfirmationNumber>
  <ErrorCode>String</ErrorCode>
  <GatewayId>0</GatewayId>
  <IsDuplicate>false</IsDuplicate>
  <IsSuccessful>false</IsSuccessful>
  <Message>String</Message>
  <NetworkTransactionId>String</NetworkTransactionId>
  <CardRef>String</CardRef>
</CreditCardVerifyResult>