# Cancel Payout

{% hint style="info" %}
TIP

For users to manually cancel payout or merchants to cancel payout.
{% endhint %}

## **Interface address**

```
POST https://api.tokenpay.me/v1/payanother/close
```

## **Interface parameters**

| Name       | location | Type   | Required | Description                                                       |
| ---------- | -------- | ------ | -------- | ----------------------------------------------------------------- |
| app\_id    | header   | string | Yes      | App ID, example value: `8e4b8c2e7cxxxxxxxx1a1cbd3d59e0bd`         |
| mch\_id    | body     | string | Yes      | Merchant ID, example value: `12345678`                            |
| payout\_id | body     | string | No       | Platform order, example value: `2a1cfa6568xxxxxxxx3050957024c559` |

**Parameters example**

```
{
  "app_id": "8e4b8c2e7cxxxxxxxx1a1cbd3d59e0bd",
  "mch_id": "12345678",
  "payout_id": "2a1cfa6568xxxxxxxx3050957024c559"
}
```

## **Interface return**

| Name        | Type    | Description                                                                  | Description |
| ----------- | ------- | ---------------------------------------------------------------------------- | ----------- |
| code        | integer | [Status code](https://ttpay.gitbook.io/api/v/english/error-code/status-code) | none        |
| msg         | string  | Status description                                                           | none        |
| request\_id | string  | Request ID                                                                   | none        |

## **Return example**

```
{
  "code": 0,
  "msg": "success",
  "request_id": "f23ade4a-e5ca-48f4-a4bb-59114ac360ba",
}
```

## **Example code**

{% tabs %}
{% tab title="Shell" %}

```sh
curl --location --request POST 'https://api.tokenpay.me/v1/payout/close' \
--header 'Authorization: <Authorization>' \
--header 'User-Agent: tokenpay API (https://tokenpay.me)' \
--header 'Content-Type: application/json' \
--data-raw '<body data here>'
```

{% endtab %}

{% tab title="Go" %}

```go
package main

import (
   "fmt"
   "strings"
   "net/http"
   "io/ioutil"
)

func main() {

   url := "https://api.tokenpay.me/v1/payout/close"
   method := "POST"

   payload := strings.NewReader(`<body data here>`)

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, payload)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("Authorization", "<Authorization>")
   req.Header.Add("User-Agent", "tokenpay API (https://tokenpay.me)")
   req.Header.Add("Content-Type", "application/json")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := ioutil.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.tokenpay.me/v1/payout/close',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'<body data here>',
   CURLOPT_HTTPHEADER => array(
      'Authorization: <Authorization>',
      'User-Agent: tokenpay API (https://tokenpay.me)',
      'Content-Type: application/json'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

{% endtab %}

{% tab title="Python" %}

```python
import http.client
import json

conn = http.client.HTTPSConnection("https://api.tokenpay.me")
payload = "<body data here>"
headers = {
   'Authorization': '<Authorization>',
   'User-Agent': 'tokenpay API (https://tokenpay.me)',
   'Content-Type': 'application/json'
}
conn.request("POST", "/v1/payout/close", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```java
OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "<body data here>");
Request request = new Request.Builder()
   .url("https://api.tokenpay.me/v1/payout/close")
   .method("POST", body)
   .addHeader("Authorization", "<Authorization>")
   .addHeader("User-Agent", "tokenpay API (https://tokenpay.me)")
   .addHeader("Content-Type", "application/json")
   .build();
Response response = client.newCall(request).execute();
```

{% endtab %}
{% endtabs %}
