Billhighway Cloud API

<back to all web services

SalesForceCreditCardVerify

The following routes are available for this service:
POST/payments/CreditCard/VerifyPerforms 0 dollar verify of a credit card.Validates the credit card type, expiration date and performs credit card address verification against the credit card networks.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SalesForceCreditCardVerify
    {
        public String UniqueId = null;
        public Integer ClientId = null;
        public String GroupId = null;
        public String UserId = null;
        public Integer BhUserId = null;
        public String Location = null;
        public String CurrencyCode = null;
        public String NameOnCard = null;
        public String Address1 = null;
        public String Address2 = null;
        public String City = null;
        public String State = null;
        public String PostalCode = null;
        public Boolean VerifyPostalCode = null;
        public String Country = null;
        public String CardType = null;
        public String CardReferenceOrCardNumber = null;
        public Integer ExpMonth = null;
        public Integer ExpYear = null;
        public String Cvv = null;
        public BigDecimal Amount = null;
        public String ChapAndUser = null;
        public String Description = null;
        public Integer PayLinkID = null;
        
        public String getUniqueId() { return UniqueId; }
        public SalesForceCreditCardVerify setUniqueId(String value) { this.UniqueId = value; return this; }
        public Integer getClientId() { return ClientId; }
        public SalesForceCreditCardVerify setClientId(Integer value) { this.ClientId = value; return this; }
        public String getGroupId() { return GroupId; }
        public SalesForceCreditCardVerify setGroupId(String value) { this.GroupId = value; return this; }
        public String getUserId() { return UserId; }
        public SalesForceCreditCardVerify setUserId(String value) { this.UserId = value; return this; }
        public Integer getBhUserId() { return BhUserId; }
        public SalesForceCreditCardVerify setBhUserId(Integer value) { this.BhUserId = value; return this; }
        public String getLocation() { return Location; }
        public SalesForceCreditCardVerify setLocation(String value) { this.Location = value; return this; }
        public String getCurrencyCode() { return CurrencyCode; }
        public SalesForceCreditCardVerify setCurrencyCode(String value) { this.CurrencyCode = value; return this; }
        public String getNameOnCard() { return NameOnCard; }
        public SalesForceCreditCardVerify setNameOnCard(String value) { this.NameOnCard = value; return this; }
        public String getAddress1() { return Address1; }
        public SalesForceCreditCardVerify setAddress1(String value) { this.Address1 = value; return this; }
        public String getAddress2() { return Address2; }
        public SalesForceCreditCardVerify setAddress2(String value) { this.Address2 = value; return this; }
        public String getCity() { return City; }
        public SalesForceCreditCardVerify setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public SalesForceCreditCardVerify setState(String value) { this.State = value; return this; }
        public String getPostalCode() { return PostalCode; }
        public SalesForceCreditCardVerify setPostalCode(String value) { this.PostalCode = value; return this; }
        public Boolean isVerifyPostalCode() { return VerifyPostalCode; }
        public SalesForceCreditCardVerify setVerifyPostalCode(Boolean value) { this.VerifyPostalCode = value; return this; }
        public String getCountry() { return Country; }
        public SalesForceCreditCardVerify setCountry(String value) { this.Country = value; return this; }
        public String getCardType() { return CardType; }
        public SalesForceCreditCardVerify setCardType(String value) { this.CardType = value; return this; }
        public String getCardReferenceOrCardNumber() { return CardReferenceOrCardNumber; }
        public SalesForceCreditCardVerify setCardReferenceOrCardNumber(String value) { this.CardReferenceOrCardNumber = value; return this; }
        public Integer getExpMonth() { return ExpMonth; }
        public SalesForceCreditCardVerify setExpMonth(Integer value) { this.ExpMonth = value; return this; }
        public Integer getExpYear() { return ExpYear; }
        public SalesForceCreditCardVerify setExpYear(Integer value) { this.ExpYear = value; return this; }
        public String getCvv() { return Cvv; }
        public SalesForceCreditCardVerify setCvv(String value) { this.Cvv = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public SalesForceCreditCardVerify setAmount(BigDecimal value) { this.Amount = value; return this; }
        public String getChapAndUser() { return ChapAndUser; }
        public SalesForceCreditCardVerify setChapAndUser(String value) { this.ChapAndUser = value; return this; }
        public String getDescription() { return Description; }
        public SalesForceCreditCardVerify setDescription(String value) { this.Description = value; return this; }
        public Integer getPayLinkID() { return PayLinkID; }
        public SalesForceCreditCardVerify setPayLinkID(Integer value) { this.PayLinkID = value; return this; }
    }

    public static class CreditCardVerifyReply implements IHaveErrorField
    {
        public String UniqueId = null;
        public Integer ErrorCode = null;
        public String ErrorMessage = null;
        public String CardRef = null;
        public Boolean IsError = null;
        
        public String getUniqueId() { return UniqueId; }
        public CreditCardVerifyReply setUniqueId(String value) { this.UniqueId = value; return this; }
        public Integer getErrorCode() { return ErrorCode; }
        public CreditCardVerifyReply setErrorCode(Integer value) { this.ErrorCode = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public CreditCardVerifyReply setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getCardRef() { return CardRef; }
        public CreditCardVerifyReply setCardRef(String value) { this.CardRef = value; return this; }
        public Boolean getIsError() { return IsError; }
        public CreditCardVerifyReply setIsError(Boolean value) { this.IsError = value; return this; }
    }

}

Java SalesForceCreditCardVerify 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 /payments/CreditCard/Verify HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SalesForceCreditCardVerify xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <Address1>String</Address1>
  <Address2>String</Address2>
  <Amount>0</Amount>
  <BhUserId>0</BhUserId>
  <CardReferenceOrCardNumber>String</CardReferenceOrCardNumber>
  <CardType>String</CardType>
  <ChapAndUser>String</ChapAndUser>
  <City>String</City>
  <ClientId>0</ClientId>
  <Country>String</Country>
  <CurrencyCode>String</CurrencyCode>
  <Cvv>String</Cvv>
  <Description>String</Description>
  <ExpMonth>0</ExpMonth>
  <ExpYear>0</ExpYear>
  <GroupId>String</GroupId>
  <Location>String</Location>
  <NameOnCard>String</NameOnCard>
  <PayLinkID>0</PayLinkID>
  <PostalCode>String</PostalCode>
  <State>String</State>
  <UniqueId>String</UniqueId>
  <UserId>String</UserId>
  <VerifyPostalCode>false</VerifyPostalCode>
</SalesForceCreditCardVerify>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreditCardVerifyReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <CardRef>String</CardRef>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <UniqueId>String</UniqueId>
</CreditCardVerifyReply>