> 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.

# Get payout by ID

GET https://api.useroot.com/api/payouts/{payout_id}

Retrieves detailed information about a specific payout by its unique identifier. This endpoint returns the complete payout object including current status and payout-metadata.

**Path Parameters**

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payout_id` | UUID | Yes | Unique identifier of the payout to retrieve |


**Success Responses**

| Status Code | Description |
|-------------|-------------|
| 200 | OK - The payout was successfully retrieved |

**Error Responses**

| Status Code | Error Code | Description |
|-------------|------------|-------------|
| 401 | AUTHENTICATION_ERROR | Authentication credentials are invalid or missing |
| 403 | AUTHORIZATION_ERROR | You do not have permission to perform this action |
| 404 | NOT_FOUND | The specified payout was not found |

Reference: https://docs.useroot.com/api-reference/payouts-api/get-payout-by-id

## 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}:
    get:
      operationId: get-payout-by-id
      summary: Get payout by ID
      description: >-
        Retrieves detailed information about a specific payout by its unique
        identifier. This endpoint returns the complete payout object including
        current status and payout-metadata.


        **Path Parameters**


        | Parameter | Type | Required | Description |

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

        | `payout_id` | UUID | Yes | Unique identifier of the payout to retrieve
        |



        **Success Responses**


        | Status Code | Description |

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

        | 200 | OK - The payout was successfully retrieved |


        **Error Responses**


        | Status Code | Error Code | Description |

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

        | 401 | AUTHENTICATION_ERROR | Authentication credentials are invalid or
        missing |

        | 403 | AUTHORIZATION_ERROR | You do not have permission to perform this
        action |

        | 404 | NOT_FOUND | The specified payout was not found |
      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:
        '200':
          description: Payout retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response_PayoutResponse_'
        '400':
          description: Invalid payout data
          content:
            application/json:
              schema:
                description: Any type
        '404':
          description: Payout not found
          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
    Response_PayoutResponse_:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PayoutResponse'
        warning:
          type:
            - string
            - 'null'
      required:
        - data
      title: Response_PayoutResponse_
  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

### Created payout



**Response**

```json
{
  "data": {
    "created_at": "2024-03-20T12:00:00Z",
    "updated_at": "2024-03-20T12:00:00Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "payee_id": "123e4567-e89b-12d3-a456-426614174001",
    "amount_in_minor_units": 10000,
    "currency_code": "USD",
    "country_code": "US",
    "rail": "instant_bank",
    "payout_metadata": {
      "payment_method": {
        "account_last_four": "7890",
        "routing_number": "021000021"
      },
      "payee": {
        "name": "Jane Doe",
        "email": "jane.doe@example.com"
      }
    },
    "status": "created",
    "status_recorded_at": "2024-03-20T12:00:00Z",
    "amount_in_cents": 10000
  }
}
```

**SDK Code**

```python Created payout
import requests

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

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Created payout
const url = 'https://api.useroot.com/api/payouts/payout_id';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

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

```go Created payout
package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

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

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

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

}
```

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

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

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

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

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

HttpResponse<String> response = Unirest.get("https://api.useroot.com/api/payouts/payout_id")
  .header("x-api-key", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.useroot.com/api/payouts/payout_id', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp Created payout
using RestSharp;

var client = new RestClient("https://api.useroot.com/api/payouts/payout_id");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Created payout
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.useroot.com/api/payouts/payout_id")! 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()
```

### Initiated payout



**Response**

```json
{
  "data": {
    "created_at": "2024-03-20T12:00:00Z",
    "updated_at": "2024-03-20T12:00:00Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "payee_id": "123e4567-e89b-12d3-a456-426614174001",
    "amount_in_minor_units": 10000,
    "currency_code": "USD",
    "country_code": "US",
    "rail": "instant_bank",
    "payout_metadata": {
      "payment_method": {
        "account_last_four": "7890",
        "routing_number": "021000021",
        "end_to_end_id": "RTP20240320123456789"
      },
      "payee": {
        "name": "Jane Doe",
        "email": "jane.doe@example.com"
      }
    },
    "status": "initiated",
    "status_recorded_at": "2024-03-20T12:01:00Z",
    "amount_in_cents": 10000
  }
}
```

**SDK Code**

```python Initiated payout
import requests

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

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Initiated payout
const url = 'https://api.useroot.com/api/payouts/payout_id';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

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

```go Initiated payout
package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

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

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

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

}
```

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

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

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

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

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

HttpResponse<String> response = Unirest.get("https://api.useroot.com/api/payouts/payout_id")
  .header("x-api-key", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.useroot.com/api/payouts/payout_id', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp Initiated payout
using RestSharp;

var client = new RestClient("https://api.useroot.com/api/payouts/payout_id");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Initiated payout
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.useroot.com/api/payouts/payout_id")! 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()
```

### Card payout



**Response**

```json
{
  "data": {
    "created_at": "2024-03-20T12:00:00Z",
    "updated_at": "2024-03-20T12:00:00Z",
    "id": "123e4567-e89b-12d3-a456-426614174002",
    "payee_id": "123e4567-e89b-12d3-a456-426614174001",
    "amount_in_minor_units": 10000,
    "currency_code": "USD",
    "country_code": "US",
    "rail": "instant_card",
    "payout_metadata": {
      "payment_method": {
        "card_last_four": "1111",
        "card_expiry_date": "2512"
      },
      "payee": {
        "name": "Jane Doe",
        "email": "jane.doe@example.com"
      }
    },
    "status": "created",
    "status_recorded_at": "2024-03-20T12:00:00Z",
    "amount_in_cents": 10000
  }
}
```

**SDK Code**

```python Card payout
import requests

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

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Card payout
const url = 'https://api.useroot.com/api/payouts/payout_id';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

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

```go Card payout
package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

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

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

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

}
```

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

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

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

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

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

HttpResponse<String> response = Unirest.get("https://api.useroot.com/api/payouts/payout_id")
  .header("x-api-key", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.useroot.com/api/payouts/payout_id', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp Card payout
using RestSharp;

var client = new RestClient("https://api.useroot.com/api/payouts/payout_id");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Card payout
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.useroot.com/api/payouts/payout_id")! 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()
```

### Approved card payout



**Response**

```json
{
  "data": {
    "created_at": "2024-03-20T12:00:00Z",
    "updated_at": "2024-03-20T12:00:00Z",
    "id": "123e4567-e89b-12d3-a456-426614174002",
    "payee_id": "123e4567-e89b-12d3-a456-426614174001",
    "amount_in_minor_units": 10000,
    "currency_code": "USD",
    "country_code": "US",
    "rail": "instant_card",
    "payout_metadata": {
      "payment_method": {
        "card_last_four": "1111",
        "card_expiry_date": "2512",
        "end_to_end_id": "CARD20240320123456789"
      },
      "payee": {
        "name": "Jane Doe",
        "email": "jane.doe@example.com"
      }
    },
    "status": "initiated",
    "status_recorded_at": "2024-03-20T12:01:00Z",
    "amount_in_cents": 10000
  }
}
```

**SDK Code**

```python Approved card payout
import requests

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

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Approved card payout
const url = 'https://api.useroot.com/api/payouts/payout_id';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

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

```go Approved card payout
package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

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

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

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

}
```

```ruby Approved card payout
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

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

```java Approved card payout
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.useroot.com/api/payouts/payout_id")
  .header("x-api-key", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.useroot.com/api/payouts/payout_id', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp Approved card payout
using RestSharp;

var client = new RestClient("https://api.useroot.com/api/payouts/payout_id");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Approved card payout
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.useroot.com/api/payouts/payout_id")! 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()
```

### Payout from subaccount



**Response**

```json
{
  "data": {
    "created_at": "2024-03-20T12:00:00Z",
    "updated_at": "2024-03-20T12:00:00Z",
    "id": "123e4567-e89b-12d3-a456-426614174005",
    "payee_id": "123e4567-e89b-12d3-a456-426614174001",
    "amount_in_minor_units": 5000,
    "currency_code": "USD",
    "country_code": "US",
    "rail": "instant_bank",
    "payout_metadata": {
      "payment_method": {
        "account_last_four": "7890",
        "routing_number": "021000021"
      },
      "payee": {
        "name": "Jane Doe",
        "email": "jane.doe@example.com"
      }
    },
    "status": "created",
    "status_recorded_at": "2024-03-20T12:00:00Z",
    "amount_in_cents": 5000,
    "subaccount_id": "456e7890-e89b-12d3-a456-426614174000"
  }
}
```

**SDK Code**

```python Payout from subaccount
import requests

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

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Payout from subaccount
const url = 'https://api.useroot.com/api/payouts/payout_id';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

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

```go Payout from subaccount
package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

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

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

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

}
```

```ruby Payout from subaccount
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

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

```java Payout from subaccount
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.useroot.com/api/payouts/payout_id")
  .header("x-api-key", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.useroot.com/api/payouts/payout_id', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp Payout from subaccount
using RestSharp;

var client = new RestClient("https://api.useroot.com/api/payouts/payout_id");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Payout from subaccount
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.useroot.com/api/payouts/payout_id")! 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()
```