Billhighway Cloud API

<back to all web services

CreditCardPaymentRefund

The following routes are available for this service:
POST/api/CreditCard/Payment/RefundPerforms a credit card payment refund against Performs a credit card payment refund.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO;
using BH.CloudAPI.Common.DTO;

namespace BH.CloudAPI.Common.DTO
{
    public partial class CreditCardCloudServiceResponse
        : IHaveErrorField
    {
        public virtual bool IsDuplicate { get; set; }
        public virtual bool IsSuccessful { get; set; }
        public virtual string ErrorCode { get; set; }
        public virtual string Message { get; set; }
        public virtual int? GatewayId { get; set; }
        public virtual string ConfirmationNumber { get; set; }
        public virtual string NetworkTransactionId { get; set; }
        public virtual bool IsError { get; set; }
    }

    public partial class CreditCardPaymentRefundResult
        : CreditCardCloudServiceResponse
    {
        public virtual long TransactionRecordID { get; set; }
        public virtual PaymentFailureType FailureType { get; set; }
        public virtual bool IsOverpayment { get; set; }
        public virtual bool PaymentNotFound { get; set; }
    }

    public enum PaymentFailureType
    {
        None = 0,
        Gateway = 1,
        PaymentTransaction = 2,
        KeyProcurment = 3,
        CardVerification = 4,
    }

}

namespace BH.CloudAPI.Common4.DTO
{
    public partial class CreditCardPaymentRefund
        : CreditCardPaymentRefund
    {
    }

}

C# CreditCardPaymentRefund 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/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
}