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.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO
Imports BH.CloudAPI.Common.DTO

Namespace Global

    Namespace BH.CloudAPI.Common.DTO

        Public Partial Class CreditCardCloudServiceResponse
            Implements IHaveErrorField
            Public Overridable Property IsDuplicate As Boolean
            Public Overridable Property IsSuccessful As Boolean
            Public Overridable Property ErrorCode As String
            Public Overridable Property Message As String
            Public Overridable Property GatewayId As Nullable(Of Integer)
            Public Overridable Property ConfirmationNumber As String
            Public Overridable Property NetworkTransactionId As String
            Public Overridable Property IsError As Boolean
        End Class

        Public Partial Class CreditCardPaymentRefundResult
            Inherits CreditCardCloudServiceResponse
            Public Overridable Property TransactionRecordID As Long
            Public Overridable Property FailureType As PaymentFailureType
            Public Overridable Property IsOverpayment As Boolean
            Public Overridable Property PaymentNotFound As Boolean
        End Class

        Public Enum PaymentFailureType
            None = 0
            Gateway = 1
            PaymentTransaction = 2
            KeyProcurment = 3
            CardVerification = 4
        End Enum
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO

        Public Partial Class CreditCardPaymentRefund
            Inherits CreditCardPaymentRefund
        End Class
    End Namespace
End Namespace

VB.NET CreditCardPaymentRefund 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/Payment/Refund HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
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: application/json
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}