Payout Methods

Get a Payout Method

Retrieves a single payout method by ID for a counterparty.

get/api/counterparties/{id}/payout-methods/{payoutMethodId}

Request

Base URL
https://api.muralpay.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/muralpay/apis/mural-api/docs/api/counterparties/:id/payout-methods/:payoutMethodId/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

Counterparty ID

payoutMethodIdstring uuid required

Payout Method ID

on-behalf-ofstring

Organization ID to act on behalf of

The requested payout method

aliasstring required

Internal user-friendly alias name for this payout method

counterpartyIdstring uuid required

ID of the counterparty this payout method belongs to

createdAtstring date-time required

Timestamp when the payout method was created

idstring uuid required

Unique identifier for the payout method

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