Billhighway Cloud API

HeldPaymentChargeRq

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

**HeldPaymentChargeRq** Parameters:
Name	Parameter	Data Type	Required
integrationType	path	string	No
NationalId	body	int	No
ChapterId	body	int	No
StoredAccountId	body	long	No
ContextIntegrationPartnerId	body	int	No
CallerIntegrationPartnerId	body	int	No
AuthenticationId	body	int	No
ChargeType	body	string	No
Token	body	string	No
Amount	body	decimal	No
Description	body	string	No
CreatedById	body	int	No
TransactionId	body	long	No
StoreChargeAccount	body	bool	No
ChargeItems	body	List<HeldPaymentChargeItem>	No
CreatedBy	body	int	No

**HeldPaymentChargeItem** Parameters:
Name	Parameter	Data Type	Required
Type	form	string	No
Description	form	string	No
Amount	form	decimal	No
ClientInvoiceId	form	string	No
ClientInvoiceOwnerTypeId	form	int	No

**HeldPaymentChargeRs** Parameters:
Name	Parameter	Data Type	Required
TransactionId	form	string	No
StoredAccountId	form	long	No
NationalId	form	int	No
ChapterId	form	int	No
ChargeType	form	string	No
IntegrationType	form	string	No
ContextIntegrationPartnerId	form	int	No
CallerIntegrationPartnerId	form	int	No
GatewayResponse	form	HeldPaymentGatewaySaleResponse	No
ChargeDetails	form	HeldPaymentChargeDetails	No
ChargeItems	form	List<HeldPaymentChargeItem>	No

**HeldPaymentGatewaySaleResponse** Parameters:
Name	Parameter	Data Type	Required
FailureType	form	string	No
IsDuplicate	form	bool	No
IsSuccessful	form	bool	No
ErrorCode	form	string	No
Message	form	string	No
GatewayId	form	int	No
ConfirmationNumber	form	string	No
NetworkTransactionId	form	string	No

**HeldPaymentChargeDetails** Parameters:
Name	Parameter	Data Type	Required
PaymentType	form	string	No
Amount	form	decimal	No
IntegrationType	form	string	No
Currency	form	string	No
CardDetails	form	HeldPaymentCreditCardChargeDetails	No
AchDetails	form	HeldPaymentAchChargeDetails	No

**HeldPaymentCreditCardChargeDetails** 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

**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

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

**HeldPaymentAchChargeDetails** 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/{integrationType}/heldpayment/charge HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<HeldPaymentChargeRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.HeldPayments.Api.Request">
  <Amount>0</Amount>
  <AuthenticationId>0</AuthenticationId>
  <CallerIntegrationPartnerId>0</CallerIntegrationPartnerId>
  <ChapterId>0</ChapterId>
  <ChargeItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.HeldPayments">
    <d2p1:HeldPaymentChargeItem>
      <d2p1:_x003C_Amount_x003E_k__BackingField>0</d2p1:_x003C_Amount_x003E_k__BackingField>
      <d2p1:_x003C_ClientInvoiceId_x003E_k__BackingField>String</d2p1:_x003C_ClientInvoiceId_x003E_k__BackingField>
      <d2p1:_x003C_ClientInvoiceOwnerTypeId_x003E_k__BackingField>0</d2p1:_x003C_ClientInvoiceOwnerTypeId_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_Type_x003E_k__BackingField>String</d2p1:_x003C_Type_x003E_k__BackingField>
    </d2p1:HeldPaymentChargeItem>
  </ChargeItems>
  <ChargeType>String</ChargeType>
  <ContextIntegrationPartnerId>0</ContextIntegrationPartnerId>
  <CreatedBy>0</CreatedBy>
  <CreatedById>0</CreatedById>
  <Description>String</Description>
  <NationalId>0</NationalId>
  <StoreChargeAccount>false</StoreChargeAccount>
  <StoredAccountId>0</StoredAccountId>
  <Token>String</Token>
  <TransactionId>0</TransactionId>
  <integrationType>String</integrationType>
</HeldPaymentChargeRq>

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

<HeldPaymentChargeRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.HeldPayments.Api.Response">
  <CallerIntegrationPartnerId>0</CallerIntegrationPartnerId>
  <ChapterId>0</ChapterId>
  <ChargeDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.HeldPayments.Api">
    <d2p1:AchDetails>
      <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 xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api">
        <d4p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>false</d4p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>
        <d4p1:_x003C_Result_x003E_k__BackingField>String</d4p1:_x003C_Result_x003E_k__BackingField>
      </d2p1:_x003C_VerificationResult_x003E_k__BackingField>
    </d2p1:AchDetails>
    <d2p1:Amount>0</d2p1:Amount>
    <d2p1:CardDetails>
      <d2p1:_x003C_Address_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api">
        <d4p1:Address1>String</d4p1:Address1>
        <d4p1:Address2>String</d4p1:Address2>
        <d4p1:Attributes xmlns:d5p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO">
          <d5p1:AttributeItem>
            <d5p1:Name>String</d5p1:Name>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:AttributeItem>
        </d4p1:Attributes>
        <d4p1:City>String</d4p1:City>
        <d4p1:Country>String</d4p1:Country>
        <d4p1:PostalCode>String</d4p1:PostalCode>
        <d4p1:Region>String</d4p1: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 xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api">
        <d4p1:_x003C_AddressVerificationResult_x003E_k__BackingField>String</d4p1:_x003C_AddressVerificationResult_x003E_k__BackingField>
        <d4p1:_x003C_CvvVerificationResult_x003E_k__BackingField>String</d4p1:_x003C_CvvVerificationResult_x003E_k__BackingField>
        <d4p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>false</d4p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>
        <d4p1:_x003C_PostalCodeVerificationResult_x003E_k__BackingField>String</d4p1:_x003C_PostalCodeVerificationResult_x003E_k__BackingField>
      </d2p1:_x003C_VerificationResult_x003E_k__BackingField>
    </d2p1:CardDetails>
    <d2p1:Currency>String</d2p1:Currency>
    <d2p1:IntegrationType>String</d2p1:IntegrationType>
    <d2p1:PaymentType>String</d2p1:PaymentType>
  </ChargeDetails>
  <ChargeItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.HeldPayments">
    <d2p1:HeldPaymentChargeItem>
      <d2p1:_x003C_Amount_x003E_k__BackingField>0</d2p1:_x003C_Amount_x003E_k__BackingField>
      <d2p1:_x003C_ClientInvoiceId_x003E_k__BackingField>String</d2p1:_x003C_ClientInvoiceId_x003E_k__BackingField>
      <d2p1:_x003C_ClientInvoiceOwnerTypeId_x003E_k__BackingField>0</d2p1:_x003C_ClientInvoiceOwnerTypeId_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_Type_x003E_k__BackingField>String</d2p1:_x003C_Type_x003E_k__BackingField>
    </d2p1:HeldPaymentChargeItem>
  </ChargeItems>
  <ChargeType>String</ChargeType>
  <ContextIntegrationPartnerId>0</ContextIntegrationPartnerId>
  <GatewayResponse xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.HeldPayments">
    <d2p1:_x003C_ConfirmationNumber_x003E_k__BackingField>String</d2p1:_x003C_ConfirmationNumber_x003E_k__BackingField>
    <d2p1:_x003C_ErrorCode_x003E_k__BackingField>String</d2p1:_x003C_ErrorCode_x003E_k__BackingField>
    <d2p1:_x003C_FailureType_x003E_k__BackingField>String</d2p1:_x003C_FailureType_x003E_k__BackingField>
    <d2p1:_x003C_GatewayId_x003E_k__BackingField>0</d2p1:_x003C_GatewayId_x003E_k__BackingField>
    <d2p1:_x003C_IsDuplicate_x003E_k__BackingField>false</d2p1:_x003C_IsDuplicate_x003E_k__BackingField>
    <d2p1:_x003C_IsSuccessful_x003E_k__BackingField>false</d2p1:_x003C_IsSuccessful_x003E_k__BackingField>
    <d2p1:_x003C_Message_x003E_k__BackingField>String</d2p1:_x003C_Message_x003E_k__BackingField>
    <d2p1:_x003C_NetworkTransactionId_x003E_k__BackingField>String</d2p1:_x003C_NetworkTransactionId_x003E_k__BackingField>
  </GatewayResponse>
  <IntegrationType>String</IntegrationType>
  <NationalId>0</NationalId>
  <StoredAccountId>0</StoredAccountId>
  <TransactionId>String</TransactionId>
</HeldPaymentChargeRs>