Billhighway Cloud API

<back to all web services

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 .jsv suffix or ?format=jsv

HTTP + JSV

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

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

{
	apiKey: String,
	featureID: 0,
	clientID: 0,
	groupID: 0,
	Amount: 0,
	nameOnCard: String,
	cardType: String,
	cardNumber: String,
	expMonth: String,
	expYear: String,
	cvv: String,
	address: String,
	city: String,
	state: String,
	postalCode: String,
	email: String,
	memo: String,
	occurs: String,
	numberOfOccurrences: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ccPaymentByGroupResult: 
	[
		0,
		0,
		0,
		String,
		String,
		0
	],
	amount: 0,
	confirmationNumber: String,
	responseCode: String,
	responseDescription: String,
	resultCode: 0
}