Billhighway Cloud API

<back to all web services

CreditCardPaymentCollection

The following routes are available for this service:
POST/payments/creditcard
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.SalesForce
Imports BH.CloudAPI.Common4.DTO

Namespace Global

    Namespace BH.CloudAPI.Common4.DTO

        Public Partial Class CreditCardPayment
            Inherits CreditCardPayment
            Public Overridable Property SubscriptionInfo As SubscriptionParameters
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.SalesForce

        Public Partial Class CreditCardPaymentCollection
            Public Sub New()
                CreditCardPaymentList = New List(Of CreditCardPayment)
            End Sub

            Public Overridable Property CreditCardPaymentList As List(Of CreditCardPayment)
        End Class

        Public Partial Class CreditCardPaymentReply
            Public Overridable Property ClassName As String
            Public Overridable Property UniqueId As String
            Public Overridable Property CreatedDateTime As Date
            Public Overridable Property ClientId As Integer
            Public Overridable Property TransactionId As String
            Public Overridable Property ErrorCode As Integer
            Public Overridable Property ErrorMessage As String
        End Class

        Public Partial Class SubscriberFormField
            Public Overridable Property Name As String
            Public Overridable Property Value As String
        End Class

        Public Partial Class SubscriptionParameters
            Public Sub New()
                Fields = New List(Of SubscriberFormField)
            End Sub

            Public Overridable Property FormTemplateID As Integer
            Public Overridable Property SubscriptionInvoiceID As Integer
            Public Overridable Property ClientSubscriberId As String
            Public Overridable Property SignupTypeID As Integer
            Public Overridable Property FrequencyID As Integer
            Public Overridable Property AutoRenew As Boolean
            Public Overridable Property CompanyID As Long
            Public Overridable Property UserID As Integer
            Public Overridable Property ChapMemPayID As Long
            Public Overridable Property MemberSubscriptionInvID As Long
            Public Overridable Property Fields As List(Of SubscriberFormField)
            Public Overridable Property CreatedBy As Integer
            Public Overridable Property UpdatedBy As Integer
            Public Overridable Property AptifyUpdateType As Integer
            Public Overridable Property RenewedMemberSubscriptionInvID As Long
            Public Overridable Property ChapId As Integer
        End Class
    End Namespace
End Namespace

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

{"CreditCardPaymentList":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","BhUserId":0,"Amount":"String","AutoPay":false,"CurrencyType":"String","Country":"String","CardReferenceOrCardNumber":"String","StoreCardInfo":false,"Address1":"String","Address2":"String","BillingCity":"String","BillingState":"String","PreferredEmailAddress":"String","Memo":"String","OpportunityId":"String","ExpMonth":0,"ExpYear":0,"Cvv":"String","PostalCode":"String","Location":"String","NameOnCard":"String","CardType":"String","InvoiceList":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"Invoice":0,"AmountPaid":"String"}]}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"TransactionId":"String","ErrorCode":0,"ErrorMessage":"String"}