Billhighway Cloud API

RefundCreditCardPayment

The following routes are available for this service:
POST	/api/SalesForce/RefundCreditCardPayment
POST	/payments/creditcard/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 RefundCreditCardPaymentReply(IHaveErrorField):
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None
    confirmation_number: Optional[str] = None
    is_error: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RefundCreditCardPayment:
    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
    refund_amount: Optional[Decimal] = None
    memo: Optional[str] = None
    transaction_id: Optional[int] = None
    reason: Optional[str] = None

Python RefundCreditCardPayment DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /api/SalesForce/RefundCreditCardPayment HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClassName: String,
	UniqueId: String,
	CreatedDateTime: 0001-01-01,
	ClientId: 0,
	GroupId: String,
	UserId: String,
	BhUserId: 0,
	RefundAmount: 0,
	Memo: String,
	TransactionId: 0,
	Reason: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ClassName: String,
	UniqueId: String,
	CreatedDateTime: 0001-01-01,
	ErrorCode: 0,
	ErrorMessage: String,
	ConfirmationNumber: String,
	IsError: False
}