Billhighway Cloud API

<back to all web services

SalesForceCreditCardPaymentCollection

The following routes are available for this service:
POST/api/SalesForce/CreditCardPayment
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 SalesForceCreditCardPaymentReply:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    transaction_id: Optional[str] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesForceMemberPaymentInvoiceDetail:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    invoice: Optional[int] = None
    amount_paid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesForceCreditCardPayment:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    user_id: Optional[str] = None
    bh_user_id: Optional[int] = None
    amount: Optional[str] = None
    auto_pay: Optional[bool] = None
    currency_type: Optional[str] = None
    country: Optional[str] = None
    card_reference_or_card_number: Optional[str] = None
    store_card_info: Optional[bool] = None
    address1: Optional[str] = None
    address2: Optional[str] = None
    billing_city: Optional[str] = None
    billing_state: Optional[str] = None
    preferred_email_address: Optional[str] = None
    memo: Optional[str] = None
    opportunity_id: Optional[str] = None
    exp_month: Optional[int] = None
    exp_year: Optional[int] = None
    cvv: Optional[str] = None
    postal_code: Optional[str] = None
    location: Optional[str] = None
    name_on_card: Optional[str] = None
    card_type: Optional[str] = None
    invoice_list: Optional[List[SalesForceMemberPaymentInvoiceDetail]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesForceCreditCardPaymentCollection:
    sales_force_credit_card_payment_list: Optional[List[SalesForceCreditCardPayment]] = None

Python SalesForceCreditCardPaymentCollection DTOs

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

HTTP + JSON

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

POST /api/SalesForce/CreditCardPayment HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SalesForceCreditCardPaymentList":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","BhUserId":0,"Amount":"String","AutoPay":false,"CurrencyType":"String","Country":"String","CardReferenceOrCardNumber":"String","StoreCardInfo":false,"Address1":"String","Address2":"String","BillingCity":"String","BillingState":"String","PreferredEmailAddress":"String","Memo":"String","OpportunityId":"String","ExpMonth":0,"ExpYear":0,"Cvv":"String","PostalCode":"String","Location":"String","NameOnCard":"String","CardType":"String","InvoiceList":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"Invoice":0,"AmountPaid":"String"}]}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"TransactionId":"String","ErrorCode":0,"ErrorMessage":"String"}