v1

latestOpenAPI 3.0.02026-07-2464438356.8 KB

Payout Methods

Get Bank Requirements for Payout Method Types

Returns bank selection requirements for specified payout method types (rails). If the payment method type requires a specific bank, you'll be required to provide a bankId.

get/api/counterparties/payment-methods/supported-banks

Query parameters

payoutMethodTypesstring[] required

Payout method types (rails) to get bank requirements for. These are the discriminator values used in payout method creation (e.g., "usdPeru", "brlPixPhone", "usdDomestic").

Response

Map of payout method types to their bank selection requirements. Only the payout method types specified in the request will be present in the response.

Example response

{
  "arsAccountNumber": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "arsAlias": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "bobDomestic": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "clpDomestic": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "copBreB": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "copCobreBalance": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "copDomestic": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "crcDomestic": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "eurSepa": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "mxnDomestic": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "penDomestic": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "pixBankAccount": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "pixDocument": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "pixEmail": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "pixPhone": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "usdChina": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "usdDomestic": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "usdHongKong": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "usdPanama": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "usdPeru": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "wire": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  },
  "zarDomestic": {
    "banks": [
      {
        "id": "bank_usd_peru_002",
        "name": "Banco de Crédito del Perú"
      }
    ]
  }
}