Billhighway Cloud API

CreditCardPaymentCollection

The following routes are available for this service:
POST	/payments/creditcard

**CreditCardPaymentCollection** Parameters:
Name	Parameter	Data Type	Required	Description
CreditCardPaymentList	body	List<CreditCardPayment>	No

**CreditCardPayment** Parameters:
Name	Parameter	Data Type	Required	Description
SubscriptionInfo	form	SubscriptionParameters	No

**SubscriptionParameters** Parameters:
Name	Parameter	Data Type	Required
FormTemplateID	form	int	No
SubscriptionInvoiceID	form	int	No
ClientSubscriberId	form	string	No
SignupTypeID	form	int	No
FrequencyID	form	int	No
AutoRenew	form	bool	No
CompanyID	form	long	No
UserID	form	int	No
ChapMemPayID	form	long	No
MemberSubscriptionInvID	form	long	No
Fields	form	List<SubscriberFormField>	No
CreatedBy	form	int	No
UpdatedBy	form	int	No
AptifyUpdateType	form	int	No
RenewedMemberSubscriptionInvID	form	long	No
ChapId	form	int	No

**SubscriberFormField** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**CreditCardPaymentReply** Parameters:
Name	Parameter	Data Type	Required
ClassName	form	string	No
UniqueId	form	string	No
CreatedDateTime	form	DateTime	No
ClientId	form	int	No
TransactionId	form	string	No
ErrorCode	form	int	No
ErrorMessage	form	string	No

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

<CreditCardPaymentCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <CreditCardPaymentList>
    <CreditCardPayment>
      <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>
    </CreditCardPayment>
  </CreditCardPaymentList>
</CreditCardPaymentCollection>

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

<CreditCardPaymentReply 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>
</CreditCardPaymentReply>