Billhighway Cloud API

<back to all web services

CreditCardSale

The following routes are available for this service:
POST/api/CreditCard/SalePerforms a credit card salePerforms 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.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO
Imports BH.CloudAPI.Common.DTO

Namespace Global

    Namespace BH.CloudAPI.Common.DTO

        Public Partial Class CreditCardCloudServiceResponse
            Implements IHaveErrorField
            Public Overridable Property IsDuplicate As Boolean
            Public Overridable Property IsSuccessful As Boolean
            Public Overridable Property ErrorCode As String
            Public Overridable Property Message As String
            Public Overridable Property GatewayId As Nullable(Of Integer)
            Public Overridable Property ConfirmationNumber As String
            Public Overridable Property NetworkTransactionId As String
            Public Overridable Property IsError As Boolean
        End Class

        Public Partial Class CreditCardSaleResult
            Inherits CreditCardCloudServiceResponse
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO

        Public Partial Class CreditCardSale
            Inherits CreditCardSale
        End Class
    End Namespace
End Namespace

VB.NET CreditCardSale 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 /api/CreditCard/Sale HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

{"IsDuplicate":false,"IsSuccessful":false,"ErrorCode":"String","Message":"String","GatewayId":0,"ConfirmationNumber":"String","NetworkTransactionId":"String","IsError":true}