Billhighway Cloud API

ccPaymentByGroup

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


class ResultCode(IntEnum):
    SUCCESS = 0
    DUPLICATE = -7
    NOT_AVAILABLE = -6
    NOT_FOUND = -5
    GENERAL_ERROR = -4
    UNEXPECTED_ERROR = -3
    CREDIT_CARD_DECLINED = -2
    DATA_VALIDATION_FAILURE = -1


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LegacyApiResponse(IHaveErrorField):
    amount: Optional[Decimal] = None
    confirmation_number: Optional[str] = None
    response_code: Optional[str] = None
    response_description: Optional[str] = None
    result_code: Optional[ResultCode] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ccPaymentByGroupResponse(LegacyApiResponse):
    results: Optional[SoapArrayList] = None


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

Python ccPaymentByGroup DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/ccPaymentByGroup HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ccPaymentByGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SOAP">
  <apiKey xmlns="www.billhighway.com/api">String</apiKey>
  <featureID xmlns="www.billhighway.com/api">0</featureID>
  <clientID xmlns="www.billhighway.com/api">0</clientID>
  <groupID xmlns="www.billhighway.com/api">0</groupID>
  <Amount xmlns="www.billhighway.com/api">0</Amount>
  <nameOnCard xmlns="www.billhighway.com/api">String</nameOnCard>
  <cardType xmlns="www.billhighway.com/api">String</cardType>
  <cardNumber xmlns="www.billhighway.com/api">String</cardNumber>
  <expMonth xmlns="www.billhighway.com/api">String</expMonth>
  <expYear xmlns="www.billhighway.com/api">String</expYear>
  <cvv xmlns="www.billhighway.com/api">String</cvv>
  <address xmlns="www.billhighway.com/api">String</address>
  <city xmlns="www.billhighway.com/api">String</city>
  <state xmlns="www.billhighway.com/api">String</state>
  <postalCode xmlns="www.billhighway.com/api">String</postalCode>
  <email xmlns="www.billhighway.com/api">String</email>
  <memo xmlns="www.billhighway.com/api">String</memo>
  <occurs xmlns="www.billhighway.com/api">String</occurs>
  <numberOfOccurrences xmlns="www.billhighway.com/api">String</numberOfOccurrences>
</ccPaymentByGroup>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ccPaymentByGroupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="www.billhighway.com/api">
  <amount>0</amount>
  <confirmationNumber>String</confirmationNumber>
  <responseCode>String</responseCode>
  <responseDescription>String</responseDescription>
  <resultCode>Success</resultCode>
  <ccPaymentByGroupResult>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int">0</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int">0</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:decimal">0</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string">String</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string">String</anyType>
    <anyType xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string">0</anyType>
  </ccPaymentByGroupResult>
</ccPaymentByGroupResponse>