Billhighway Cloud API

CreditCardPaymentRefund

The following routes are available for this service:
POST	/api/CreditCard/Payment/Refund	Performs a credit card payment refund against	Performs a credit card payment refund.

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 CreditCardCloudServiceResponse(IHaveErrorField):
    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
    is_error: Optional[bool] = None


class PaymentFailureType(IntEnum):
    NONE = 0
    GATEWAY = 1
    PAYMENT_TRANSACTION = 2
    KEY_PROCURMENT = 3
    CARD_VERIFICATION = 4


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardPaymentRefundResult(CreditCardCloudServiceResponse):
    transaction_record_i_d: Optional[int] = None
    failure_type: Optional[PaymentFailureType] = None
    is_overpayment: Optional[bool] = None
    payment_not_found: Optional[bool] = None


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

Python CreditCardPaymentRefund 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 /api/CreditCard/Payment/Refund HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreditCardPaymentRefund xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <Header xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <CampaignId>0</CampaignId>
    <ClientId>0</ClientId>
    <CreatedBy>0</CreatedBy>
    <GroupId>0</GroupId>
    <IpAddress>String</IpAddress>
    <Location>String</Location>
    <LoggedInUserId>0</LoggedInUserId>
    <Machine>String</Machine>
    <ReCaptchaScore>0</ReCaptchaScore>
    <Referrer>String</Referrer>
    <Task>String</Task>
  </Header>
  <RefundInfo xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
    <Amount>0</Amount>
    <CurrencyCode>String</CurrencyCode>
    <GatewayTransactionId>String</GatewayTransactionId>
    <MemberPaymentId>0</MemberPaymentId>
    <Memo>String</Memo>
    <ReasonId>0</ReasonId>
    <Type>None</Type>
    <UserId>0</UserId>
  </RefundInfo>
</CreditCardPaymentRefund>

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

<CreditCardPaymentRefundResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <ConfirmationNumber>String</ConfirmationNumber>
  <ErrorCode>String</ErrorCode>
  <GatewayId>0</GatewayId>
  <IsDuplicate>false</IsDuplicate>
  <IsSuccessful>false</IsSuccessful>
  <Message>String</Message>
  <NetworkTransactionId>String</NetworkTransactionId>
  <FailureType>None</FailureType>
  <IsOverpayment>false</IsOverpayment>
  <PaymentNotFound>false</PaymentNotFound>
  <TransactionRecordID>0</TransactionRecordID>
</CreditCardPaymentRefundResult>