# Refund transaction

GET https://api-sandbox.payabli.com/api/MoneyIn/refund/{transId}/{amount}

Refund a transaction that has settled and send money back to the account holder. If a transaction hasn't been settled, void it instead.

  <Tip>
  Consider migrating to the [v2 Refund endpoint](/developers/api-reference/moneyinV2/refund-a-settled-transaction) to take advantage of unified response codes and improved response consistency.
  </Tip>

Reference: https://docs.payabli.com/developers/api-reference/moneyin/refund-a-settled-transaction

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Refund a settled transaction
  version: endpoint_moneyIn.Refund
paths:
  /MoneyIn/refund/{transId}/{amount}:
    get:
      operationId: refund
      summary: Refund a settled transaction
      description: >-
        Refund a transaction that has settled and send money back to the account
        holder. If a transaction hasn't been settled, void it instead.

          <Tip>
          Consider migrating to the [v2 Refund endpoint](/developers/api-reference/moneyinV2/refund-a-settled-transaction) to take advantage of unified response codes and improved response consistency.
          </Tip>
      tags:
        - - subpackage_moneyIn
      parameters:
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
        - name: amount
          in: path
          description: >-

            Amount to refund from original transaction, minus any service fees
            charged on the original transaction. 


            The amount provided can't be greater than the original total amount
            of the transaction, minus service fees. For example, if a
            transaction was \$90 plus a \$10 service fee, you can refund up to
            \$90.


            An amount equal to zero will refund the total amount authorized
            minus any service fee.
          required: true
          schema:
            type: number
            format: double
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_moneyIn:RefundResponse'
        '400':
          description: Bad request/ invalid data
          content: {}
        '401':
          description: Unauthorized request.
          content: {}
        '500':
          description: Internal API Error
          content: {}
        '503':
          description: Database connection error
          content: {}
components:
  schemas:
    type_:ResponseText:
      type: string
    type_:IsSuccess:
      type: boolean
    type_:Authcode:
      type: string
    type_:ExpectedProcessingDateTime:
      type: string
      format: date-time
    type_:AvsResponseText:
      type: string
    type_:CustomerId:
      type: integer
      format: int64
    type_:CvvResponseText:
      type: string
    type_:MethodReferenceId:
      type: string
    type_:Referenceidtrans:
      type: string
    type_:ResultCode:
      type: integer
    type_moneyIn:ResponseDataRefunds:
      type: object
      properties:
        authCode:
          $ref: '#/components/schemas/type_:Authcode'
        expectedProcessingDateTime:
          oneOf:
            - $ref: '#/components/schemas/type_:ExpectedProcessingDateTime'
            - type: 'null'
        avsResponseText:
          $ref: '#/components/schemas/type_:AvsResponseText'
          description: This field isn't applicable to refund operations.
        customerId:
          oneOf:
            - $ref: '#/components/schemas/type_:CustomerId'
            - type: 'null'
        cvvResponseText:
          oneOf:
            - $ref: '#/components/schemas/type_:CvvResponseText'
            - type: 'null'
          description: This field isn't applicable to refund operations.
        methodReferenceId:
          oneOf:
            - $ref: '#/components/schemas/type_:MethodReferenceId'
            - type: 'null'
          description: This field isn't applicable to refund operations.
        referenceId:
          $ref: '#/components/schemas/type_:Referenceidtrans'
        resultCode:
          $ref: '#/components/schemas/type_:ResultCode'
        resultText:
          type: string
          description: Text description of the transaction result
      required:
        - authCode
        - expectedProcessingDateTime
        - customerId
        - cvvResponseText
        - methodReferenceId
        - referenceId
        - resultCode
        - resultText
    type_:PageIdentifier:
      type: string
    type_moneyIn:RefundResponse:
      type: object
      properties:
        responseText:
          $ref: '#/components/schemas/type_:ResponseText'
        isSuccess:
          $ref: '#/components/schemas/type_:IsSuccess'
        responseData:
          $ref: '#/components/schemas/type_moneyIn:ResponseDataRefunds'
        pageidentifier:
          $ref: '#/components/schemas/type_:PageIdentifier'
      required:
        - responseText
        - isSuccess
        - responseData

```

## SDK Code Examples

```python Initiated
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY",
)
client.money_in.refund(
    amount=0.0,
    trans_id="10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
)

```

```typescript Initiated
import { PayabliClient } from "@payabli/sdk-node";

const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.moneyIn.refund("10-3ffa27df-b171-44e0-b251-e95fbfc7a723", 0);

```

```go Initiated
import (
	context "context"
	option "github.com/payabli/sdk-go/option"
	sdkgoclient "github.com/payabli/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.MoneyIn.Refund(
	context.TODO(),
	0,
	"10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
)

```

```csharp Initiated
using PayabliApi;

var client = new PayabliApiClient("API_KEY");
await client.MoneyIn.RefundAsync(0, "10-3ffa27df-b171-44e0-b251-e95fbfc7a723");

```

```ruby Initiated
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/MoneyIn/refund/10-3ffa27df-b171-44e0-b251-e95fbfc7a723/0")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Initiated
HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/MoneyIn/refund/10-3ffa27df-b171-44e0-b251-e95fbfc7a723/0")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php Initiated
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/MoneyIn/refund/10-3ffa27df-b171-44e0-b251-e95fbfc7a723/0', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```swift Initiated
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/MoneyIn/refund/10-3ffa27df-b171-44e0-b251-e95fbfc7a723/0")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

```python Captured
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY",
)
client.money_in.refund(
    amount=100.99,
    trans_id="10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
)

```

```typescript Captured
import { PayabliClient } from "@payabli/sdk-node";

const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.moneyIn.refund("10-3ffa27df-b171-44e0-b251-e95fbfc7a723", 100.99);

```

```go Captured
import (
	context "context"
	option "github.com/payabli/sdk-go/option"
	sdkgoclient "github.com/payabli/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.MoneyIn.Refund(
	context.TODO(),
	0,
	"10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
)

```

```csharp Captured
using PayabliApi;

var client = new PayabliApiClient("API_KEY");
await client.MoneyIn.RefundAsync(100.99, "10-3ffa27df-b171-44e0-b251-e95fbfc7a723");

```

```ruby Captured
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/MoneyIn/refund/10-3ffa27df-b171-44e0-b251-e95fbfc7a723/100.99")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Captured
HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/MoneyIn/refund/10-3ffa27df-b171-44e0-b251-e95fbfc7a723/100.99")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php Captured
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/MoneyIn/refund/10-3ffa27df-b171-44e0-b251-e95fbfc7a723/100.99', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```swift Captured
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/MoneyIn/refund/10-3ffa27df-b171-44e0-b251-e95fbfc7a723/100.99")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```