Skip to main content
POST
Create Payment Medium

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Schema for creating a custom settlement type.

name
string
required

The name of the custom settlement type.

Required string length: 1 - 100

Response

Successful Response

Schema for reading payment medium records.

name
string
required

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

isSystem
boolean
required

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

isArchived
boolean
required

Whether this payment medium is archived.

createdDate
string<date-time>
required

The date and time the payment medium was created.

updatedDate
string<date-time> | null

The date and time the payment medium was last updated.