MUmuralpay
Counterparties

Create a Counterparty

Changed on

Creates a new counterparty (recipient) that can be referenced in future payouts. The counterparty information is stored and can be reused across multiple payout requests.

post/api/counterparties

Request

Headers

on-behalf-ofstring

Organization ID to act on behalf of

Request body

Example request

{
  "counterparty": {
    "physicalAddress": {
      "address1": "123 Main Street",
      "address2": "Suite 400",
      "city": "New York",
      "country": "US",
      "postalCode": "10001",
      "subDivision": "NY"
    }
  }
}

Response

The successfully created counterparty

OR

Changes

  • 65aadbefe527Revision changes
    • warning

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

    • info

      added the non-success response with the status