Billhighway Cloud API

<back to all web services

SalesForceCreditCardPaymentCollection

The following routes are available for this service:
POST/api/SalesForce/CreditCardPayment
import Foundation
import ServiceStack

public class SalesForceCreditCardPaymentCollection : Codable
{
    public var salesForceCreditCardPaymentList:[SalesForceCreditCardPayment] = []

    required public init(){}
}

public class SalesForceCreditCardPayment : Codable
{
    public var className:String?
    public var uniqueId:String?
    public var createdDateTime:Date?
    public var clientId:Int?
    public var groupId:String?
    public var userId:String?
    public var bhUserId:Int?
    public var amount:String?
    public var autoPay:Bool?
    public var currencyType:String?
    public var country:String?
    public var cardReferenceOrCardNumber:String?
    public var storeCardInfo:Bool?
    public var address1:String?
    public var address2:String?
    public var billingCity:String?
    public var billingState:String?
    public var preferredEmailAddress:String?
    public var memo:String?
    public var opportunityId:String?
    public var expMonth:Int?
    public var expYear:Int?
    public var cvv:String?
    public var postalCode:String?
    public var location:String?
    public var nameOnCard:String?
    public var cardType:String?
    public var invoiceList:[SalesForceMemberPaymentInvoiceDetail] = []

    required public init(){}
}

public class SalesForceMemberPaymentInvoiceDetail : Codable
{
    public var className:String?
    public var uniqueId:String?
    public var createdDateTime:Date?
    public var clientId:Int?
    public var invoice:Int?
    public var amountPaid:String?

    required public init(){}
}

public class SalesForceCreditCardPaymentReply : Codable
{
    public var className:String?
    public var uniqueId:String?
    public var createdDateTime:Date?
    public var clientId:Int?
    public var transactionId:String?
    public var errorCode:Int?
    public var errorMessage:String?

    required public init(){}
}


Swift SalesForceCreditCardPaymentCollection 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/SalesForce/CreditCardPayment HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SalesForceCreditCardPaymentCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <SalesForceCreditCardPaymentList>
    <SalesForceCreditCardPayment>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <Amount>String</Amount>
      <AutoPay>false</AutoPay>
      <BhUserId>0</BhUserId>
      <BillingCity>String</BillingCity>
      <BillingState>String</BillingState>
      <CardReferenceOrCardNumber>String</CardReferenceOrCardNumber>
      <CardType>String</CardType>
      <ClassName>String</ClassName>
      <ClientId>0</ClientId>
      <Country>String</Country>
      <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
      <CurrencyType>String</CurrencyType>
      <Cvv>String</Cvv>
      <ExpMonth>0</ExpMonth>
      <ExpYear>0</ExpYear>
      <GroupId>String</GroupId>
      <InvoiceList>
        <SalesForceMemberPaymentInvoiceDetail>
          <AmountPaid>String</AmountPaid>
          <ClassName>String</ClassName>
          <ClientId>0</ClientId>
          <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
          <Invoice>0</Invoice>
          <UniqueId>String</UniqueId>
        </SalesForceMemberPaymentInvoiceDetail>
      </InvoiceList>
      <Location>String</Location>
      <Memo>String</Memo>
      <NameOnCard>String</NameOnCard>
      <OpportunityId>String</OpportunityId>
      <PostalCode>String</PostalCode>
      <PreferredEmailAddress>String</PreferredEmailAddress>
      <StoreCardInfo>false</StoreCardInfo>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </SalesForceCreditCardPayment>
  </SalesForceCreditCardPaymentList>
</SalesForceCreditCardPaymentCollection>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SalesForceCreditCardPaymentReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <ClassName>String</ClassName>
  <ClientId>0</ClientId>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <TransactionId>String</TransactionId>
  <UniqueId>String</UniqueId>
</SalesForceCreditCardPaymentReply>