Payout Methods

Create a Payout Method

Changed on Nov 3, 2026

Creates a new payout method for a counterparty. This stores the payment details (bank account, blockchain address, etc.) that can be referenced when creating a payout within a payout requests.

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

Request

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

Path parameters

idstring uuid required

Counterparty ID

Headers

on-behalf-ofstring

Organization ID to act on behalf of

Request body

aliasstring required

Internal user-friendly alias name for this payout method

Example request

{
  "payoutMethod": {
    "details": {
      "intermediaryRoutingNumber": "021000021",
      "swiftBic": "DEUTDEFF"
    }
  }
}

Response

The successfully created 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

Example response

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

Changes

Nov 3, 202665aadbefe527 Revision changes
- breaking
  removed the enum value SOLANA of the request property //
- breaking
  added to the response body oneOf list for the response status
- breaking
  the response's body type changed from object to no type for status
- breaking
  added to the // response property oneOf list for the response status
- breaking
  added to the // response property oneOf list for the response status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  added the new AdditionalCounterpartyInformationRequired 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 new TRON enum value to the request property //
- info
  added to the // request property oneOf list
- info
  added to the // request property oneOf list
- info
  added response discriminator 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

Operation history