Update Payment Medium

Update a custom settlement type. Updating the name will cascade to all existing payments.

put/admin/payment-mediums/update/{name}

Path parameters

namestring required

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

namestring nullable

The name of the custom settlement type.

isArchivedboolean nullable

Whether to archive/unarchive the payment medium.

Successful Response

namestring required

The name/identifier of the payment medium (primary key).

isSystemboolean required

Whether this is a system-defined payment medium (immutable).

isArchivedboolean required

Whether this payment medium is archived.

createdDatestring date-time required

The date and time the payment medium was created.

updatedDatestring date-time nullable

The date and time the payment medium was last updated.

No recorded changes to this endpoint across all 1 revision of this API.