Billhighway Cloud API

<back to all web services

CreditCardRefund

The following routes are available for this service:
POST/api/creditcard/refundPerforms a credit card refundPerform 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.
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 RefundResponse
        : CreditCardCloudServiceResponse
    {
        public virtual bool IsOverpayment { get; set; }
        public virtual bool PaymentNotFound { get; set; }
    }

}

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

}

C# CreditCardRefund DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"UserId":0,"GroupId":0,"Location":"String","CurrencyCode":"String","GatewayConfirmationNumber":"String","RefundAmount":0,"Memo":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsOverpayment":false,"PaymentNotFound":false,"IsDuplicate":false,"IsSuccessful":false,"ErrorCode":"String","Message":"String","GatewayId":0,"ConfirmationNumber":"String","NetworkTransactionId":"String","IsError":true}