MUmuralpay
Payout Methods

Search Payout Methods

Changed on

Search and retrieve payout methods for a specific counterparty.

post/api/counterparties/{id}/payout-methods/search

Request

Path parameters

idstring uuid required

Counterparty ID

Query parameters

limitnumber
nextIdstring uuid

Headers

on-behalf-ofstring

Organization ID to act on behalf of

Request body

Response

Paginated list of payout methods

nextIdstring uuid

Cursor for fetching the next page of results

totalnumber required

Total number of payout methods matching the filter

Example response

{
  "results": [
    {
      "payoutMethod": {
        "details": {
          "bankAccountNumberTruncated": "****1234",
          "bankRoutingNumberTruncated": "****0021"
        }
      }
    }
  ]
}

Changes

  • 65aadbefe527Revision changes
    • breaking

      added to the //// response property oneOf list for the response status

    • breaking

      added to the //// response property oneOf list for the response status

    • warning

      added the new SignedAgreementRequiredException enum value to the response property for the response status

    • warning

      added the new TRON enum value to the ///// response property for the response status

    • info

      added the non-success response with the status

    • info

      removed the SOLANA enum value from the ///// response property for the response status