PaymentProcessor

The new payment service plugin interface This work is still experimental and can be changed until it becomes stable

Methods

authorizePayment

**authorizePayment**(paymentSessionData, context): Promise<[PaymentProcessorError](/references/services/interfaces/PaymentProcessorError) \| { data: Record<string, unknown> ; status: [PaymentSessionStatus](/references/services/enums/PaymentSessionStatus) }>

Authorize an existing session if it is not already authorized

Parameters

paymentSessionDataRecord<string, unknown>Required

contextRecord<string, unknown>Required

Returns

Promise<PaymentProcessorError | { data: Record<string, unknown> ; status: PaymentSessionStatus }>

PromisePromise<PaymentProcessorError | { data: Record<string, unknown> ; status: PaymentSessionStatus }>Required

---

cancelPayment

**cancelPayment**(paymentSessionData): Promise<Record<string, unknown> \| [PaymentProcessorError](/references/services/interfaces/PaymentProcessorError)>

Cancel an existing session

Parameters

paymentSessionDataRecord<string, unknown>Required

Returns

Promise<Record<string, unknown> | PaymentProcessorError>

PromisePromise<Record<string, unknown> | PaymentProcessorError>Required

---

capturePayment

**capturePayment**(paymentSessionData): Promise<Record<string, unknown> \| [PaymentProcessorError](/references/services/interfaces/PaymentProcessorError)>

Capture an existing session

Parameters

paymentSessionDataRecord<string, unknown>Required

Returns

Promise<Record<string, unknown> | PaymentProcessorError>

PromisePromise<Record<string, unknown> | PaymentProcessorError>Required

---

deletePayment

**deletePayment**(paymentSessionData): Promise<Record<string, unknown> \| [PaymentProcessorError](/references/services/interfaces/PaymentProcessorError)>

Delete an existing session

Parameters

paymentSessionDataRecord<string, unknown>Required

Returns

Promise<Record<string, unknown> | PaymentProcessorError>

PromisePromise<Record<string, unknown> | PaymentProcessorError>Required

---

getIdentifier

**getIdentifier**(): string

Return a unique identifier to retrieve the payment plugin provider

Returns

string

stringstring

---

getPaymentStatus

**getPaymentStatus**(paymentSessionData): Promise<[PaymentSessionStatus](/references/services/enums/PaymentSessionStatus)>

Return the status of the session

Parameters

paymentSessionDataRecord<string, unknown>Required

Returns

Promise<PaymentSessionStatus>

PromisePromise<PaymentSessionStatus>Required

---

initiatePayment

**initiatePayment**(context): Promise<[PaymentProcessorError](/references/services/interfaces/PaymentProcessorError) \| [PaymentProcessorSessionResponse](/references/services/types/PaymentProcessorSessionResponse)>

Initiate a payment session with the external provider

Parameters

contextPaymentProcessorContextRequired

Returns

Promise<PaymentProcessorError | PaymentProcessorSessionResponse>

PromisePromise<PaymentProcessorError | PaymentProcessorSessionResponse>Required

---

refundPayment

**refundPayment**(paymentSessionData, refundAmount): Promise<Record<string, unknown> \| [PaymentProcessorError](/references/services/interfaces/PaymentProcessorError)>

Refund an existing session

Parameters

paymentSessionDataRecord<string, unknown>Required

refundAmountnumberRequired

Returns

Promise<Record<string, unknown> | PaymentProcessorError>

PromisePromise<Record<string, unknown> | PaymentProcessorError>Required

---

retrievePayment

**retrievePayment**(paymentSessionData): Promise<Record<string, unknown> \| [PaymentProcessorError](/references/services/interfaces/PaymentProcessorError)>

Retrieve an existing session

Parameters

paymentSessionDataRecord<string, unknown>Required

Returns

Promise<Record<string, unknown> | PaymentProcessorError>

PromisePromise<Record<string, unknown> | PaymentProcessorError>Required

---

updatePayment

**updatePayment**(context): Promise<void \| [PaymentProcessorError](/references/services/interfaces/PaymentProcessorError) \| [PaymentProcessorSessionResponse](/references/services/types/PaymentProcessorSessionResponse)>

Update an existing payment session

Parameters

contextPaymentProcessorContextRequired

Returns

Promise<void | PaymentProcessorError | PaymentProcessorSessionResponse>

PromisePromise<void | PaymentProcessorError | PaymentProcessorSessionResponse>Required

---

updatePaymentData

**updatePaymentData**(sessionId, data): Promise<Record<string, unknown> \| [PaymentProcessorError](/references/services/interfaces/PaymentProcessorError)>

Update the session data for a payment session

Parameters

sessionIdstringRequired

dataRecord<string, unknown>Required

Returns

Promise<Record<string, unknown> | PaymentProcessorError>

PromisePromise<Record<string, unknown> | PaymentProcessorError>Required