Billhighway Cloud API

<back to all web services

CreditCardVerify

The following routes are available for this service:
POST/api/v2/PaymentMethods/CC/VerificationPerforms 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 CreditCardCloudServiceResponse(IHaveErrorField):
    is_duplicate: Optional[bool] = None
    is_successful: Optional[bool] = None
    error_code: Optional[str] = None
    message: Optional[str] = None
    gateway_id: Optional[int] = None
    confirmation_number: Optional[str] = None
    network_transaction_id: Optional[str] = None
    is_error: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardVerifyResult(CreditCardCloudServiceResponse):
    card_ref: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardVerify(CreditCardVerify):
    pass

Python CreditCardVerify DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"CardRef":"String","IsDuplicate":false,"IsSuccessful":false,"ErrorCode":"String","Message":"String","GatewayId":0,"ConfirmationNumber":"String","NetworkTransactionId":"String","IsError":true}