Billhighway Cloud API

<back to all web services

CreditCardDonationRefund

The following routes are available for this service:
POST/api/creditcard/DonationRefund
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 CreditCardDonationRefund() = 
        inherit CreditCardDonationRefund()

F# CreditCardDonationRefund 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/DonationRefund HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreditCardDonationRefund xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <Amount xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</Amount>
  <ConfirmationId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ConfirmationId>
  <Memo xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Memo>
  <ReasonId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ReasonId>
</CreditCardDonationRefund>

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>