---
title: "Create payout method"
method: POST
path: "/config/payout_methods"
tags: ["Payout method"]
---

# Create payout method

`POST /config/payout_methods`

Creates a payout method (for example, `LOCAL_RAILS`). <p>The Payout Method API lets receivers create and manage payout methods. Senders can generate quotes based on these receiver payout methods by enabling the flag <code>enable_quote_per_payout_method</code> in the body of the [Create quote collection] request. </p><p><b>Caution&#58;</b> The existing quote parameter is named <code>payment_method</code> while elsewhere it is <code>payout_method</code>.</p><p><b>Note&#58;</b> On-Demand Liquidity (ODL) receivers should set <code>payment_method</code> to the <code>outlet_id</code> or the string <code>none</code> (not an empty value) to keep funds at the destination exchange when paying out to a local rail.</p>

## Request body

- PayoutMethodRequest — Represents a request to create and update a payout method record.
  - `payout_method` string, required — Unique string used in the quote to identify the payout method.
  - `description` string — User defined description of a payout method.
  - `is_default` boolean — Flag to set this payout method as the default payout method.
  - `payout_method_category` 'REAL_TIME_GROSS_SETTLEMENT_SYSTEM' | 'REAL_TIME_NET_SETTLEMENT_SYSTEM' | 'MASS_NET_PAYMENT_SYSTEM' | 'BOOK_TRANSFER' | 'CASH_PAYOUT' | 'WALLET_PAYMENT' | 'OTHER' — Category of the payout method. Defaults to <code>OTHER</code> if not specified.
  - `estimated_time_to_credit` object — The estimated time to credit the beneficiary using this payout method.
    - `time_value` integer, required — The amount of estimated time to credit.
    - `time_unit` 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS', required — Unit of the estimated time to credit: <code>SECONDS</code>, <code>MINUTES</code>, <code>HOURS</code>, <code>DAYS</code>.

## Response `200`

Successfully created payout method.

- PayoutMethodResponse — Represents a request to create and update a payout method record.
  - `payout_method_id` string, uuid — Unique identifier of a payout method.
  - `payout_method` string — Unique string to identify the payout method.
  - `description` string — User defined description of a payout method.
  - `is_default` boolean — Flag to set this payout method as the default payout method.
  - `payout_method_category` 'REAL_TIME_GROSS_SETTLEMENT_SYSTEM' | 'REAL_TIME_NET_SETTLEMENT_SYSTEM' | 'MASS_NET_PAYMENT_SYSTEM' | 'BOOK_TRANSFER' | 'CASH_PAYOUT' | 'WALLET_PAYMENT' | 'OTHER' — Category of the payout method. Defaults to <code>OTHER</code> if not specified.
  - `estimated_time_to_credit` object — The estimated time to credit the beneficiary using this payout method.
    - `time_value` integer, required — The amount of estimated time to credit.
    - `time_unit` 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS', required — Unit of the estimated time to credit: <code>SECONDS</code>, <code>MINUTES</code>, <code>HOURS</code>, <code>DAYS</code>.

## Other responses

- `400` — Bad request.

---

[API](https://skmtc.net/ripple/apis/ripplenet-server-api.md) · [All operations](https://skmtc.net/ripple/apis/ripplenet-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripplenet-server-api/revisions/7843f07ca150/schema)