Get payout method by ID

Request

Returns a payout method by its ID.

Security

Bearer

Path

payout_method_idstring, (uuid)required

ID of the payout method you want to retrieve.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/config/payout_methods/{payout_method_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned Payout method

Bodyapplication/json

payout_method_idstring, (uuid)

Unique identifier of a payout method.

Example:"a6dbe002-ca7f-4ec7-89e4-f44a1971a0c0"

payout_methodstring

Unique string to identify the payout method.

Example:"LOCAL_RAILS"

descriptionstring

User defined description of a payout method.

Example:"local rails"

is_defaultboolean

Flag to set this payout method as the default payout method.

payout_method_categorystring

Category of the payout method. Defaults to OTHER if not specified.

Enum:"REAL_TIME_GROSS_SETTLEMENT_SYSTEM""REAL_TIME_NET_SETTLEMENT_SYSTEM""MASS_NET_PAYMENT_SYSTEM""BOOK_TRANSFER""CASH_PAYOUT""WALLET_PAYMENT""OTHER"

Example:"BOOK_TRANSFER"

estimated_time_to_creditobject

The estimated time to credit the beneficiary using this payout method.

Response

{
  "payout_method_id": "a6dbe002-ca7f-4ec7-89e4-f44a1971a0c0",
  "payout_method": "LOCAL_RAILS",
  "description": "local rails",
  "is_default": true,
  "payout_method_category": "BOOK_TRANSFER",
  "estimated_time_to_credit": {
    "time_value": 5,
    "time_unit": "SECONDS"
  }
}