| 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 .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/Payment/Refund HTTP/1.1
Host: devapi.billhighway.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Header:
{
ClientId: 0,
Referrer: String,
IpAddress: String,
LoggedInUserId: 0,
GroupId: 0,
Task: String,
Machine: String,
Location: String,
CreatedBy: 0,
CampaignId: 0,
ReCaptchaScore: 0
},
RefundInfo:
{
CurrencyCode: String,
GatewayTransactionId: String,
Amount: 0,
Memo: String,
MemberPaymentId: 0,
Type: 0,
ReasonId: 0,
UserId: 0
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
TransactionRecordID: 0,
FailureType: 0,
IsOverpayment: False,
PaymentNotFound: False,
IsDuplicate: False,
IsSuccessful: False,
ErrorCode: String,
Message: String,
GatewayId: 0,
ConfirmationNumber: String,
NetworkTransactionId: String,
IsError: True
}