Billhighway Cloud API

<back to all web services

CoreChargeDonationRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/core/donationcharge
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 CoreChargeGatewaySaleResponse:
    failure_type: Optional[str] = None
    is_duplicate: Optional[bool] = None
    is_successful: Optional[bool] = None
    error_code: Optional[str] = None
    message: Optional[str] = None
    gateway_id: Optional[int] = None
    confirmation_number: Optional[str] = None
    network_transaction_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AttributeItem:
    name: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardBillingAddressItem:
    address1: Optional[str] = None
    address2: Optional[str] = None
    city: Optional[str] = None
    postal_code: Optional[str] = None
    region: Optional[str] = None
    country: Optional[str] = None
    attributes: Optional[List[AttributeItem]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardChargeVerificationResult:
    network_verification_attempted: Optional[bool] = None
    cvv_verification_result: Optional[str] = None
    address_verification_result: Optional[str] = None
    postal_code_verification_result: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoreCreditCardChargeDetails:
    card_type: Optional[str] = None
    exp_month: Optional[int] = None
    exp_year: Optional[int] = None
    last4: Optional[str] = None
    address: Optional[CreditCardBillingAddressItem] = None
    verification_result: Optional[CreditCardChargeVerificationResult] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoreChargeDetails:
    payment_type: Optional[str] = None
    amount: Optional[int] = None
    integration_type: Optional[str] = None
    currency: Optional[str] = None
    card_details: Optional[CoreCreditCardChargeDetails] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoreChargeDonationRs:
    transaction_id: Optional[str] = None
    stored_account_id: Optional[int] = None
    national_id: Optional[int] = None
    chapter_id: Optional[int] = None
    charge_type: Optional[str] = None
    integration_type: Optional[str] = None
    context_integration_partner_id: Optional[int] = None
    caller_integration_partner_id: Optional[int] = None
    gateway_response: Optional[CoreChargeGatewaySaleResponse] = None
    charge_details: Optional[CoreChargeDetails] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EventItem:
    customer_fee_item_type_id: Optional[str] = None
    quantity: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoreChargeDonationRq(IChargeRequest):
    # @ApiMember(ParameterType="path")
    integration_type: Optional[str] = None

    national_id: Optional[int] = None
    chapter_id: Optional[int] = None
    stored_account_id: Optional[int] = None
    context_integration_partner_id: Optional[int] = None
    caller_integration_partner_id: Optional[int] = None
    user_id: Optional[int] = None
    authentication_id: Optional[int] = None
    charge_type: Optional[str] = None
    token: Optional[str] = None
    # @ApiMember(Format="decimal", ParameterType="model")
    amount: Optional[Decimal] = None

    description: Optional[str] = None
    campaign_id: Optional[int] = None
    created_by_id: Optional[int] = None
    transaction_id: Optional[int] = None
    partner_reference_id: Optional[str] = None
    event_items: Optional[List[EventItem]] = None

Python CoreChargeDonationRq 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 /integrations/api/{integrationType}/core/donationcharge HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CoreChargeDonationRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.CoreCharges.Api.Request">
  <Amount>0</Amount>
  <AuthenticationId>0</AuthenticationId>
  <CallerIntegrationPartnerId>0</CallerIntegrationPartnerId>
  <CampaignId>0</CampaignId>
  <ChapterId>0</ChapterId>
  <ChargeType>String</ChargeType>
  <ContextIntegrationPartnerId>0</ContextIntegrationPartnerId>
  <CreatedById>0</CreatedById>
  <Description>String</Description>
  <EventItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO">
    <d2p1:EventItem>
      <d2p1:CustomerFeeItemTypeId>String</d2p1:CustomerFeeItemTypeId>
      <d2p1:Quantity>String</d2p1:Quantity>
    </d2p1:EventItem>
  </EventItems>
  <NationalId>0</NationalId>
  <PartnerReferenceId>String</PartnerReferenceId>
  <StoredAccountId>0</StoredAccountId>
  <Token>String</Token>
  <TransactionId>0</TransactionId>
  <UserId>0</UserId>
  <integrationType>String</integrationType>
</CoreChargeDonationRq>

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

<CoreChargeDonationRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.CoreCharges.Api.Response">
  <CallerIntegrationPartnerId>0</CallerIntegrationPartnerId>
  <ChapterId>0</ChapterId>
  <ChargeDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.CoreCharges">
    <d2p1:Amount>0</d2p1:Amount>
    <d2p1:CardDetails>
      <d2p1:_x003C_Address_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api">
        <d4p1:Address1>String</d4p1:Address1>
        <d4p1:Address2>String</d4p1:Address2>
        <d4p1:Attributes xmlns:d5p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO">
          <d5p1:AttributeItem>
            <d5p1:Name>String</d5p1:Name>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:AttributeItem>
        </d4p1:Attributes>
        <d4p1:City>String</d4p1:City>
        <d4p1:Country>String</d4p1:Country>
        <d4p1:PostalCode>String</d4p1:PostalCode>
        <d4p1:Region>String</d4p1:Region>
      </d2p1:_x003C_Address_x003E_k__BackingField>
      <d2p1:_x003C_CardType_x003E_k__BackingField>String</d2p1:_x003C_CardType_x003E_k__BackingField>
      <d2p1:_x003C_ExpMonth_x003E_k__BackingField>0</d2p1:_x003C_ExpMonth_x003E_k__BackingField>
      <d2p1:_x003C_ExpYear_x003E_k__BackingField>0</d2p1:_x003C_ExpYear_x003E_k__BackingField>
      <d2p1:_x003C_Last4_x003E_k__BackingField>String</d2p1:_x003C_Last4_x003E_k__BackingField>
      <d2p1:_x003C_VerificationResult_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Charges.Api">
        <d4p1:_x003C_AddressVerificationResult_x003E_k__BackingField>String</d4p1:_x003C_AddressVerificationResult_x003E_k__BackingField>
        <d4p1:_x003C_CvvVerificationResult_x003E_k__BackingField>String</d4p1:_x003C_CvvVerificationResult_x003E_k__BackingField>
        <d4p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>false</d4p1:_x003C_NetworkVerificationAttempted_x003E_k__BackingField>
        <d4p1:_x003C_PostalCodeVerificationResult_x003E_k__BackingField>String</d4p1:_x003C_PostalCodeVerificationResult_x003E_k__BackingField>
      </d2p1:_x003C_VerificationResult_x003E_k__BackingField>
    </d2p1:CardDetails>
    <d2p1:Currency>String</d2p1:Currency>
    <d2p1:IntegrationType>String</d2p1:IntegrationType>
    <d2p1:PaymentType>String</d2p1:PaymentType>
  </ChargeDetails>
  <ChargeType>String</ChargeType>
  <ContextIntegrationPartnerId>0</ContextIntegrationPartnerId>
  <GatewayResponse xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.CoreCharges">
    <d2p1:_x003C_ConfirmationNumber_x003E_k__BackingField>String</d2p1:_x003C_ConfirmationNumber_x003E_k__BackingField>
    <d2p1:_x003C_ErrorCode_x003E_k__BackingField>String</d2p1:_x003C_ErrorCode_x003E_k__BackingField>
    <d2p1:_x003C_FailureType_x003E_k__BackingField>String</d2p1:_x003C_FailureType_x003E_k__BackingField>
    <d2p1:_x003C_GatewayId_x003E_k__BackingField>0</d2p1:_x003C_GatewayId_x003E_k__BackingField>
    <d2p1:_x003C_IsDuplicate_x003E_k__BackingField>false</d2p1:_x003C_IsDuplicate_x003E_k__BackingField>
    <d2p1:_x003C_IsSuccessful_x003E_k__BackingField>false</d2p1:_x003C_IsSuccessful_x003E_k__BackingField>
    <d2p1:_x003C_Message_x003E_k__BackingField>String</d2p1:_x003C_Message_x003E_k__BackingField>
    <d2p1:_x003C_NetworkTransactionId_x003E_k__BackingField>String</d2p1:_x003C_NetworkTransactionId_x003E_k__BackingField>
  </GatewayResponse>
  <IntegrationType>String</IntegrationType>
  <NationalId>0</NationalId>
  <StoredAccountId>0</StoredAccountId>
  <TransactionId>String</TransactionId>
</CoreChargeDonationRs>