---
title: "Get payout methods"
method: GET
path: "/config/payout_methods"
tags: ["Payout method"]
---

# Get payout methods

`GET /config/payout_methods`

Returns a list of payout methods created by a receiving partner.

## Query parameters

- `page` integer
- `size` integer

## Response `200`

- PayoutMethods — Paginated response base object.
  - `first` boolean — true if this is the first page.
  - `last` boolean — true if this is the last page.
  - `number` integer — page number
  - `numberOfElements` integer — Number Of elements in this request
  - `size` integer — page size
  - `totalElements` integer — Total number of elements for the given request
  - `totalPages` integer — Total number of pages for the given request
  - `sort` Sort[] — Sort details of this page
    - `direction` string — Direction of the sort
    - `property` string
    - `ignoreCase` boolean
    - `nullHandling` string
    - `ascending` boolean
    - `descending` boolean
  - `content` PayoutMethodResponse[]
    - `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)