3. List Payout Methods

---

Payout Methods

The payout methods available for a client determine the options through which payments or transfers can be made to the final beneficiaries. These methods are obtained via the /accounts/routes endpoint, which returns a detailed dataset for each method.

Response from the /accounts/routes Endpoint

The typical response from this endpoint includes the following fields for each payout method:

• id: Unique identifier of the payout method.
• name: Descriptive name of the method.
• status: Current status of the method (e.g., ACTIVE, INACTIVE).
• country: Destination country for the payout method.
• currency: Currency in which the transaction can be made.
• minAmount: Minimum amount allowed for the transaction.
• maxAmount: Maximum amount allowed for the transaction.
• platformName: Name of the platform associated with the method; this field will be used to create a quote.
• limits: Specific limits for the method (daily, weekly, monthly).
• amounts: Accumulated amounts for the user on that payout method, organized by periods (daily, weekly, monthly).

Example Response

Below is an example of the structure of the response from the /accounts/routes endpoint:

[
  {
    "country": "VE",
    "currency": "VES",
    "id": 47,
    "name": "Mobile Payment",
    "status": "ACTIVE",
    "minAmount": 4000,
    "maxAmount": 4000000,
    "platformName": "P2P_PHONE_TRANSFER",
    "limits": {
      "dailyLimit": 20000000,
      "weeklyLimit": 200000000,
      "monthlyLimit": 2000000000
    },
    "amounts": {
      "dailyAmount": 0,
      "weeklyAmount": 0,
      "monthlyAmount": 3540000
    }
  },
  {
    "country": "CO",
    "currency": "COP",
    "id": 294,
    "name": "Cash Pickup",
    "status": "ACTIVE",
    "minAmount": 4000,
    "maxAmount": 4000000,
    "platformName": "CASH_PICKUP_CO",
    "limits": {
      "dailyLimit": 20000000,
      "weeklyLimit": 200000000,
      "monthlyLimit": 2000000000
    },
    "amounts": {
      "dailyAmount": 0,
      "weeklyAmount": 0,
      "monthlyAmount": 3540000
    }
  }
]