| POST | /api/v2/PaymentMethods/CC/Verification | Performs 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. |
|---|
export class CreditCardCloudServiceResponse implements IHaveErrorField
{
public IsDuplicate?: boolean;
public IsSuccessful?: boolean;
public ErrorCode?: string;
public Message?: string;
public GatewayId?: number;
public ConfirmationNumber?: string;
public NetworkTransactionId?: string;
public IsError?: boolean;
public constructor(init?: Partial<CreditCardCloudServiceResponse>) { (Object as any).assign(this, init); }
}
export class CreditCardVerifyResult extends CreditCardCloudServiceResponse
{
public CardRef?: string;
public constructor(init?: Partial<CreditCardVerifyResult>) { super(init); (Object as any).assign(this, init); }
}
export class CreditCardVerify extends CreditCardVerify
{
public constructor(init?: Partial<CreditCardVerify>) { super(init); (Object as any).assign(this, init); }
}
TypeScript CreditCardVerify DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/v2/PaymentMethods/CC/Verification HTTP/1.1
Host: devapi.billhighway.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
UserId: 0,
GroupId: 0,
Location: String,
CurrencyCode: String,
NameOnCard: String,
Address1: String,
Address2: String,
City: String,
State: String,
PostalCode: String,
Country: String,
CardType: 0,
CardNumber: String,
ExpMonth: 0,
ExpYear: 0,
CVV: String,
Amount: 0,
ChapAndUser: String,
Description: String,
PayLinkID: 0,
EnsureValidZipAndCvc: False,
ReCaptchaScore: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
CardRef: String,
IsDuplicate: False,
IsSuccessful: False,
ErrorCode: String,
Message: String,
GatewayId: 0,
ConfirmationNumber: String,
NetworkTransactionId: String,
IsError: True
}