Billhighway Cloud API

CreditCardRefund

The following routes are available for this service:
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.

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

    [<AllowNullLiteral>]
    type RefundResponse() = 
        inherit CreditCardCloudServiceResponse()
        member val IsOverpayment:Boolean = new Boolean() with get,set
        member val PaymentNotFound:Boolean = new Boolean() with get,set

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

F# CreditCardRefund DTOs

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

HTTP + XML

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

<CreditCardRefund xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <CurrencyCode xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CurrencyCode>
  <GatewayConfirmationNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</GatewayConfirmationNumber>
  <GroupId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</GroupId>
  <Location xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Location>
  <Memo xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Memo>
  <RefundAmount xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</RefundAmount>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</UserId>
</CreditCardRefund>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RefundResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <ConfirmationNumber>String</ConfirmationNumber>
  <ErrorCode>String</ErrorCode>
  <GatewayId>0</GatewayId>
  <IsDuplicate>false</IsDuplicate>
  <IsSuccessful>false</IsSuccessful>
  <Message>String</Message>
  <NetworkTransactionId>String</NetworkTransactionId>
  <IsOverpayment>false</IsOverpayment>
  <PaymentNotFound>false</PaymentNotFound>
</RefundResponse>