v1

latestOpenAPI 3.0.02026-07-2464438356.8 KB
Payout Methods

Search Payout Methods

Search and retrieve payout methods for a specific counterparty.

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

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"
        }
      }
    }
  ]
}