Update payout method

Requisição

Updates a payout method.

Segurança

Bearer

Caminho

payout_method_idstring, (uuid)obrigatório

ID of the payout method you want to retrieve.

Corpoapplication/jsonobrigatório

payout_methodstringobrigatório

Unique string used in the quote to identify the payout method.

Exemplo:"LOCAL_RAILS"

descriptionstring

User defined description of a payout method.

Exemplo:"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"

Exemplo:"BOOK_TRANSFER"

estimated_time_to_creditobject

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

curl -i -X PUT \
  'https://docs.ripple.com/_mock/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/config/payout_methods/{payout_method_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
    }
  }'

Respostas

Successfully saved Payout method

Corpoapplication/json

payout_method_idstring, (uuid)

Unique identifier of a payout method.

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

payout_methodstring

Unique string to identify the payout method.