Billhighway Cloud API

<back to all web services

MemberPaymentOption

The following routes are available for this service:
GET/members/PaymentOption
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 PaymentOptions:
    bh_user_id: Optional[int] = None
    user_id: Optional[str] = None
    payment_option: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberPaymentOptionReply(IHaveErrorField):
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None
    payment_option: Optional[List[PaymentOptions]] = None
    # @ApiMember(ExcludeInSchema=true)
    is_error: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberPaymentOption:
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    user_id: Optional[str] = None
    bh_user_id: Optional[int] = None

Python MemberPaymentOption 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 /members/PaymentOption HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MemberPaymentOptionReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <ClientId>0</ClientId>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <GroupId>String</GroupId>
  <PaymentOption>
    <PaymentOptions>
      <BhUserId>0</BhUserId>
      <PaymentOption>String</PaymentOption>
      <UserId>String</UserId>
    </PaymentOptions>
  </PaymentOption>
</MemberPaymentOptionReply>