Billhighway Cloud API

<back to all web services

ListPaymentActivity

The following routes are available for this service:
GET/v1.1/transactions/listpaymentactivity
GET/v1.2/transactions/listpaymentactivity
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 PaymentActivity:
    transaction_id: Optional[int] = None
    transaction_type: Optional[str] = None
    transaction_date: Optional[datetime.datetime] = None
    amount: Optional[Decimal] = None
    notes: Optional[str] = None
    fee_amount: Optional[Decimal] = None
    reason: Optional[str] = None
    payer_name: Optional[str] = None
    payer_address: Optional[str] = None
    payer_email: Optional[str] = None
    group_name: Optional[str] = None


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

Python ListPaymentActivity 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.

GET /v1.1/transactions/listpaymentactivity HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentActivity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.Models">
  <Amount>0</Amount>
  <FeeAmount>0</FeeAmount>
  <GroupName>String</GroupName>
  <Notes>String</Notes>
  <PayerAddress>String</PayerAddress>
  <PayerEmail>String</PayerEmail>
  <PayerName>String</PayerName>
  <Reason>String</Reason>
  <TransactionDate>0001-01-01T00:00:00</TransactionDate>
  <TransactionId>0</TransactionId>
  <TransactionType>String</TransactionType>
</PaymentActivity>