The PayoutMethod object

Describes an available payout method and its constraints. Use this information to display available payout options to users and validate payout requests.

Fields

Field	Type	Description
id REQUIRED	string	Unique identifier for the payout method
type REQUIRED	'bank_transfer'| 'upi'| 'wallet'| 'crypto'	Type of payout method
name REQUIRED	string	Display name for the payout method
currencies REQUIRED	string[]	Currencies supported by this payout method
countries REQUIRED	string[]	Countries where this payout method is available
minAmount OPTIONAL	number	Minimum payout amount (in smallest currency unit)
maxAmount OPTIONAL	number	Maximum payout amount (in smallest currency unit)
processingTime OPTIONAL	string	Estimated processing time (e.g., '1-2 business days')
fees OPTIONAL	{ /** Fixed fee amount per payout */ fixed?: number /** Percentage fee (e.g., 0.5 for 0.5%) */ percentage?: number }	Fee structure for this payout method

Example

{
  "id": "obj_1a2b3c",
  "type": "bank_transfer",
  "name": "string",
  "currencies": [],
  "countries": [],
  "minAmount": 5000,
  "maxAmount": 5000,
  "processingTime": "string"
}