Payout Methods

Archive a Payout Method

Changed on

Archives a payout method. The payout method will no longer be available for use in new payouts.

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

Request

Path parameters

idstring uuid required

Counterparty ID

payoutMethodIdstring uuid required

Payout Method ID

Headers

on-behalf-ofstring

Organization ID to act on behalf of

Response

Payout method archived successfully

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