| POST | /api/creditcard/createcardref | Creates, records and returns a 'cardRef' | Creates, records and returns a 'reference' to a credit card. This so called 'cardRef' can then be usedas an alternative value to pass to other credit card transactions such as Verfy or Sale potentially improving securityby not passing card numbers. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class CreateCardRef extends CreateCardRef
{
}
public static class CreateCardRefResponse extends CreditCardCloudServiceResponse
{
public String CardRef = null;
public CreditCardType CardType = null;
public String getCardRef() { return CardRef; }
public CreateCardRefResponse setCardRef(String value) { this.CardRef = value; return this; }
public CreditCardType getCardType() { return CardType; }
public CreateCardRefResponse setCardType(CreditCardType value) { this.CardType = value; return this; }
}
public static class CreditCardCloudServiceResponse implements IHaveErrorField
{
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 Boolean IsError = null;
public Boolean getIsDuplicate() { return IsDuplicate; }
public CreditCardCloudServiceResponse setIsDuplicate(Boolean value) { this.IsDuplicate = value; return this; }
public Boolean getIsSuccessful() { return IsSuccessful; }
public CreditCardCloudServiceResponse setIsSuccessful(Boolean value) { this.IsSuccessful = value; return this; }
public String getErrorCode() { return ErrorCode; }
public CreditCardCloudServiceResponse setErrorCode(String value) { this.ErrorCode = value; return this; }
public String getMessage() { return Message; }
public CreditCardCloudServiceResponse setMessage(String value) { this.Message = value; return this; }
public Integer getGatewayId() { return GatewayId; }
public CreditCardCloudServiceResponse setGatewayId(Integer value) { this.GatewayId = value; return this; }
public String getConfirmationNumber() { return ConfirmationNumber; }
public CreditCardCloudServiceResponse setConfirmationNumber(String value) { this.ConfirmationNumber = value; return this; }
public String getNetworkTransactionId() { return NetworkTransactionId; }
public CreditCardCloudServiceResponse setNetworkTransactionId(String value) { this.NetworkTransactionId = value; return this; }
public Boolean getIsError() { return IsError; }
public CreditCardCloudServiceResponse setIsError(Boolean value) { this.IsError = value; return this; }
}
public static enum CreditCardType
{
@SerializedName("0") AmericanExpress(0),
@SerializedName("1") Discover(1),
@SerializedName("2") MasterCard(2),
@SerializedName("3") Visa(3),
@SerializedName("4") DinersClub(4),
@SerializedName("5") DinersCartBlanche(5),
@SerializedName("6") Unknown(6);
private final int value;
CreditCardType(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/creditcard/createcardref HTTP/1.1
Host: devapi.billhighway.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"UserId":0,"GroupId":0,"Location":"String","CurrencyCode":"String","CardType":0,"NameOnCard":"String","CardNumber":"String","ExpirationMonth":0,"ExpirationYear":0,"ValidationNum":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"CardRef":"String","CardType":0,"IsDuplicate":false,"IsSuccessful":false,"ErrorCode":"String","Message":"String","GatewayId":0,"ConfirmationNumber":"String","NetworkTransactionId":"String","IsError":true}