Billhighway Cloud API

<back to all web services

HeldPaymentChargeRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/heldpayment/charge
namespace BH.CloudAPI.Common4.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type HeldPaymentGatewaySaleResponse() = 
        member val FailureType:String = null with get,set
        member val IsDuplicate:Boolean = new Boolean() with get,set
        member val IsSuccessful:Boolean = new Boolean() with get,set
        member val ErrorCode:String = null with get,set
        member val Message:String = null with get,set
        member val GatewayId:Int32 = new Int32() with get,set
        member val ConfirmationNumber:String = null with get,set
        member val NetworkTransactionId:String = null with get,set

    [<AllowNullLiteral>]
    type AttributeItem() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type CreditCardBillingAddressItem() = 
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val City:String = null with get,set
        member val PostalCode:String = null with get,set
        member val Region:String = null with get,set
        member val Country:String = null with get,set
        member val Attributes:ResizeArray<AttributeItem> = new ResizeArray<AttributeItem>() with get,set

    [<AllowNullLiteral>]
    type CreditCardChargeVerificationResult() = 
        member val NetworkVerificationAttempted:Boolean = new Boolean() with get,set
        member val CvvVerificationResult:String = null with get,set
        member val AddressVerificationResult:String = null with get,set
        member val PostalCodeVerificationResult:String = null with get,set

    [<AllowNullLiteral>]
    type HeldPaymentCreditCardChargeDetails() = 
        member val CardType:String = null with get,set
        member val ExpMonth:Int32 = new Int32() with get,set
        member val ExpYear:Int32 = new Int32() with get,set
        member val Last4:String = null with get,set
        member val Address:CreditCardBillingAddressItem = null with get,set
        member val VerificationResult:CreditCardChargeVerificationResult = null with get,set

    [<AllowNullLiteral>]
    type AchChargeVerificationResult() = 
        member val NetworkVerificationAttempted:Boolean = new Boolean() with get,set
        member val Result:String = null with get,set

    [<AllowNullLiteral>]
    type HeldPaymentAchChargeDetails() = 
        member val AccountType:String = null with get,set
        member val RoutingNumber:String = null with get,set
        member val AccountNumberLast4:String = null with get,set
        member val BankName:String = null with get,set
        member val VerificationResult:AchChargeVerificationResult = null with get,set

    [<AllowNullLiteral>]
    type HeldPaymentChargeDetails() = 
        member val PaymentType:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val IntegrationType:String = null with get,set
        member val Currency:String = null with get,set
        member val CardDetails:HeldPaymentCreditCardChargeDetails = null with get,set
        member val AchDetails:HeldPaymentAchChargeDetails = null with get,set

    [<AllowNullLiteral>]
    type HeldPaymentChargeItem() = 
        member val Type:String = null with get,set
        member val Description:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val ClientInvoiceId:String = null with get,set
        member val ClientInvoiceOwnerTypeId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type HeldPaymentChargeRs() = 
        member val TransactionId:String = null with get,set
        member val StoredAccountId:Int64 = new Int64() with get,set
        member val NationalId:Int32 = new Int32() with get,set
        member val ChapterId:Int32 = new Int32() with get,set
        member val ChargeType:String = null with get,set
        member val IntegrationType:String = null with get,set
        member val ContextIntegrationPartnerId:Int32 = new Int32() with get,set
        member val CallerIntegrationPartnerId:Int32 = new Int32() with get,set
        member val GatewayResponse:HeldPaymentGatewaySaleResponse = null with get,set
        member val ChargeDetails:HeldPaymentChargeDetails = null with get,set
        member val ChargeItems:ResizeArray<HeldPaymentChargeItem> = new ResizeArray<HeldPaymentChargeItem>() with get,set

    [<AllowNullLiteral>]
    type HeldPaymentChargeRq() = 
        member val integrationType:String = null with get,set
        member val NationalId:Int32 = new Int32() with get,set
        member val ChapterId:Int32 = new Int32() with get,set
        member val StoredAccountId:Int64 = new Int64() with get,set
        member val ContextIntegrationPartnerId:Int32 = new Int32() with get,set
        member val CallerIntegrationPartnerId:Int32 = new Int32() with get,set
        member val AuthenticationId:Int32 = new Int32() with get,set
        member val ChargeType:String = null with get,set
        member val Token:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Description:String = null with get,set
        member val CreatedById:Int32 = new Int32() with get,set
        member val TransactionId:Int64 = new Int64() with get,set
        member val StoreChargeAccount:Boolean = new Boolean() with get,set
        member val ChargeItems:ResizeArray<HeldPaymentChargeItem> = new ResizeArray<HeldPaymentChargeItem>() with get,set
        member val CreatedBy:Int32 = new Int32() with get,set

F# HeldPaymentChargeRq 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 /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>