Skip to main content
GET
/
api
/
v1
/
payment-types
cURL
curl --request GET \
  --url https://api-staging.getmeadow.com/api/v1/payment-types \
  --header 'X-Client-Key: <api-key>' \
  --header 'X-Consumer-Key: <api-key>'
{
  "id": 123,
  "name": "<string>",
  "fee": 123,
  "feeDescription": "<string>",
  "method": "cash",
  "feePercent": "<string>",
  "createdAt": "<string>"
}

Authorizations

X-Consumer-Key
string
header
required

The key assigned to your company and provided via Meadow

X-Client-Key
string
header
required

The key generated and provided by our mutual client

Response

List payment types response

id
number

The id for the payment type

name
string

The name of the payment type

fee
number

The flat fee for using this payment type in cents

feeDescription
string | null

The description for the fee to show to the customer

method
enum<string>

The medium the payment type uses to collect payment

Available options:
cash,
debit,
other,
stronghold
feePercent
string

The percentage fee for this payment type

createdAt
string

The date this payment type was created