> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.useroot.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.useroot.com/_mcp/server.

# Approve single payout

POST https://api.useroot.com/api/payouts/{payout_id}/approve

Approves a single payout in **CREATED** status and starts bank processing. The payout must belong to your entity.

**Response body**

| Field | Type | Description |
|-------|------|-------------|
| `data` | Object | The payout object (`status` reflects the state at response time) |
| `warning` | String | Present on **207** when initiation had a recoverable issue |

**Success responses**

| Status Code | Description |
|-------------|-------------|
| **201** | The payout was approved and processing continued; **`data.status`** reflects the outcome of this request. |
| **202** | The request was accepted and **`data`** includes the payout, but **`data.status`** may still change. Poll **`GET /api/payouts/{id}`** (or your usual list/events flow) until the payout reaches a terminal status. |
| **207** | The payout was approved but initiation did not complete successfully; see **`warning`** and **`data.status`**. |

**Error and retry responses**

| Status Code | Error code | Description |
|-------------|------------|-------------|
| **400** | (see response) | The payout cannot be approved in its current state. |
| **404** | (see response) | Payout not found for this entity. |
| **503** | (see response body) | **Transient error**—bank initiation did not complete for this request. **Retry** the same approve call after a short wait. The JSON body includes `error_code` and `message` for logging and automation. |

**Notes**

- Treat **202** like any accepted operation: use the returned id and **poll** until status stabilizes.
- **503** is for **retries**, not a final business outcome for the transfer.

Reference: https://docs.useroot.com/api-reference/payouts-api/approve-payout

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: '[Code Generated] Root - Instant Account to Account Money Movement'
  version: 1.0.0
paths:
  /api/payouts/{payout_id}/approve:
    post:
      operationId: approve-payout
      summary: Approve single payout
      description: >-
        Approves a single payout in **CREATED** status and starts bank
        processing. The payout must belong to your entity.


        **Response body**


        | Field | Type | Description |

        |-------|------|-------------|

        | `data` | Object | The payout object (`status` reflects the state at
        response time) |

        | `warning` | String | Present on **207** when initiation had a
        recoverable issue |


        **Success responses**


        | Status Code | Description |

        |-------------|-------------|

        | **201** | The payout was approved and processing continued;
        **`data.status`** reflects the outcome of this request. |

        | **202** | The request was accepted and **`data`** includes the payout,
        but **`data.status`** may still change. Poll **`GET /api/payouts/{id}`**
        (or your usual list/events flow) until the payout reaches a terminal
        status. |

        | **207** | The payout was approved but initiation did not complete
        successfully; see **`warning`** and **`data.status`**. |


        **Error and retry responses**


        | Status Code | Error code | Description |

        |-------------|------------|-------------|

        | **400** | (see response) | The payout cannot be approved in its
        current state. |

        | **404** | (see response) | Payout not found for this entity. |

        | **503** | (see response body) | **Transient error**—bank initiation
        did not complete for this request. **Retry** the same approve call after
        a short wait. The JSON body includes `error_code` and `message` for
        logging and automation. |


        **Notes**


        - Treat **202** like any accepted operation: use the returned id and
        **poll** until status stabilizes.

        - **503** is for **retries**, not a final business outcome for the
        transfer.
      tags:
        - payoutsApi
      parameters:
        - name: payout_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: x-api-key
          in: header
          description: >-
            RootPay API key sent in the x-api-key header. Keys are
            environment-scoped: live_* for production, test_* for sandbox.
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Payout approved and initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovePayoutResponse'
        '404':
          description: Payout not found
          content:
            application/json:
              schema:
                description: Any type
        '503':
          description: >-
            Payout approved, but bank initiation could not be started—retry
            later
          content:
            application/json:
              schema:
                description: Any type
servers:
  - url: https://api.useroot.com
    description: Production
components:
  schemas:
    CurrencyCode:
      type: string
      enum:
        - USD
        - GBP
        - INR
      title: CurrencyCode
    CountryCode:
      type: string
      enum:
        - US
        - GB
        - IN
      title: CountryCode
    Rails:
      type: string
      enum:
        - instant_card
        - instant_bank
        - same_day_ach
        - standard_ach
        - wire
        - '{''instant_card'', ''instant_bank''}'
        - '{''same_day_ach'', ''standard_ach''}'
        - '{''standard_ach'', ''wire''}'
      title: Rails
    TransferStatus:
      type: string
      enum:
        - created
        - approved
        - initiated
        - debited
        - settled
        - failed
        - canceled
        - needs_review
        - processing
      description: |-
        Unified status enum for all transfer types (payins and payouts).

        This is the single source of truth for all transfer statuses.
        Replaces both PayinExternalStatus/PayinInternalStatus and PayoutStatus.
      title: TransferStatus
    PayoutResponse:
      type: object
      properties:
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        id:
          type: string
          format: uuid
        payee_id:
          type: string
          format: uuid
        amount_in_cents:
          type: integer
          description: >-
            Deprecated. Use amount_in_minor_units instead. Still accepted and
            returned for backward compatibility.
        amount_in_minor_units:
          type: integer
          description: Amount in the currency's minor units (e.g. cents for USD).
        currency_code:
          $ref: '#/components/schemas/CurrencyCode'
        country_code:
          $ref: '#/components/schemas/CountryCode'
        rail:
          $ref: '#/components/schemas/Rails'
        payout_metadata:
          type: object
          additionalProperties:
            description: Any type
        status:
          $ref: '#/components/schemas/TransferStatus'
        status_recorded_at:
          type: string
          format: date-time
        client_metadata:
          type: object
          additionalProperties:
            type: string
      required:
        - created_at
        - updated_at
        - id
        - payee_id
        - amount_in_cents
        - amount_in_minor_units
        - currency_code
        - country_code
        - rail
        - payout_metadata
        - status
        - status_recorded_at
      title: PayoutResponse
    ApprovePayoutResponse:
      type: object
      properties:
        data:
          oneOf:
            - $ref: '#/components/schemas/PayoutResponse'
            - type: 'null'
        warning:
          type:
            - string
            - 'null'
      description: Response model for single payout approval.
      title: ApprovePayoutResponse
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        RootPay API key sent in the x-api-key header. Keys are
        environment-scoped: live_* for production, test_* for sandbox.

```

## Examples

### Example 1



**Request**

```json
{}
```

**Response**

```json
{
  "data": {
    "created_at": "2024-04-20T14:45:00Z",
    "updated_at": "2024-04-20T14:46:30Z",
    "id": "a3f1c9e2-7b4d-4f8a-9c2e-1d2b3f4a5e6f",
    "payee_id": "d9b8f7a6-1234-4c56-8e9f-0a1b2c3d4e5f",
    "amount_in_minor_units": 25000,
    "currency_code": "USD",
    "country_code": "US",
    "rail": "instant_card",
    "payout_metadata": {
      "invoice_id": "INV-20240420-001",
      "notes": "April vendor payout"
    },
    "status": "approved",
    "status_recorded_at": "2024-04-20T14:46:30Z",
    "amount_in_cents": 25000,
    "client_metadata": {
      "request_id": "req_789xyz",
      "source": "dashboard"
    }
  },
  "warning": null
}
```

**SDK Code**

```python
import requests

url = "https://api.useroot.com/api/payouts/payout_id/approve"

payload = {}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.useroot.com/api/payouts/payout_id/approve';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.useroot.com/api/payouts/payout_id/approve"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

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

url = URI("https://api.useroot.com/api/payouts/payout_id/approve")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.useroot.com/api/payouts/payout_id/approve")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.useroot.com/api/payouts/payout_id/approve', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.useroot.com/api/payouts/payout_id/approve");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.useroot.com/api/payouts/payout_id/approve")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```

### Example 2



**Request**

```json
{}
```

**Response**

```json
{
  "data": {
    "created_at": "2024-04-20T14:45:00Z",
    "updated_at": "2024-04-20T14:46:30Z",
    "id": "a3f1c9e2-7b4d-4f8a-9c2e-1d2b3f4a5e6f",
    "payee_id": "d9b8f7a6-1234-4c56-8e9f-0a1b2c3d4e5f",
    "amount_in_minor_units": 25000,
    "currency_code": "USD",
    "country_code": "US",
    "rail": "instant_card",
    "payout_metadata": {
      "invoice_id": "INV-20240420-001",
      "notes": "April vendor payout"
    },
    "status": "approved",
    "status_recorded_at": "2024-04-20T14:46:30Z",
    "amount_in_cents": 25000,
    "client_metadata": {
      "request_id": "req_789xyz",
      "source": "dashboard"
    }
  },
  "warning": null
}
```

**SDK Code**

```python
import requests

url = "https://api.useroot.com/api/payouts/payout_id/approve"

payload = {}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.useroot.com/api/payouts/payout_id/approve';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.useroot.com/api/payouts/payout_id/approve"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

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

url = URI("https://api.useroot.com/api/payouts/payout_id/approve")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.useroot.com/api/payouts/payout_id/approve")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.useroot.com/api/payouts/payout_id/approve', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.useroot.com/api/payouts/payout_id/approve");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.useroot.com/api/payouts/payout_id/approve")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```

### Example 3



**Request**

```json
{}
```

**Response**

```json
{
  "data": {
    "created_at": "2024-04-20T14:45:00Z",
    "updated_at": "2024-04-20T14:46:30Z",
    "id": "a3f1c9e2-7b4d-4f8a-9c2e-1d2b3f4a5e6f",
    "payee_id": "d9b8f7a6-1234-4c56-8e9f-0a1b2c3d4e5f",
    "amount_in_minor_units": 25000,
    "currency_code": "USD",
    "country_code": "US",
    "rail": "instant_card",
    "payout_metadata": {
      "invoice_id": "INV-20240420-001",
      "notes": "April vendor payout"
    },
    "status": "approved",
    "status_recorded_at": "2024-04-20T14:46:30Z",
    "amount_in_cents": 25000,
    "client_metadata": {
      "request_id": "req_789xyz",
      "source": "dashboard"
    }
  },
  "warning": null
}
```

**SDK Code**

```python
import requests

url = "https://api.useroot.com/api/payouts/payout_id/approve"

payload = {}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.useroot.com/api/payouts/payout_id/approve';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.useroot.com/api/payouts/payout_id/approve"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

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

url = URI("https://api.useroot.com/api/payouts/payout_id/approve")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.useroot.com/api/payouts/payout_id/approve")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.useroot.com/api/payouts/payout_id/approve', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.useroot.com/api/payouts/payout_id/approve");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.useroot.com/api/payouts/payout_id/approve")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```