Billhighway Cloud API

ChargeTokenRq

The following routes are available for this service:
POST	/integrations/api/{tokenType}/charge/token

**ChargeTokenRq** Parameters:
Name	Parameter	Data Type	Required
tokenType	path	string	No
Amount	body	int	No
Description	body	string	No
Options	body	ChargeTokenOptions	No
CardInfo	body	CreditCardChargeItem	No
AchInfo	body	AchChargeItem	No
ReferenceIds	body	List<ReferenceIdTypedAssociationItem>	No

**ChargeTokenOptions** Parameters:
Name	Parameter	Data Type	Required	Description
Usages	form	int	No
Duration	form	int	No

**CreditCardChargeItem** Parameters:
Name	Parameter	Data Type	Required
NameOnCard	form	string	No
ExpMonth	form	int	No
ExpYear	form	int	No
CardNumber	form	string	No
Cvv	form	string	No
Address	form	CreditCardBillingAddressItem	No

**CreditCardBillingAddressItem** Parameters:
Name	Parameter	Data Type	Required
Address1	form	string	No
Address2	form	string	No
City	form	string	No
PostalCode	form	string	No
Region	form	string	No
Country	form	string	No
Attributes	form	List<AttributeItem>	No

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

**AchChargeItem** Parameters:
Name	Parameter	Data Type	Required
AccountNumber	form	string	No
RoutingNumber	form	string	No
AccountType	form	string	No
AccountHolderName	form	string	No

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

**ChargeTokenRs** Parameters:
Name	Parameter	Data Type	Required
Token	form	string	No
OrganizationId	form	int	No
ChapterId	form	int	No
Amount	form	int	No
TokenType	form	string	No
Description	form	string	No
ExpiresOn	form	DateTime	No
Currency	form	string	No
Usages	form	int	No
CardDetails	form	CreditCardChargeDetails	No
AchDetails	form	AchChargeDetails	No

**CreditCardChargeDetails** Parameters:
Name	Parameter	Data Type	Required
CardType	form	string	No
ExpMonth	form	int	No
ExpYear	form	int	No
Last4	form	string	No
Address	form	CreditCardBillingAddressItem	No
VerificationResult	form	CreditCardChargeVerificationResult	No

**CreditCardChargeVerificationResult** Parameters:
Name	Parameter	Data Type	Required
NetworkVerificationAttempted	form	bool	No
CvvVerificationResult	form	string	No
AddressVerificationResult	form	string	No
PostalCodeVerificationResult	form	string	No

**AchChargeDetails** Parameters:
Name	Parameter	Data Type	Required
AccountType	form	string	No
RoutingNumber	form	string	No
AccountNumberLast4	form	string	No
BankName	form	string	No
VerificationResult	form	AchChargeVerificationResult	No

**AchChargeVerificationResult** Parameters:
Name	Parameter	Data Type	Required	Description
NetworkVerificationAttempted	form	bool	No
Result	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 /integrations/api/{tokenType}/charge/token HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ChargeTokenRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api.Request">
  <AchInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api">
    <d2p1:_x003C_AccountHolderName_x003E_k__BackingField>String</d2p1:_x003C_AccountHolderName_x003E_k__BackingField>
    <d2p1:_x003C_AccountNumber_x003E_k__BackingField>String</d2p1:_x003C_AccountNumber_x003E_k__BackingField>
    <d2p1:_x003C_AccountType_x003E_k__BackingField>String</d2p1:_x003C_AccountType_x003E_k__BackingField>
    <d2p1:_x003C_RoutingNumber_x003E_k__BackingField>String</d2p1:_x003C_RoutingNumber_x003E_k__BackingField>
  </AchInfo>
  <Amount>0</Amount>
  <CardInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api">
    <d2p1:_x003C_Address_x003E_k__BackingField>
      <d2p1:Address1>String</d2p1:Address1>
      <d2p1:Address2>String</d2p1:Address2>
      <d2p1:Attributes xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO">
        <d4p1:AttributeItem>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:AttributeItem>
      </d2p1:Attributes>
      <d2p1:City>String</d2p1:City>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Region>String</d2p1:Region>
    </d2p1:_x003C_Address_x003E_k__BackingField>
    <d2p1:_x003C_CardNumber_x003E_k__BackingField>String</d2p1:_x003C_CardNumber_x003E_k__BackingField>
    <d2p1:_x003C_Cvv_x003E_k__BackingField>String</d2p1:_x003C_Cvv_x003E_k__BackingField>
    <d2p1:_x003C_ExpMonth_x003E_k__BackingField>0</d2p1:_x003C_ExpMonth_x003E_k__BackingField>
    <d2p1:_x003C_ExpYear_x003E_k__BackingField>0</d2p1:_x003C_ExpYear_x003E_k__BackingField>
    <d2p1:_x003C_NameOnCard_x003E_k__BackingField>String</d2p1:_x003C_NameOnCard_x003E_k__BackingField>
  </CardInfo>
  <Description>String</Description>
  <Options xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges">
    <d2p1:Duration>0</d2p1:Duration>
    <d2p1:Usages>0</d2p1:Usages>
  </Options>
  <ReferenceIds xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO">
    <d2p1:ReferenceIdTypedAssociationItem>
      <d2p1:_x003C_Type_x003E_k__BackingField>String</d2p1:_x003C_Type_x003E_k__BackingField>
      <d2p1:_x003C_Value_x003E_k__BackingField>String</d2p1:_x003C_Value_x003E_k__BackingField>
    </d2p1:ReferenceIdTypedAssociationItem>
  </ReferenceIds>
  <tokenType>String</tokenType>
</ChargeTokenRq>

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

<ChargeTokenRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api.Response">
  <AchDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api">
    <d2p1:_x003C_AccountNumberLast4_x003E_k__BackingField>String</d2p1:_x003C_AccountNumberLast4_x003E_k__BackingField>
    <d2p1:_x003C_AccountType_x003E_k__BackingField>String</d2p1:_x003C_AccountType_x003E_k__BackingField>
    <d2p1:_x003C_BankName_x003E_k__BackingField>String</d2p1:_x003C_BankName_x003E_k__BackingField>
    <d2p1:_x003C_RoutingNumber_x003E_k__BackingField>String</d2p1:_x003C_RoutingNumber_x003E_k__BackingField>
    <d2p1:_x003C_VerificationResult_x003E_k__BackingField>
      <d2p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>false</d2p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>
      <d2p1:_x003C_Result_x003E_k__BackingField>String</d2p1:_x003C_Result_x003E_k__BackingField>
    </d2p1:_x003C_VerificationResult_x003E_k__BackingField>
  </AchDetails>
  <Amount>0</Amount>
  <CardDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api">
    <d2p1:_x003C_Address_x003E_k__BackingField>
      <d2p1:Address1>String</d2p1:Address1>
      <d2p1:Address2>String</d2p1:Address2>
      <d2p1:Attributes xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO">
        <d4p1:AttributeItem>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:AttributeItem>
      </d2p1:Attributes>
      <d2p1:City>String</d2p1:City>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Region>String</d2p1:Region>
    </d2p1:_x003C_Address_x003E_k__BackingField>
    <d2p1:_x003C_CardType_x003E_k__BackingField>String</d2p1:_x003C_CardType_x003E_k__BackingField>
    <d2p1:_x003C_ExpMonth_x003E_k__BackingField>0</d2p1:_x003C_ExpMonth_x003E_k__BackingField>
    <d2p1:_x003C_ExpYear_x003E_k__BackingField>0</d2p1:_x003C_ExpYear_x003E_k__BackingField>
    <d2p1:_x003C_Last4_x003E_k__BackingField>String</d2p1:_x003C_Last4_x003E_k__BackingField>
    <d2p1:_x003C_VerificationResult_x003E_k__BackingField>
      <d2p1:_x003C_AddressVerificationResult_x003E_k__BackingField>String</d2p1:_x003C_AddressVerificationResult_x003E_k__BackingField>
      <d2p1:_x003C_CvvVerificationResult_x003E_k__BackingField>String</d2p1:_x003C_CvvVerificationResult_x003E_k__BackingField>
      <d2p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>false</d2p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>
      <d2p1:_x003C_PostalCodeVerificationResult_x003E_k__BackingField>String</d2p1:_x003C_PostalCodeVerificationResult_x003E_k__BackingField>
    </d2p1:_x003C_VerificationResult_x003E_k__BackingField>
  </CardDetails>
  <ChapterId>0</ChapterId>
  <Currency>String</Currency>
  <Description>String</Description>
  <ExpiresOn>0001-01-01T00:00:00</ExpiresOn>
  <OrganizationId>0</OrganizationId>
  <Token>String</Token>
  <TokenType>String</TokenType>
  <Usages>0</Usages>
</ChargeTokenRs>