| 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. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsOverpayment | form | bool | No | |
| PaymentNotFound | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsDuplicate | form | bool | No | |
| IsSuccessful | form | bool | No | |
| ErrorCode | form | string | No | |
| Message | form | string | No | |
| GatewayId | form | int? | No | |
| ConfirmationNumber | form | string | No | |
| NetworkTransactionId | form | string | No | |
| IsError | form | bool | No |
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
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}