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.
namespace BH.CloudAPI.Common.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CreditCardCloudServiceResponse() = 
        member val IsDuplicate:Boolean = new Boolean() with get,set
        member val IsSuccessful:Boolean = new Boolean() with get,set
        member val ErrorCode:String = null with get,set
        member val Message:String = null with get,set
        member val GatewayId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ConfirmationNumber:String = null with get,set
        member val NetworkTransactionId:String = null with get,set
        member val IsError:Boolean = new Boolean() with get,set

    type PaymentFailureType =
        | None = 0
        | Gateway = 1
        | PaymentTransaction = 2
        | KeyProcurment = 3
        | CardVerification = 4

    [<AllowNullLiteral>]
    type CreditCardPaymentRefundResult() = 
        inherit CreditCardCloudServiceResponse()
        member val TransactionRecordID:Int64 = new Int64() with get,set
        member val FailureType:PaymentFailureType = new PaymentFailureType() with get,set
        member val IsOverpayment:Boolean = new Boolean() with get,set
        member val PaymentNotFound:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CreditCardPaymentRefund() = 
        inherit CreditCardPaymentRefund()

F# 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
}