Payment Method

amerta

---

amerta / payload-types / PaymentMethod

Interface: PaymentMethod

Defined in: payload-types.ts:2719

This interface was referenced by Config's JSON-Schema via the definition "payment-method".

Properties

active?

optional active: boolean | null

Defined in: payload-types.ts:2773

Enable or disable this payment method

---

codSettings?

optional codSettings: { instructions?: string | null; }

Defined in: payload-types.ts:2742

instructions?

optional instructions: string | null

Instructions shown to user on the Thank You page

---

createdAt

createdAt: string

Defined in: payload-types.ts:2788

---

currencies?

optional currencies: (string | Currency)[] | null

Defined in: payload-types.ts:2761

If the sales channel currency is not supported by the payment method, the currency conversion will be handled at checkout using the first supported currency.

---

description?

optional description: string | null

Defined in: payload-types.ts:2765

Internal description of this payment method

---

icons?

optional icons: { id?: string | null; image: string | Media; }[] | null

Defined in: payload-types.ts:2781

Images/icons for this payment method

---

id

id: string

Defined in: payload-types.ts:2720

---

label

label: string

Defined in: payload-types.ts:2728

Label visible to customers at checkout

---

mamoPaySettings?

optional mamoPaySettings: { liveApiKey?: string | null; testApiKey?: string | null; testMode?: boolean | null; webhookId?: string | null; }

Defined in: payload-types.ts:2748

liveApiKey?

optional liveApiKey: string | null

testApiKey?

optional testApiKey: string | null

testMode?

optional testMode: boolean | null

webhookId?

optional webhookId: string | null

---

name

name: string

Defined in: payload-types.ts:2724

Internal name for the payment method (e.g., 'Credit Card', 'PayPal')

---

order?

optional order: number | null

Defined in: payload-types.ts:2777

Order of this payment method in the list

---

publicDescription?

optional publicDescription: string | null

Defined in: payload-types.ts:2769

Description visible to customers

---

salesChannels

salesChannels: (string | SalesChannel)[]

Defined in: payload-types.ts:2757

This payment method will only be available in the selected sales channels.

---

stripeSettings?

optional stripeSettings: { publishableKey: string; secretKey: string; webhookId?: string | null; webhookSecret?: string | null; }

Defined in: payload-types.ts:2733

publishableKey

publishableKey: string

secretKey

secretKey: string

Stripe Secret Key (sk_...)

webhookId?

optional webhookId: string | null

webhookSecret?

optional webhookSecret: string | null

---

type

type: "stripe" | "cod" | "mamo-pay"

Defined in: payload-types.ts:2732

Type of payment method

---

updatedAt

updatedAt: string

Defined in: payload-types.ts:2787