| POST | /integrations/api/{integrationType}/core/verifycharge |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class CoreChargeVerifyRq
{
public BigDecimal reCaptchaScore = null;
public String integrationType = null;
public Integer NationalId = null;
public Integer ChapterId = null;
public Integer ContextIntegrationPartnerId = null;
public Integer AuthenticationId = null;
public String Token = null;
public BigDecimal getReCaptchaScore() { return reCaptchaScore; }
public CoreChargeVerifyRq setReCaptchaScore(BigDecimal value) { this.reCaptchaScore = value; return this; }
public String getIntegrationType() { return integrationType; }
public CoreChargeVerifyRq setIntegrationType(String value) { this.integrationType = value; return this; }
public Integer getNationalId() { return NationalId; }
public CoreChargeVerifyRq setNationalId(Integer value) { this.NationalId = value; return this; }
public Integer getChapterId() { return ChapterId; }
public CoreChargeVerifyRq setChapterId(Integer value) { this.ChapterId = value; return this; }
public Integer getContextIntegrationPartnerId() { return ContextIntegrationPartnerId; }
public CoreChargeVerifyRq setContextIntegrationPartnerId(Integer value) { this.ContextIntegrationPartnerId = value; return this; }
public Integer getAuthenticationId() { return AuthenticationId; }
public CoreChargeVerifyRq setAuthenticationId(Integer value) { this.AuthenticationId = value; return this; }
public String getToken() { return Token; }
public CoreChargeVerifyRq setToken(String value) { this.Token = value; return this; }
}
public static class CoreChargeVerifyRs
{
public String Token = null;
public CreditCardVerificationDetails CardVerificationDetails = null;
public AchVerificationDetails AchVerificationDetails = null;
public String getToken() { return Token; }
public CoreChargeVerifyRs setToken(String value) { this.Token = value; return this; }
public CreditCardVerificationDetails getCardVerificationDetails() { return CardVerificationDetails; }
public CoreChargeVerifyRs setCardVerificationDetails(CreditCardVerificationDetails value) { this.CardVerificationDetails = value; return this; }
public AchVerificationDetails getAchVerificationDetails() { return AchVerificationDetails; }
public CoreChargeVerifyRs setAchVerificationDetails(AchVerificationDetails value) { this.AchVerificationDetails = value; return this; }
}
public static class CreditCardVerificationDetails
{
public Boolean IsError = null;
public Boolean IsDuplicate = null;
public String GatewayResponseCode = null;
public String GatewayMessage = null;
public Boolean NetworkVerificationAttempted = null;
public String CvvVerificationResult = null;
public String AddressVerificationResult = null;
public String PostalCodeVerificationResult = null;
public String NetworkTransactionId = null;
public Boolean getIsError() { return IsError; }
public CreditCardVerificationDetails setIsError(Boolean value) { this.IsError = value; return this; }
public Boolean getIsDuplicate() { return IsDuplicate; }
public CreditCardVerificationDetails setIsDuplicate(Boolean value) { this.IsDuplicate = value; return this; }
public String getGatewayResponseCode() { return GatewayResponseCode; }
public CreditCardVerificationDetails setGatewayResponseCode(String value) { this.GatewayResponseCode = value; return this; }
public String getGatewayMessage() { return GatewayMessage; }
public CreditCardVerificationDetails setGatewayMessage(String value) { this.GatewayMessage = value; return this; }
public Boolean isNetworkVerificationAttempted() { return NetworkVerificationAttempted; }
public CreditCardVerificationDetails setNetworkVerificationAttempted(Boolean value) { this.NetworkVerificationAttempted = value; return this; }
public String getCvvVerificationResult() { return CvvVerificationResult; }
public CreditCardVerificationDetails setCvvVerificationResult(String value) { this.CvvVerificationResult = value; return this; }
public String getAddressVerificationResult() { return AddressVerificationResult; }
public CreditCardVerificationDetails setAddressVerificationResult(String value) { this.AddressVerificationResult = value; return this; }
public String getPostalCodeVerificationResult() { return PostalCodeVerificationResult; }
public CreditCardVerificationDetails setPostalCodeVerificationResult(String value) { this.PostalCodeVerificationResult = value; return this; }
public String getNetworkTransactionId() { return NetworkTransactionId; }
public CreditCardVerificationDetails setNetworkTransactionId(String value) { this.NetworkTransactionId = value; return this; }
}
public static class AchVerificationDetails
{
public Boolean IsError = null;
public Boolean NetworkVerificationAttempted = null;
public String Result = null;
public String Code = null;
public String Message = null;
public Boolean getIsError() { return IsError; }
public AchVerificationDetails setIsError(Boolean value) { this.IsError = value; return this; }
public Boolean isNetworkVerificationAttempted() { return NetworkVerificationAttempted; }
public AchVerificationDetails setNetworkVerificationAttempted(Boolean value) { this.NetworkVerificationAttempted = value; return this; }
public String getResult() { return Result; }
public AchVerificationDetails setResult(String value) { this.Result = value; return this; }
public String getCode() { return Code; }
public AchVerificationDetails setCode(String value) { this.Code = value; return this; }
public String getMessage() { return Message; }
public AchVerificationDetails setMessage(String value) { this.Message = 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}/core/verifycharge HTTP/1.1
Host: devapi.billhighway.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CoreChargeVerifyRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.CoreCharges.Api.Request">
<AuthenticationId>0</AuthenticationId>
<ChapterId>0</ChapterId>
<ContextIntegrationPartnerId>0</ContextIntegrationPartnerId>
<NationalId>0</NationalId>
<Token>String</Token>
<integrationType>String</integrationType>
<reCaptchaScore>0</reCaptchaScore>
</CoreChargeVerifyRq>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CoreChargeVerifyRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.CoreCharges.Api.Response">
<_x003C_AchVerificationDetails_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO">
<d2p1:_x003C_Code_x003E_k__BackingField>String</d2p1:_x003C_Code_x003E_k__BackingField>
<d2p1:_x003C_IsError_x003E_k__BackingField>false</d2p1:_x003C_IsError_x003E_k__BackingField>
<d2p1:_x003C_Message_x003E_k__BackingField>String</d2p1:_x003C_Message_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>
</_x003C_AchVerificationDetails_x003E_k__BackingField>
<_x003C_CardVerificationDetails_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO">
<d2p1:_x003C_AddressVerificationResult_x003E_k__BackingField>String</d2p1:_x003C_AddressVerificationResult_x003E_k__BackingField>
<d2p1:_x003C_ChargeToken_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges">
<d3p1:AchDetails>
<d3p1:_x003C_AccountHolderName_x003E_k__BackingField>String</d3p1:_x003C_AccountHolderName_x003E_k__BackingField>
<d3p1:_x003C_AchRef_x003E_k__BackingField>String</d3p1:_x003C_AchRef_x003E_k__BackingField>
<d3p1:_x003C_BankAccountType_x003E_k__BackingField>None</d3p1:_x003C_BankAccountType_x003E_k__BackingField>
<d3p1:_x003C_BankName_x003E_k__BackingField>String</d3p1:_x003C_BankName_x003E_k__BackingField>
<d3p1:_x003C_RoutingNumber_x003E_k__BackingField>String</d3p1:_x003C_RoutingNumber_x003E_k__BackingField>
<d3p1:_x003C_VerificationResult_x003E_k__BackingField>
<d3p1:_x003C_Code_x003E_k__BackingField>String</d3p1:_x003C_Code_x003E_k__BackingField>
<d3p1:_x003C_Message_x003E_k__BackingField>String</d3p1:_x003C_Message_x003E_k__BackingField>
<d3p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>false</d3p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>
<d3p1:_x003C_Result_x003E_k__BackingField>NotAttempted</d3p1:_x003C_Result_x003E_k__BackingField>
<d3p1:_x003C_TransactionId_x003E_k__BackingField>String</d3p1:_x003C_TransactionId_x003E_k__BackingField>
</d3p1:_x003C_VerificationResult_x003E_k__BackingField>
</d3p1:AchDetails>
<d3p1:Amount>0</d3p1:Amount>
<d3p1:CardDetails>
<d3p1:_x003C_BillingAddress_x003E_k__BackingField>
<d3p1:Address1>String</d3p1:Address1>
<d3p1:Address2>String</d3p1:Address2>
<d3p1:Attributes>
<d2p1:AttributeItem>
<d2p1:Name>String</d2p1:Name>
<d2p1:Value>String</d2p1:Value>
</d2p1:AttributeItem>
</d3p1:Attributes>
<d3p1:City>String</d3p1:City>
<d3p1:Country>String</d3p1:Country>
<d3p1:PostalCode>String</d3p1:PostalCode>
<d3p1:Region>String</d3p1:Region>
</d3p1:_x003C_BillingAddress_x003E_k__BackingField>
<d3p1:_x003C_CardRef_x003E_k__BackingField>String</d3p1:_x003C_CardRef_x003E_k__BackingField>
<d3p1:_x003C_CardType_x003E_k__BackingField>AmericanExpress</d3p1:_x003C_CardType_x003E_k__BackingField>
<d3p1:_x003C_CvvEncryptionTypeId_x003E_k__BackingField>0</d3p1:_x003C_CvvEncryptionTypeId_x003E_k__BackingField>
<d3p1:_x003C_Cvv_x003E_k__BackingField>String</d3p1:_x003C_Cvv_x003E_k__BackingField>
<d3p1:_x003C_ExpMonth_x003E_k__BackingField>0</d3p1:_x003C_ExpMonth_x003E_k__BackingField>
<d3p1:_x003C_ExpYear_x003E_k__BackingField>0</d3p1:_x003C_ExpYear_x003E_k__BackingField>
<d3p1:_x003C_GatewayId_x003E_k__BackingField>0</d3p1:_x003C_GatewayId_x003E_k__BackingField>
<d3p1:_x003C_NameOnCard_x003E_k__BackingField>String</d3p1:_x003C_NameOnCard_x003E_k__BackingField>
<d3p1:_x003C_VerificationResult_x003E_k__BackingField>
<d3p1:_x003C_AddressVerificationResult_x003E_k__BackingField>NotAttempted</d3p1:_x003C_AddressVerificationResult_x003E_k__BackingField>
<d3p1:_x003C_CvvVerificationResult_x003E_k__BackingField>NotAttempted</d3p1:_x003C_CvvVerificationResult_x003E_k__BackingField>
<d3p1:_x003C_GatewayAvsResultCode_x003E_k__BackingField>String</d3p1:_x003C_GatewayAvsResultCode_x003E_k__BackingField>
<d3p1:_x003C_GatewayConfirmationNumber_x003E_k__BackingField>String</d3p1:_x003C_GatewayConfirmationNumber_x003E_k__BackingField>
<d3p1:_x003C_GatewayId_x003E_k__BackingField>0</d3p1:_x003C_GatewayId_x003E_k__BackingField>
<d3p1:_x003C_GatewayMessage_x003E_k__BackingField>String</d3p1:_x003C_GatewayMessage_x003E_k__BackingField>
<d3p1:_x003C_GatewayResponseCode_x003E_k__BackingField>String</d3p1:_x003C_GatewayResponseCode_x003E_k__BackingField>
<d3p1:_x003C_NetworkTransactionId_x003E_k__BackingField>String</d3p1:_x003C_NetworkTransactionId_x003E_k__BackingField>
<d3p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>false</d3p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>
<d3p1:_x003C_PostalCodeVerificationResult_x003E_k__BackingField>NotAttempted</d3p1:_x003C_PostalCodeVerificationResult_x003E_k__BackingField>
</d3p1:_x003C_VerificationResult_x003E_k__BackingField>
</d3p1:CardDetails>
<d3p1:ChapterId>0</d3p1:ChapterId>
<d3p1:ChargeTokenId>String</d3p1:ChargeTokenId>
<d3p1:Currency>String</d3p1:Currency>
<d3p1:Description>String</d3p1:Description>
<d3p1:EncryptionTypeId>0</d3p1:EncryptionTypeId>
<d3p1:ExpiresOn>0001-01-01T00:00:00</d3p1:ExpiresOn>
<d3p1:IntegrationPartnerId>0</d3p1:IntegrationPartnerId>
<d3p1:NationalId>0</d3p1:NationalId>
<d3p1:PaymentType>None</d3p1:PaymentType>
<d3p1:TokenType>String</d3p1:TokenType>
<d3p1:TokenVersion>0</d3p1:TokenVersion>
<d3p1:UsagesRemaining>0</d3p1:UsagesRemaining>
<d3p1:VerificationStatus>Initial</d3p1:VerificationStatus>
</d2p1:_x003C_ChargeToken_x003E_k__BackingField>
<d2p1:_x003C_CvvVerificationResult_x003E_k__BackingField>String</d2p1:_x003C_CvvVerificationResult_x003E_k__BackingField>
<d2p1:_x003C_GatewayMessage_x003E_k__BackingField>String</d2p1:_x003C_GatewayMessage_x003E_k__BackingField>
<d2p1:_x003C_GatewayResponseCode_x003E_k__BackingField>String</d2p1:_x003C_GatewayResponseCode_x003E_k__BackingField>
<d2p1:_x003C_IsDuplicate_x003E_k__BackingField>false</d2p1:_x003C_IsDuplicate_x003E_k__BackingField>
<d2p1:_x003C_IsError_x003E_k__BackingField>false</d2p1:_x003C_IsError_x003E_k__BackingField>
<d2p1:_x003C_NetworkTransactionId_x003E_k__BackingField>String</d2p1:_x003C_NetworkTransactionId_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>
</_x003C_CardVerificationDetails_x003E_k__BackingField>
<_x003C_Token_x003E_k__BackingField>String</_x003C_Token_x003E_k__BackingField>
</CoreChargeVerifyRs>