Billhighway Cloud API

<back to all web services

SalesForceCreditCardPaymentCollection

The following routes are available for this service:
POST/api/SalesForce/CreditCardPayment
SalesForceCreditCardPaymentCollection Parameters:
NameParameterData TypeRequiredDescription
SalesForceCreditCardPaymentListbodyList<SalesForceCreditCardPayment>No
SalesForceCreditCardPayment Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
UserIdformstringNo
BhUserIdformintNo
AmountformstringNo
AutoPayformboolNo
CurrencyTypeformstringNo
CountryformstringNo
CardReferenceOrCardNumberformstringNo
StoreCardInfoformboolNo
Address1formstringNo
Address2formstringNo
BillingCityformstringNo
BillingStateformstringNo
PreferredEmailAddressformstringNo
MemoformstringNo
OpportunityIdformstringNo
ExpMonthformintNo
ExpYearformintNo
CvvformstringNo
PostalCodeformstringNo
LocationformstringNo
NameOnCardformstringNo
CardTypeformstringNo
InvoiceListformList<SalesForceMemberPaymentInvoiceDetail>No
SalesForceMemberPaymentInvoiceDetail Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
InvoiceformintNo
AmountPaidformstringNo
SalesForceCreditCardPaymentReply Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
TransactionIdformstringNo
ErrorCodeformintNo
ErrorMessageformstringNo

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>