| POST | /integrations/api/{tokenType}/charge/token |
|---|
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 ChargeTokenOptions:
usages: Optional[int] = None
duration: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AttributeItem:
name: Optional[str] = None
value: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardBillingAddressItem:
address1: Optional[str] = None
address2: Optional[str] = None
city: Optional[str] = None
postal_code: Optional[str] = None
region: Optional[str] = None
country: Optional[str] = None
attributes: Optional[List[AttributeItem]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardChargeItem:
name_on_card: Optional[str] = None
exp_month: Optional[int] = None
exp_year: Optional[int] = None
card_number: Optional[str] = None
cvv: Optional[str] = None
address: Optional[CreditCardBillingAddressItem] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchChargeItem:
account_number: Optional[str] = None
routing_number: Optional[str] = None
account_type: Optional[str] = None
account_holder_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReferenceIdTypedAssociationItem:
value: Optional[str] = None
type: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChargeTokenRqBase(IChapterAuthorizationRequest, IApiResultErrorService):
token_type: Optional[str] = None
amount: Optional[int] = None
description: Optional[str] = None
options: Optional[ChargeTokenOptions] = None
card_info: Optional[CreditCardChargeItem] = None
ach_info: Optional[AchChargeItem] = None
reference_ids: Optional[List[ReferenceIdTypedAssociationItem]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardChargeVerificationResult:
network_verification_attempted: Optional[bool] = None
cvv_verification_result: Optional[str] = None
address_verification_result: Optional[str] = None
postal_code_verification_result: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardChargeDetails:
card_type: Optional[str] = None
exp_month: Optional[int] = None
exp_year: Optional[int] = None
last4: Optional[str] = None
address: Optional[CreditCardBillingAddressItem] = None
verification_result: Optional[CreditCardChargeVerificationResult] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchChargeVerificationResult:
network_verification_attempted: Optional[bool] = None
result: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchChargeDetails:
account_type: Optional[str] = None
routing_number: Optional[str] = None
account_number_last4: Optional[str] = None
bank_name: Optional[str] = None
verification_result: Optional[AchChargeVerificationResult] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChargeTokenRs:
token: Optional[str] = None
organization_id: Optional[int] = None
chapter_id: Optional[int] = None
amount: Optional[int] = None
token_type: Optional[str] = None
description: Optional[str] = None
expires_on: Optional[datetime.datetime] = None
currency: Optional[str] = None
usages: Optional[int] = None
card_details: Optional[CreditCardChargeDetails] = None
ach_details: Optional[AchChargeDetails] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChargeTokenRq(ChargeTokenRqBase):
pass
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 /integrations/api/{tokenType}/charge/token HTTP/1.1
Host: devapi.billhighway.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"tokenType":"String","Amount":0,"Description":"String","Options":{"Usages":0,"Duration":0},"CardInfo":{"NameOnCard":"String","ExpMonth":0,"ExpYear":0,"CardNumber":"String","Cvv":"String","Address":{"Address1":"String","Address2":"String","City":"String","PostalCode":"String","Region":"String","Country":"String","Attributes":[{"Name":"String","Value":"String"}]}},"AchInfo":{"AccountNumber":"String","RoutingNumber":"String","AccountType":"String","AccountHolderName":"String"},"ReferenceIds":[{"Value":"String","Type":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Token":"String","OrganizationId":0,"ChapterId":0,"Amount":0,"TokenType":"String","Description":"String","ExpiresOn":"0001-01-01T00:00:00.0000000","Currency":"String","Usages":0,"CardDetails":{"CardType":"String","ExpMonth":0,"ExpYear":0,"Last4":"String","Address":{"Address1":"String","Address2":"String","City":"String","PostalCode":"String","Region":"String","Country":"String","Attributes":[{"Name":"String","Value":"String"}]},"VerificationResult":{"NetworkVerificationAttempted":false,"CvvVerificationResult":"String","AddressVerificationResult":"String","PostalCodeVerificationResult":"String"}},"AchDetails":{"AccountType":"String","RoutingNumber":"String","AccountNumberLast4":"String","BankName":"String","VerificationResult":{"NetworkVerificationAttempted":false,"Result":"String"}}}