---
title: "Search Payout Methods"
method: POST
path: "/api/counterparties/{id}/payout-methods/search"
tags: ["Payout Methods"]
---

# Search Payout Methods

`POST /api/counterparties/{id}/payout-methods/search`

Search and retrieve payout methods for a specific counterparty.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `limit` number
- `nextId` string, uuid

## Headers

- `on-behalf-of` string

## Request body

- SearchPayoutMethodsRequestInfo
  - `filter` PayoutMethodAliasFilter — Filter payout methods by exact alias (case-insensitive).
    - `alias` string, required — The alias to match.
    - `type` 'alias', required

## Response `200`

Paginated list of payout methods

- PayoutMethodPaginatedResponse
  - `nextId` string, uuid — Cursor for fetching the next page of results
  - `results` PayoutMethodResponse[], required — List of payout methods
    - `alias` string, required — Internal user-friendly alias name for this payout method
    - `counterpartyId` string, uuid, required — ID of the counterparty this payout method belongs to
    - `createdAt` string, date-time, required — Timestamp when the payout method was created
    - `id` string, uuid, required — Unique identifier for the payout method
    - `payoutMethod` union, required — Payout method details including type and payment information
      - USDPayoutMethodInfo
        - `details` union, required
          - USDDomesticPayoutMethodResponseDetails
            - `accountType` 'CHECKING' | 'SAVINGS', required
            - `bankAccountNumberTruncated` string, required — Masked bank account number (format: ****1234)
            - `bankName` string, required
            - `bankRoutingNumberTruncated` string, required — Masked bank routing number (format: ****1234)
            - `symbol` 'USD', required
            - `transferType` 'ACH' | 'WIRE', required — Transfer type (ACH or WIRE)
            - `type` 'usdDomestic', required
          - USDPeruPayoutMethodResponseDetails
            - `accountType` 'CHECKING' | 'SAVINGS', required
            - `bankAccountNumberTruncated` string, required — Masked bank account number (format: ****1234)
            - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
            - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
            - `documentType` 'NATIONAL_ID' | 'PASSPORT' | 'RESIDENT_ID' | 'RUC' | 'TAX_ID', required
            - `symbol` 'USD', required
            - `type` 'usdPeru', required
          - USDChinaPayoutMethodResponseDetails
            - `accountType` 'CHECKING' | 'SAVINGS', required
            - `bankAccountNumberTruncated` string, required — Masked bank account number (format: ****1234)
            - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
            - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
            - `documentType` 'PASSPORT' | 'TAX_ID' | 'RESIDENT_ID', required
            - `phoneNumberTruncated` string, required — Masked phone number (format: ****1234)
            - `swiftBicTruncated` string, required — Masked SWIFT/BIC code (format: ****1234)
            - `symbol` 'USD', required
            - `type` 'usdChina', required
          - USDPanamaPayoutMethodResponseDetails
            - `accountType` 'CHECKING' | 'SAVINGS', required
            - `bankAccountNumberTruncated` string, required — Masked bank account number (format: ****1234)
            - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
            - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
            - `documentType` 'NATIONAL_ID' | 'RUC_NIT' | 'PASSPORT' | 'RESIDENT_ID', required
            - `symbol` 'USD', required
            - `type` 'usdPanama', required
          - USDHongKongPayoutMethodResponseDetails
            - `bankAccountNumberTruncated` string, required — Masked bank account number (format: ****1234)
            - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
            - `swiftBicTruncated` string, required — Masked SWIFT/BIC code (format: ****ABCD)
            - `symbol` 'USD', required
            - `type` 'usdHongKong', required
        - `type` 'usd', required
      - ARSPayoutMethodInfo
        - `details` union, required
          - ARSAliasPayoutMethodResponseDetails
            - `aliasTruncated` string, required — Masked bank account alias (format: ****1234)
            - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
            - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
            - `symbol` 'ARS', required
            - `type` 'arsAlias', required
          - ARSAccountNumberPayoutMethodResponseDetails
            - `bankAccountNumberTruncated` string, required — Masked bank account number (format: ****1234)
            - `bankAccountNumberType` 'CVU' | 'CBU', required — Type of bank account number (CVU or CBU)
            - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
            - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
            - `symbol` 'ARS', required
            - `type` 'arsAccountNumber', required
        - `type` 'ars', required
      - BRLPayoutMethodInfo
        - `details` union, required
          - BRLPixPhonePayoutMethodResponseDetails
            - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
            - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
            - `phoneNumberTruncated` string, required — Masked phone number (format: ****1234)
            - `symbol` 'BRL', required
            - `type` 'pixPhone', required
          - BRLPixEmailPayoutMethodResponseDetails
            - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
            - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
            - `emailTruncated` string, required — Masked email (format: ****1234)
            - `symbol` 'BRL', required
            - `type` 'pixEmail', required
          - BRLPixDocumentPayoutMethodResponseDetails
            - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
            - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
            - `symbol` 'BRL', required
            - `type` 'pixDocument', required
          - BRLPixBankAccountPayoutMethodResponseDetails
            - `bankAccountNumberTruncated` string, required — Masked bank account number (format: ****1234)
            - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
            - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
            - `symbol` 'BRL', required
            - `type` 'pixBankAccount', required
          - BRLWirePayoutMethodResponseDetails
            - `accountNumberTruncated` string, required — Masked account number (format: ****1234)
            - `accountType` 'CHECKING' | 'SAVINGS', required
            - `bankBranchTruncated` string, required — Masked bank branch (format: ****1234)
            - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
            - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
            - `symbol` 'BRL', required
            - `type` 'wire', required
        - `type` 'brl', required
      - COPPayoutMethodInfo
        - `details` union, required
          - COPDomesticPayoutMethodResponseDetails
            - `accountType` 'CHECKING' | 'SAVINGS', required
            - `bankAccountNumberTruncated` string, required — Masked bank account number (format: ****1234)
            - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
            - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
            - `documentType` 'NATIONAL_ID' | 'RUC_NIT' | 'PASSPORT' | 'RESIDENT_ID', required
            - `phoneNumberTruncated` string, required — Masked phone number (format: ****1234)
            - `symbol` 'COP', required
            - `type` 'copDomestic', required
          - COPBreBPayoutMethodResponseDetails
            - `keyValueTruncated` string, required — Masked Bre-B key value (format: ****1234)
            - `symbol` 'COP', required
            - `type` 'copBreB', required
        - `type` 'cop', required
      - EURPayoutMethodInfo
        - `details` EURSepaPayoutMethodResponseDetails, required
          - `bankName` string, required
          - `country` string, alpha2 codes, required
          - `ibanTruncated` string, required — Masked IBAN (format: ****1234)
          - `swiftBicTruncated` string, required — Masked SWIFT/BIC code (format: ****1234)
          - `symbol` 'EUR', required
          - `type` 'eurSepa', required
        - `type` 'eur', required
      - MXNPayoutMethodInfo
        - `details` MXNDomesticPayoutMethodResponseDetails, required
          - `bankAccountNumberTruncated` string, required — Masked bank account number (format: ****1234)
          - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
          - `symbol` 'MXN', required
          - `type` 'mxnDomestic', required
        - `type` 'mxn', required
      - CLPPayoutMethodInfo
        - `details` CLPDomesticPayoutMethodResponseDetails, required
          - `accountType` 'CHECKING' | 'SAVINGS', required
          - `bankAccountNumberTruncated` string, required — Masked bank account number (format: ****1234)
          - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
          - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
          - `documentType` 'NATIONAL_ID' | 'PASSPORT' | 'RESIDENT_ID' | 'RUC' | 'TAX_ID', required
          - `symbol` 'CLP', required
          - `type` 'clpDomestic', required
        - `type` 'clp', required
      - PENPayoutMethodInfo
        - `details` PENDomesticPayoutMethodResponseDetails, required
          - `accountType` 'CHECKING' | 'SAVINGS', required
          - `bankAccountNumberTruncated` string, required — Masked bank account number (format: ****1234)
          - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
          - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
          - `documentType` 'NATIONAL_ID' | 'PASSPORT' | 'RESIDENT_ID' | 'RUC' | 'TAX_ID', required
          - `symbol` 'PEN', required
          - `type` 'penDomestic', required
        - `type` 'pen', required
      - BOBPayoutMethodInfo
        - `details` BOBDomesticPayoutMethodResponseDetails, required
          - `bankAccountNumberTruncated` string, required — Masked bank account number (format: ****1234)
          - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
          - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
          - `documentType` 'NATIONAL_ID' | 'RUC_NIT' | 'RESIDENT_ID', required
          - `symbol` 'BOB', required
          - `type` 'bobDomestic', required
        - `type` 'bob', required
      - CRCPayoutMethodInfo
        - `details` CRCDomesticPayoutMethodResponseDetails, required
          - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
          - `documentNumberTruncated` string, required — Masked document number (format: ****1234)
          - `documentType` 'NATIONAL_ID' | 'PASSPORT' | 'RESIDENT_ID' | 'RUC' | 'TAX_ID', required
          - `ibanTruncated` string, required — Masked IBAN (format: ****1234)
          - `symbol` 'CRC', required
          - `type` 'crcDomestic', required
        - `type` 'crc', required
      - ZARPayoutMethodInfo
        - `details` ZARDomesticPayoutMethodResponseDetails, required
          - `accountType` 'CHECKING' | 'SAVINGS', required
          - `bankAccountNumberTruncated` string, required — Masked bank account number (format: ****1234)
          - `bankId` string, required — Bank ID from the /counterparties/payment-methods/supported-banks endpoint
          - `symbol` 'ZAR', required
          - `type` 'zarDomestic', required
        - `type` 'zar', required
      - BlockchainPayoutMethodInfo
        - `details` BlockchainPayoutMethodResponseDetails, required
          - `blockchain` 'ETHEREUM' | 'POLYGON' | 'BASE' | 'CELO' | 'PLASMA' | 'SOLANA', required — The blockchain network. SOLANA is only returned for wallets registered on the USD payout path.
          - `walletAddress` string, required — The wallet address for blockchain payouts
        - `type` 'blockchainWallet', required
  - `total` number, required — Total number of payout methods matching the filter

## Other responses

- `401` — Unauthorized
- `403` — SignedAgreementRequiredException

---

[API](https://skmtc.net/muralpay/apis/mural-api.md) · [All operations](https://skmtc.net/muralpay/apis/mural-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/muralpay/mural-api/versions/437d277f5948/schema)