| POST | /integrations/api/{integrationType}/heldpayment/charge |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class HeldPaymentChargeRq implements IChargeRequest
{
public String integrationType = null;
public Integer NationalId = null;
public Integer ChapterId = null;
public Long StoredAccountId = null;
public Integer ContextIntegrationPartnerId = null;
public Integer CallerIntegrationPartnerId = null;
public Integer AuthenticationId = null;
public String ChargeType = null;
public String Token = null;
public BigDecimal Amount = null;
public String Description = null;
public Integer CreatedById = null;
public Long TransactionId = null;
public Boolean StoreChargeAccount = null;
public ArrayList<HeldPaymentChargeItem> ChargeItems = null;
public Integer CreatedBy = null;
public String getIntegrationType() { return integrationType; }
public HeldPaymentChargeRq setIntegrationType(String value) { this.integrationType = value; return this; }
public Integer getNationalId() { return NationalId; }
public HeldPaymentChargeRq setNationalId(Integer value) { this.NationalId = value; return this; }
public Integer getChapterId() { return ChapterId; }
public HeldPaymentChargeRq setChapterId(Integer value) { this.ChapterId = value; return this; }
public Long getStoredAccountId() { return StoredAccountId; }
public HeldPaymentChargeRq setStoredAccountId(Long value) { this.StoredAccountId = value; return this; }
public Integer getContextIntegrationPartnerId() { return ContextIntegrationPartnerId; }
public HeldPaymentChargeRq setContextIntegrationPartnerId(Integer value) { this.ContextIntegrationPartnerId = value; return this; }
public Integer getCallerIntegrationPartnerId() { return CallerIntegrationPartnerId; }
public HeldPaymentChargeRq setCallerIntegrationPartnerId(Integer value) { this.CallerIntegrationPartnerId = value; return this; }
public Integer getAuthenticationId() { return AuthenticationId; }
public HeldPaymentChargeRq setAuthenticationId(Integer value) { this.AuthenticationId = value; return this; }
public String getChargeType() { return ChargeType; }
public HeldPaymentChargeRq setChargeType(String value) { this.ChargeType = value; return this; }
public String getToken() { return Token; }
public HeldPaymentChargeRq setToken(String value) { this.Token = value; return this; }
public BigDecimal getAmount() { return Amount; }
public HeldPaymentChargeRq setAmount(BigDecimal value) { this.Amount = value; return this; }
public String getDescription() { return Description; }
public HeldPaymentChargeRq setDescription(String value) { this.Description = value; return this; }
public Integer getCreatedById() { return CreatedById; }
public HeldPaymentChargeRq setCreatedById(Integer value) { this.CreatedById = value; return this; }
public Long getTransactionId() { return TransactionId; }
public HeldPaymentChargeRq setTransactionId(Long value) { this.TransactionId = value; return this; }
public Boolean isStoreChargeAccount() { return StoreChargeAccount; }
public HeldPaymentChargeRq setStoreChargeAccount(Boolean value) { this.StoreChargeAccount = value; return this; }
public ArrayList<HeldPaymentChargeItem> getChargeItems() { return ChargeItems; }
public HeldPaymentChargeRq setChargeItems(ArrayList<HeldPaymentChargeItem> value) { this.ChargeItems = value; return this; }
public Integer getCreatedBy() { return CreatedBy; }
public HeldPaymentChargeRq setCreatedBy(Integer value) { this.CreatedBy = value; return this; }
}
public static class HeldPaymentChargeItem
{
public String Type = null;
public String Description = null;
public BigDecimal Amount = null;
public String ClientInvoiceId = null;
public Integer ClientInvoiceOwnerTypeId = null;
public String getType() { return Type; }
public HeldPaymentChargeItem setType(String value) { this.Type = value; return this; }
public String getDescription() { return Description; }
public HeldPaymentChargeItem setDescription(String value) { this.Description = value; return this; }
public BigDecimal getAmount() { return Amount; }
public HeldPaymentChargeItem setAmount(BigDecimal value) { this.Amount = value; return this; }
public String getClientInvoiceId() { return ClientInvoiceId; }
public HeldPaymentChargeItem setClientInvoiceId(String value) { this.ClientInvoiceId = value; return this; }
public Integer getClientInvoiceOwnerTypeId() { return ClientInvoiceOwnerTypeId; }
public HeldPaymentChargeItem setClientInvoiceOwnerTypeId(Integer value) { this.ClientInvoiceOwnerTypeId = value; return this; }
}
public static class HeldPaymentChargeRs
{
public String TransactionId = null;
public Long StoredAccountId = null;
public Integer NationalId = null;
public Integer ChapterId = null;
public String ChargeType = null;
public String IntegrationType = null;
public Integer ContextIntegrationPartnerId = null;
public Integer CallerIntegrationPartnerId = null;
public HeldPaymentGatewaySaleResponse GatewayResponse = null;
public HeldPaymentChargeDetails ChargeDetails = null;
public ArrayList<HeldPaymentChargeItem> ChargeItems = null;
public String getTransactionId() { return TransactionId; }
public HeldPaymentChargeRs setTransactionId(String value) { this.TransactionId = value; return this; }
public Long getStoredAccountId() { return StoredAccountId; }
public HeldPaymentChargeRs setStoredAccountId(Long value) { this.StoredAccountId = value; return this; }
public Integer getNationalId() { return NationalId; }
public HeldPaymentChargeRs setNationalId(Integer value) { this.NationalId = value; return this; }
public Integer getChapterId() { return ChapterId; }
public HeldPaymentChargeRs setChapterId(Integer value) { this.ChapterId = value; return this; }
public String getChargeType() { return ChargeType; }
public HeldPaymentChargeRs setChargeType(String value) { this.ChargeType = value; return this; }
public String getIntegrationType() { return IntegrationType; }
public HeldPaymentChargeRs setIntegrationType(String value) { this.IntegrationType = value; return this; }
public Integer getContextIntegrationPartnerId() { return ContextIntegrationPartnerId; }
public HeldPaymentChargeRs setContextIntegrationPartnerId(Integer value) { this.ContextIntegrationPartnerId = value; return this; }
public Integer getCallerIntegrationPartnerId() { return CallerIntegrationPartnerId; }
public HeldPaymentChargeRs setCallerIntegrationPartnerId(Integer value) { this.CallerIntegrationPartnerId = value; return this; }
public HeldPaymentGatewaySaleResponse getGatewayResponse() { return GatewayResponse; }
public HeldPaymentChargeRs setGatewayResponse(HeldPaymentGatewaySaleResponse value) { this.GatewayResponse = value; return this; }
public HeldPaymentChargeDetails getChargeDetails() { return ChargeDetails; }
public HeldPaymentChargeRs setChargeDetails(HeldPaymentChargeDetails value) { this.ChargeDetails = value; return this; }
public ArrayList<HeldPaymentChargeItem> getChargeItems() { return ChargeItems; }
public HeldPaymentChargeRs setChargeItems(ArrayList<HeldPaymentChargeItem> value) { this.ChargeItems = value; return this; }
}
public static class HeldPaymentGatewaySaleResponse
{
public String FailureType = null;
public Boolean IsDuplicate = null;
public Boolean IsSuccessful = null;
public String ErrorCode = null;
public String Message = null;
public Integer GatewayId = null;
public String ConfirmationNumber = null;
public String NetworkTransactionId = null;
public String getFailureType() { return FailureType; }
public HeldPaymentGatewaySaleResponse setFailureType(String value) { this.FailureType = value; return this; }
public Boolean getIsDuplicate() { return IsDuplicate; }
public HeldPaymentGatewaySaleResponse setIsDuplicate(Boolean value) { this.IsDuplicate = value; return this; }
public Boolean getIsSuccessful() { return IsSuccessful; }
public HeldPaymentGatewaySaleResponse setIsSuccessful(Boolean value) { this.IsSuccessful = value; return this; }
public String getErrorCode() { return ErrorCode; }
public HeldPaymentGatewaySaleResponse setErrorCode(String value) { this.ErrorCode = value; return this; }
public String getMessage() { return Message; }
public HeldPaymentGatewaySaleResponse setMessage(String value) { this.Message = value; return this; }
public Integer getGatewayId() { return GatewayId; }
public HeldPaymentGatewaySaleResponse setGatewayId(Integer value) { this.GatewayId = value; return this; }
public String getConfirmationNumber() { return ConfirmationNumber; }
public HeldPaymentGatewaySaleResponse setConfirmationNumber(String value) { this.ConfirmationNumber = value; return this; }
public String getNetworkTransactionId() { return NetworkTransactionId; }
public HeldPaymentGatewaySaleResponse setNetworkTransactionId(String value) { this.NetworkTransactionId = value; return this; }
}
public static class HeldPaymentChargeDetails
{
public String PaymentType = null;
public BigDecimal Amount = null;
public String IntegrationType = null;
public String Currency = null;
public HeldPaymentCreditCardChargeDetails CardDetails = null;
public HeldPaymentAchChargeDetails AchDetails = null;
public String getPaymentType() { return PaymentType; }
public HeldPaymentChargeDetails setPaymentType(String value) { this.PaymentType = value; return this; }
public BigDecimal getAmount() { return Amount; }
public HeldPaymentChargeDetails setAmount(BigDecimal value) { this.Amount = value; return this; }
public String getIntegrationType() { return IntegrationType; }
public HeldPaymentChargeDetails setIntegrationType(String value) { this.IntegrationType = value; return this; }
public String getCurrency() { return Currency; }
public HeldPaymentChargeDetails setCurrency(String value) { this.Currency = value; return this; }
public HeldPaymentCreditCardChargeDetails getCardDetails() { return CardDetails; }
public HeldPaymentChargeDetails setCardDetails(HeldPaymentCreditCardChargeDetails value) { this.CardDetails = value; return this; }
public HeldPaymentAchChargeDetails getAchDetails() { return AchDetails; }
public HeldPaymentChargeDetails setAchDetails(HeldPaymentAchChargeDetails value) { this.AchDetails = value; return this; }
}
public static class HeldPaymentCreditCardChargeDetails
{
public String CardType = null;
public Integer ExpMonth = null;
public Integer ExpYear = null;
public String Last4 = null;
public CreditCardBillingAddressItem Address = null;
public CreditCardChargeVerificationResult VerificationResult = null;
public String getCardType() { return CardType; }
public HeldPaymentCreditCardChargeDetails setCardType(String value) { this.CardType = value; return this; }
public Integer getExpMonth() { return ExpMonth; }
public HeldPaymentCreditCardChargeDetails setExpMonth(Integer value) { this.ExpMonth = value; return this; }
public Integer getExpYear() { return ExpYear; }
public HeldPaymentCreditCardChargeDetails setExpYear(Integer value) { this.ExpYear = value; return this; }
public String getLast4() { return Last4; }
public HeldPaymentCreditCardChargeDetails setLast4(String value) { this.Last4 = value; return this; }
public CreditCardBillingAddressItem getAddress() { return Address; }
public HeldPaymentCreditCardChargeDetails setAddress(CreditCardBillingAddressItem value) { this.Address = value; return this; }
public CreditCardChargeVerificationResult getVerificationResult() { return VerificationResult; }
public HeldPaymentCreditCardChargeDetails setVerificationResult(CreditCardChargeVerificationResult value) { this.VerificationResult = value; return this; }
}
public static class CreditCardBillingAddressItem
{
public String Address1 = null;
public String Address2 = null;
public String City = null;
public String PostalCode = null;
public String Region = null;
public String Country = null;
public ArrayList<AttributeItem> Attributes = null;
public String getAddress1() { return Address1; }
public CreditCardBillingAddressItem setAddress1(String value) { this.Address1 = value; return this; }
public String getAddress2() { return Address2; }
public CreditCardBillingAddressItem setAddress2(String value) { this.Address2 = value; return this; }
public String getCity() { return City; }
public CreditCardBillingAddressItem setCity(String value) { this.City = value; return this; }
public String getPostalCode() { return PostalCode; }
public CreditCardBillingAddressItem setPostalCode(String value) { this.PostalCode = value; return this; }
public String getRegion() { return Region; }
public CreditCardBillingAddressItem setRegion(String value) { this.Region = value; return this; }
public String getCountry() { return Country; }
public CreditCardBillingAddressItem setCountry(String value) { this.Country = value; return this; }
public ArrayList<AttributeItem> getAttributes() { return Attributes; }
public CreditCardBillingAddressItem setAttributes(ArrayList<AttributeItem> value) { this.Attributes = value; return this; }
}
public static class AttributeItem
{
public String Name = null;
public String Value = null;
public String getName() { return Name; }
public AttributeItem setName(String value) { this.Name = value; return this; }
public String getValue() { return Value; }
public AttributeItem setValue(String value) { this.Value = value; return this; }
}
public static class CreditCardChargeVerificationResult
{
public Boolean NetworkVerificationAttempted = null;
public String CvvVerificationResult = null;
public String AddressVerificationResult = null;
public String PostalCodeVerificationResult = null;
public Boolean isNetworkVerificationAttempted() { return NetworkVerificationAttempted; }
public CreditCardChargeVerificationResult setNetworkVerificationAttempted(Boolean value) { this.NetworkVerificationAttempted = value; return this; }
public String getCvvVerificationResult() { return CvvVerificationResult; }
public CreditCardChargeVerificationResult setCvvVerificationResult(String value) { this.CvvVerificationResult = value; return this; }
public String getAddressVerificationResult() { return AddressVerificationResult; }
public CreditCardChargeVerificationResult setAddressVerificationResult(String value) { this.AddressVerificationResult = value; return this; }
public String getPostalCodeVerificationResult() { return PostalCodeVerificationResult; }
public CreditCardChargeVerificationResult setPostalCodeVerificationResult(String value) { this.PostalCodeVerificationResult = value; return this; }
}
public static class HeldPaymentAchChargeDetails
{
public String AccountType = null;
public String RoutingNumber = null;
public String AccountNumberLast4 = null;
public String BankName = null;
public AchChargeVerificationResult VerificationResult = null;
public String getAccountType() { return AccountType; }
public HeldPaymentAchChargeDetails setAccountType(String value) { this.AccountType = value; return this; }
public String getRoutingNumber() { return RoutingNumber; }
public HeldPaymentAchChargeDetails setRoutingNumber(String value) { this.RoutingNumber = value; return this; }
public String getAccountNumberLast4() { return AccountNumberLast4; }
public HeldPaymentAchChargeDetails setAccountNumberLast4(String value) { this.AccountNumberLast4 = value; return this; }
public String getBankName() { return BankName; }
public HeldPaymentAchChargeDetails setBankName(String value) { this.BankName = value; return this; }
public AchChargeVerificationResult getVerificationResult() { return VerificationResult; }
public HeldPaymentAchChargeDetails setVerificationResult(AchChargeVerificationResult value) { this.VerificationResult = value; return this; }
}
public static class AchChargeVerificationResult
{
public Boolean NetworkVerificationAttempted = null;
public String Result = null;
public Boolean isNetworkVerificationAttempted() { return NetworkVerificationAttempted; }
public AchChargeVerificationResult setNetworkVerificationAttempted(Boolean value) { this.NetworkVerificationAttempted = value; return this; }
public String getResult() { return Result; }
public AchChargeVerificationResult setResult(String value) { this.Result = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>