| POST | /api/creditcard/refund | Performs a credit card refund | Perform a partial, or full low level credit card charge reversal WITHOUT recording debit. This should be used only in conjunction with code that records the debit. |
|---|
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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RefundResponse(CreditCardCloudServiceResponse):
is_overpayment: Optional[bool] = None
payment_not_found: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardRefund(CreditCardRefund):
pass
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/creditcard/refund HTTP/1.1
Host: devapi.billhighway.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
UserId: 0,
GroupId: 0,
Location: String,
CurrencyCode: String,
GatewayConfirmationNumber: String,
RefundAmount: 0,
Memo: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
IsOverpayment: False,
PaymentNotFound: False,
IsDuplicate: False,
IsSuccessful: False,
ErrorCode: String,
Message: String,
GatewayId: 0,
ConfirmationNumber: String,
NetworkTransactionId: String,
IsError: True
}