| POST | /payments/CreditCard/Verify | 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. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardVerifyReply(IHaveErrorField):
unique_id: Optional[str] = None
error_code: Optional[int] = None
error_message: Optional[str] = None
card_ref: Optional[str] = None
is_error: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesForceCreditCardVerify:
unique_id: Optional[str] = None
client_id: Optional[int] = None
group_id: Optional[str] = None
user_id: Optional[str] = None
bh_user_id: Optional[int] = None
location: Optional[str] = None
currency_code: Optional[str] = None
name_on_card: Optional[str] = None
address1: Optional[str] = None
address2: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
postal_code: Optional[str] = None
verify_postal_code: Optional[bool] = None
country: Optional[str] = None
card_type: Optional[str] = None
card_reference_or_card_number: Optional[str] = None
exp_month: Optional[int] = None
exp_year: Optional[int] = None
cvv: Optional[str] = None
amount: Optional[Decimal] = None
chap_and_user: Optional[str] = None
description: Optional[str] = None
pay_link_i_d: Optional[int] = None
Python SalesForceCreditCardVerify 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 /payments/CreditCard/Verify HTTP/1.1
Host: devapi.billhighway.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
UniqueId: String,
ClientId: 0,
GroupId: String,
UserId: String,
BhUserId: 0,
Location: String,
CurrencyCode: String,
NameOnCard: String,
Address1: String,
Address2: String,
City: String,
State: String,
PostalCode: String,
VerifyPostalCode: False,
Country: String,
CardType: String,
CardReferenceOrCardNumber: String,
ExpMonth: 0,
ExpYear: 0,
Cvv: String,
Amount: 0,
ChapAndUser: String,
Description: String,
PayLinkID: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
UniqueId: String,
ErrorCode: 0,
ErrorMessage: String,
CardRef: String,
IsError: False
}