Billhighway Cloud API

HeldPaymentChargeRefundRq

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

import Foundation
import ServiceStack

public class HeldPaymentChargeRefundRq : Codable
{
    public var integrationType:String?
    public var nationalId:Int?
    public var chapterId:Int?
    public var userId:Int?
    public var contextIntegrationPartnerId:Int?
    public var callerIntegrationPartnerId:Int?
    public var authenticationId:Int?
    public var amount:Double?
    public var Description:String?
    public var gatewayConfirmation:String?
    public var cardInfo:HeldPaymentCreditCardChargeRefundDetails?

    required public init(){}
}

public class HeldPaymentCreditCardChargeRefundDetails : Codable
{
    public var cardRef:String?
    public var expMonth:Int?
    public var expYear:Int?
    public var cvv:String?
    public var cardType:String?
    public var nameOnCard:String?
    public var address1:String?
    public var address2:String?
    public var city:String?
    public var state:String?
    public var postalCode:String?
    public var country:String?

    required public init(){}
}

public class HeldPaymentChargeRefundRs : Codable
{
    public var nationalId:Int?
    public var chapterId:Int?
    public var integrationType:String?
    public var contextIntegrationPartnerId:Int?
    public var callerIntegrationPartnerId:Int?
    public var gatewayResponse:HeldPaymentGatewaySaleResponse?
    public var chargeDetails:HeldPaymentChargeDetails?

    required public init(){}
}

public class HeldPaymentGatewaySaleResponse : Codable
{
    public var failureType:String?
    public var isDuplicate:Bool?
    public var isSuccessful:Bool?
    public var errorCode:String?
    public var message:String?
    public var gatewayId:Int?
    public var confirmationNumber:String?
    public var networkTransactionId:String?

    required public init(){}
}

public class HeldPaymentChargeDetails : Codable
{
    public var paymentType:String?
    public var amount:Double?
    public var integrationType:String?
    public var currency:String?
    public var cardDetails:HeldPaymentCreditCardChargeDetails?
    public var achDetails:HeldPaymentAchChargeDetails?

    required public init(){}
}

public class HeldPaymentCreditCardChargeDetails : Codable
{
    public var cardType:String?
    public var expMonth:Int?
    public var expYear:Int?
    public var last4:String?
    public var address:CreditCardBillingAddressItem?
    public var verificationResult:CreditCardChargeVerificationResult?

    required public init(){}
}

public class CreditCardBillingAddressItem : Codable
{
    public var address1:String?
    public var address2:String?
    public var city:String?
    public var postalCode:String?
    public var region:String?
    public var country:String?
    public var attributes:[AttributeItem] = []

    required public init(){}
}

public class AttributeItem : Codable
{
    public var name:String?
    public var value:String?

    required public init(){}
}

public class CreditCardChargeVerificationResult : Codable
{
    public var networkVerificationAttempted:Bool?
    public var cvvVerificationResult:String?
    public var addressVerificationResult:String?
    public var postalCodeVerificationResult:String?

    required public init(){}
}

public class HeldPaymentAchChargeDetails : Codable
{
    public var accountType:String?
    public var routingNumber:String?
    public var accountNumberLast4:String?
    public var bankName:String?
    public var verificationResult:AchChargeVerificationResult?

    required public init(){}
}

public class AchChargeVerificationResult : Codable
{
    public var networkVerificationAttempted:Bool?
    public var result:String?

    required public init(){}
}

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

<HeldPaymentChargeRefundRq 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>
  <CardInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.HeldPayments.Api">
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:CVV>String</d2p1:CVV>
    <d2p1:CardRef>String</d2p1:CardRef>
    <d2p1:CardType>String</d2p1:CardType>
    <d2p1:City>String</d2p1:City>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:ExpMonth>0</d2p1:ExpMonth>
    <d2p1:ExpYear>0</d2p1:ExpYear>
    <d2p1:NameOnCard>String</d2p1:NameOnCard>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:State>String</d2p1:State>
  </CardInfo>
  <ChapterId>0</ChapterId>
  <ContextIntegrationPartnerId>0</ContextIntegrationPartnerId>
  <Description>String</Description>
  <GatewayConfirmation>String</GatewayConfirmation>
  <NationalId>0</NationalId>
  <UserId>0</UserId>
  <integrationType>String</integrationType>
</HeldPaymentChargeRefundRq>

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

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