Class: PaymentProviderService
Helps retrive payment providers
Hierarchy
"medusa-interfaces"↳
PaymentProviderService
Constructors
constructor
• new PaymentProviderService(container)
Parameters
| Name | Type |
|---|---|
container | any |
Overrides
BaseService.constructor
Defined in
services/payment-provider.js:8
Properties
manager_
• manager_: any
Defined in
services/payment-provider.js:14
paymentRepository_
• paymentRepository_: any
Defined in
services/payment-provider.js:18
paymentSessionRepository_
• paymentSessionRepository_: any
Defined in
services/payment-provider.js:16
refundRepository_
• refundRepository_: any
Defined in
services/payment-provider.js:20
Methods
authorizePayment
▸ authorizePayment(paymentSession, context): Promise<any>
Parameters
| Name | Type |
|---|---|
paymentSession | any |
context | any |
Returns
Promise<any>
Defined in
services/payment-provider.js:283
cancelPayment
▸ cancelPayment(paymentObj): Promise<any>
Parameters
| Name | Type |
|---|---|
paymentObj | any |
Returns
Promise<any>
Defined in
services/payment-provider.js:324
capturePayment
▸ capturePayment(paymentObj): Promise<any>
Parameters
| Name | Type |
|---|---|
paymentObj | any |
Returns
Promise<any>
Defined in
services/payment-provider.js:343
createPayment
▸ createPayment(cart): Promise<any>
Parameters
| Name | Type |
|---|---|
cart | any |
Returns
Promise<any>
Defined in
services/payment-provider.js:246
createSession
▸ createSession(providerId, cart): Promise<any>
Creates a payment session with the given provider.
Parameters
| Name | Type | Description |
|---|---|---|
providerId | string | the id of the provider to create payment with |
cart | Cart | a cart object used to calculate the amount, etc. from |
Returns
Promise<any>
the payment session
Defined in
services/payment-provider.js:121
deleteSession
▸ deleteSession(paymentSession): any
Parameters
| Name | Type |
|---|---|
paymentSession | any |
Returns
any
Defined in
services/payment-provider.js:202
getStatus
▸ getStatus(payment): Promise<any>
Parameters
| Name | Type |
|---|---|
payment | any |
Returns
Promise<any>
Defined in
services/payment-provider.js:338
list
▸ list(): Promise<any>
Returns
Promise<any>
Defined in
services/payment-provider.js:47
listPayments
▸ listPayments(selector, config?): any
Parameters
| Name | Type | Default value |
|---|---|---|
selector | any | undefined |
config | Object | undefined |
config.order | Object | undefined |
config.order.created_at | string | "DESC" |
config.skip | number | 0 |
config.take | number | 50 |
Returns
any
Defined in
services/payment-provider.js:80
refreshSession
▸ refreshSession(paymentSession, cart): Promise<any>
Refreshes a payment session with the given provider. This means, that we delete the current one and create a new.
Parameters
| Name | Type | Description |
|---|---|---|
paymentSession | PaymentSession | the payment session object to update |
cart | Cart | a cart object used to calculate the amount, etc. from |
Returns
Promise<any>
the payment session
Defined in
services/payment-provider.js:152
refundPayment
▸ refundPayment(payObjs, amount, reason, note): Promise<any>
Parameters
| Name | Type |
|---|---|
payObjs | any |
amount | any |
reason | any |
note | any |
Returns
Promise<any>
Defined in
services/payment-provider.js:358
registerInstalledProviders
▸ registerInstalledProviders(providers): Promise<void>
Parameters
| Name | Type |
|---|---|
providers | any |
Returns
Promise<void>
Defined in
services/payment-provider.js:35
retrievePayment
▸ retrievePayment(id, relations?): Promise<any>
Parameters
| Name | Type | Default value |
|---|---|---|
id | any | undefined |
relations | any[] | [] |
Returns
Promise<any>
Defined in
services/payment-provider.js:54
retrieveProvider
▸ retrieveProvider(providerId): PaymentService
Finds a provider given an id
Parameters
| Name | Type | Description |
|---|---|---|
providerId | string | the id of the provider to get |
Returns
PaymentService
the payment provider
Defined in
services/payment-provider.js:228
retrieveRefund
▸ retrieveRefund(id, config?): Promise<any>
Parameters
| Name | Type |
|---|---|
id | any |
config | Object |
Returns
Promise<any>
Defined in
services/payment-provider.js:422
retrieveSession
▸ retrieveSession(id, relations?): Promise<any>
Parameters
| Name | Type | Default value |
|---|---|---|
id | any | undefined |
relations | any[] | [] |
Returns
Promise<any>
Defined in
services/payment-provider.js:89
updatePayment
▸ updatePayment(paymentId, update): Promise<any>
Parameters
| Name | Type |
|---|---|
paymentId | any |
update | any |
Returns
Promise<any>
Defined in
services/payment-provider.js:266
updateSession
▸ updateSession(paymentSession, cart): Promise<any>
Updates an existing payment session.
Parameters
| Name | Type | Description |
|---|---|---|
paymentSession | PaymentSession | the payment session object to update |
cart | Cart | the cart object to update for |
Returns
Promise<any>
the updated payment session
Defined in
services/payment-provider.js:188
updateSessionData
▸ updateSessionData(paySession, update): Promise<any>
Parameters
| Name | Type |
|---|---|
paySession | any |
update | any |
Returns
Promise<any>
Defined in
services/payment-provider.js:308
withTransaction
▸ withTransaction(manager): PaymentProviderService
Parameters
| Name | Type |
|---|---|
manager | any |