Sign in

v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB
Payout method

Create payout method

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:</b> The existing quote parameter is named <code>payment_method</code> while elsewhere it is <code>payout_method</code>.</p><p><b>Note:</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>

post/config/payout_methods

Request body

payout_methodstring required

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

descriptionstring

User defined description of a payout method.

is_defaultboolean

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.

Example request

{
  "payout_method": "LOCAL_RAILS",
  "description": "local rails",
  "payout_method_category": "BOOK_TRANSFER",
  "estimated_time_to_credit": {
    "time_value": 5
  }
}

Response

Successfully created payout method.

payout_method_idstring uuid

Unique identifier of a payout method.

payout_methodstring

Unique string to identify the payout method.

descriptionstring

User defined description of a payout method.

is_defaultboolean

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.

Example response

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