Payout method

Payout Method operations let receivers create and manage payout methods. Senders can generate quotes based on these receiver payout methods.

Operation	Method	Description
Create payout method	POST	Creates a payout method. For example, `LOCAL_RAILS`.
Get payout methods	GET	Returns a list of payout methods created by a receiving partner.
Get payout method by ID	GET	Returns a payout method by its ID.
Update payout method	PUT	Updates a payout method.
Delete payout method	DELETE	Deletes a payout method.
Get all categories	GET	Returns all the payout method categories.

Operações

Create payout method

Requisição

Creates a payout method (for example, LOCAL_RAILS).

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 enable_quote_per_payout_method in the body of the [Create quote collection] request.

Caution: The existing quote parameter is named payment_method while elsewhere it is payout_method.

Note: On-Demand Liquidity (ODL) receivers should set payment_method to the outlet_id or the string none (not an empty value) to keep funds at the destination exchange when paying out to a local rail.

Segurança

Bearer

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 POST \
  https://docs.ripple.com/_mock/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/config/payout_methods \
  -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 created 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.