Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Added payment provider dashboard links to order payments (#14913)

Damian Legawiec9688d11a6033
diff --git a/.changeset/payment-gateway-dashboard-link.md b/.changeset/payment-gateway-dashboard-link.md
new file mode 100644
index 0000000000..1431a57352
--- /dev/null
+++ b/.changeset/payment-gateway-dashboard-link.md
@@ -0,0 +1,6 @@
+---
+"@spree/admin-sdk": minor
+"@spree/dashboard": minor
+---
+
+Admin API payments now include `gateway_dashboard_payment_url`, a link to the payment in the payment provider's own dashboard. On the order page, each payment's menu shows a "View at {payment method}" link when the provider offers one, so staff can look up the full payment details there.
diff --git a/docs/api-reference/admin.yaml b/docs/api-reference/admin.yaml
index 9be4f1ae56..4108ee4b2a 100644
--- a/docs/api-reference/admin.yaml
+++ b/docs/api-reference/admin.yaml
@@ -21612,6 +21612,7 @@ paths:
avs_response:
cvv_response_code:
cvv_response_message:
+ gateway_dashboard_payment_url: https://dashboard.bogus.example/payments/BGS-343039b69b86
created_at: '2026-01-15T12:00:00.000Z'
updated_at: '2026-01-15T12:00:00.000Z'
captured_amount: '0.00'
@@ -21693,6 +21694,7 @@ paths:
avs_response:
cvv_response_code:
cvv_response_message:
+ gateway_dashboard_payment_url:
created_at: '2026-01-15T12:00:00.000Z'
updated_at: '2026-01-15T12:00:00.000Z'
captured_amount: '0.00'
@@ -21800,6 +21802,7 @@ paths:
avs_response:
cvv_response_code:
cvv_response_message:
+ gateway_dashboard_payment_url: https://dashboard.bogus.example/payments/BGS-4a236d40ef07
created_at: '2026-01-15T12:00:00.000Z'
updated_at: '2026-01-15T12:00:00.000Z'
captured_amount: '0.00'
@@ -21888,6 +21891,7 @@ paths:
avs_response:
cvv_response_code:
cvv_response_message:
+ gateway_dashboard_payment_url: https://dashboard.bogus.example/payments/BGS-ccc19f06b194
created_at: '2026-01-15T12:00:00.000Z'
updated_at: '2026-01-15T12:00:00.000Z'
captured_amount: '110.00'
@@ -21990,6 +21994,7 @@ paths:
avs_response:
cvv_response_code:
cvv_response_message:
+ gateway_dashboard_payment_url: https://dashboard.bogus.example/payments/void-BGS-11f2e975ba0c
created_at: '2026-01-15T12:00:00.000Z'
updated_at: '2026-01-15T12:00:00.000Z'
captured_amount: '0.00'
@@ -63916,6 +63921,9 @@ components:
cvv_response_message:
type: string
nullable: true
+ gateway_dashboard_payment_url:
+ type: string
+ nullable: true
created_at:
type: string
updated_at:
@@ -63949,6 +63957,7 @@ components:
- avs_response
- cvv_response_code
- cvv_response_message
+ - gateway_dashboard_payment_url
- created_at
- updated_at
- captured_amount
diff --git a/packages/admin-sdk/src/types/generated/Payment.ts b/packages/admin-sdk/src/types/generated/Payment.ts
index 650dab1ddd..d51d615af1 100644
--- a/packages/admin-sdk/src/types/generated/Payment.ts
+++ b/packages/admin-sdk/src/types/generated/Payment.ts
@@ -1,4 +1,4 @@
-// Typelizer digest d1cb825d4691dfd0a872eba23d573eda
+// Typelizer digest 0df274b81a7420628c2f56d2966eb4fc
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {CreditCard, StoreCredit, PaymentSource, PaymentMethod, Order, Refund, PaymentSplit, PaymentStatus} from '@/types'
@@ -18,6 +18,7 @@ interface Payment {
avs_response: string | null;
cvv_response_code: string | null;
cvv_response_message: string | null;
+ gateway_dashboard_payment_url: string | null;
created_at: string;
updated_at: string;
captured_amount: string;
diff --git a/packages/admin-sdk/src/zod/generated/Payment.ts b/packages/admin-sdk/src/zod/generated/Payment.ts
index 313f1cf94a..61a4cd8b53 100644
--- a/packages/admin-sdk/src/zod/generated/Payment.ts
+++ b/packages/admin-sdk/src/zod/generated/Payment.ts
@@ -23,6 +23,7 @@ export const PaymentSchema = z.object({
avs_response: z.string().nullable(),
cvv_response_code: z.string().nullable(),
cvv_response_message: z.string().nullable(),
+ gateway_dashboard_payment_url: z.string().nullable(),
created_at: z.string(),
updated_at: z.string(),
captured_amount: z.string(),
diff --git a/packages/dashboard/e2e/global-setup.ts b/packages/dashboard/e2e/global-setup.ts
index b6eed3499f..9aaaed3341 100644
--- a/packages/dashboard/e2e/global-setup.ts
+++ b/packages/dashboard/e2e/global-setup.ts
@@ -1,6 +1,9 @@
import { writeFileSync } from 'node:fs'
import { resolve } from 'node:path'
import {
+ FIXTURE_BOGUS_GATEWAY,
+ FIXTURE_BOGUS_ORDER_EMAIL,
+ FIXTURE_BOGUS_TRANSACTION_ID,
FIXTURE_BULK_CATEGORY,
FIXTURE_BULK_CATEGORY_PERMALINK,
FIXTURE_BULK_CHANNEL_CODE,
@@ -180,6 +183,14 @@ const BOOTSTRAP_RUBY = [
// period as well as its own.
`comma_store.markets.find_or_create_by!(name: 'United States') { |m| m.currency = 'USD'; m.default_locale = 'en'; m.countries = [Spree::Country.find_by_iso!('US')] } unless comma_store.markets.exists?(currency: 'USD')`,
'comma_store.add_user(admin, Spree::Role.default_admin_role(comma_store)) unless comma_store.role_users.exists?(user: admin)',
+ // A card payment the Bogus gateway has charged, so its page at the gateway's
+ // dashboard has an address. On this store because the payment method specs
+ // install Bogus on the default one, and a store holds each provider once.
+ // Written directly: charging a card needs a full checkout.
+ `comma_bogus = comma_store.payment_methods.where(type: 'Spree::Gateway::Bogus').first_or_create!(name: '${FIXTURE_BOGUS_GATEWAY}', active: true, storefront_visible: false)`,
+ `gateway_order = comma_store.orders.find_by(email: '${FIXTURE_BOGUS_ORDER_EMAIL}') || Spree::Order.create!(store: comma_store, currency: 'EUR', email: '${FIXTURE_BOGUS_ORDER_EMAIL}', status: 'placed', completed_at: Time.current, total: 10)`,
+ "gateway_card = Spree::CreditCard.where(payment_method: comma_bogus, gateway_customer_profile_id: 'BGS-E2E').first_or_create!(number: '4111111111111111', verification_value: '123', month: 12, year: 1.year.from_now.year, name: 'E2E Customer', cc_type: 'visa')",
+ `gateway_order.payments.create!(payment_method: comma_bogus, source: gateway_card, amount: 10, status: 'completed', response_code: '${FIXTURE_BOGUS_TRANSACTION_ID}') unless gateway_order.payments.exists?`,
'port = ENV.fetch("PORT", 3010)',
'puts JSON.generate(api_url: "http://localhost:#{port}", admin_email: admin.email, admin_password: "spree123", store_id: s.prefixed_id, store_name: s.name, comma_store_id: comma_store.prefixed_id)',
].join('; ')
diff --git a/packages/dashboard/e2e/helpers.ts b/packages/dashboard/e2e/helpers.ts
index 20d03c0c23..5411e4301f 100644
--- a/packages/dashboard/e2e/helpers.ts
+++ b/packages/dashboard/e2e/helpers.ts
@@ -193,6 +193,11 @@ export const FIXTURE_PANEL_SELLER = 'E2E Panel Seller'
/** The marketplace seller panel, its own app on its own origin (see playwright.config.ts). */
export const SELLER_PANEL = `http://localhost:${process.env.E2E_SELLER_VITE_PORT || '5175'}`
+/** A placed order on the comma store, paid by a card the Bogus gateway charged. */
+export const FIXTURE_BOGUS_GATEWAY = 'E2E Bogus Gateway'
+export const FIXTURE_BOGUS_ORDER_EMAIL = '[email protected]'
+export const FIXTURE_BOGUS_TRANSACTION_ID = 'BGS-E2E-PAYMENT'
+
export const FIXTURE_PROMO_CUSTOMER_EMAIL = '[email protected]'
export const FIXTURE_PROMO_CUSTOMER_FIRST_NAME = 'Promo'
export const FIXTURE_PROMO_CUSTOMER_FULL_NAME = 'Promo Customer'
diff --git a/packages/dashboard/e2e/orders.spec.ts b/packages/dashboard/e2e/orders.spec.ts
index 8830d287ff..38c8b2f874 100644
--- a/packages/dashboard/e2e/orders.spec.ts
+++ b/packages/dashboard/e2e/orders.spec.ts
@@ -1,7 +1,15 @@
import * as path from 'node:path'
import { fileURLToPath } from 'node:url'
import { expect, type Page, test } from '@playwright/test'
-import { FIXTURE_PROMO_PRODUCT, fillAddressForm, login } from './helpers'
+import {
+ adminRequest,
+ FIXTURE_BOGUS_GATEWAY,
+ FIXTURE_BOGUS_ORDER_EMAIL,
+ FIXTURE_BOGUS_TRANSACTION_ID,
+ FIXTURE_PROMO_PRODUCT,
+ fillAddressForm,
+ login,
+} from './helpers'
// A PNG is in the PO document allowlist, so the shared fixture works and no
// new binary ships with the suite.
@@ -347,3 +355,29 @@ test.describe('order tags', () => {
})
})
})
+
+test.describe('order payments', () => {
+ test("links a card payment to its page at the gateway's dashboard", async ({ page }) => {
+ const creds = await login(page)
+ const orders = await adminRequest<{ data: { id: string }[] }>(
+ page,
+ { ...creds, store_id: creds.comma_store_id },
+ 'get',
+ `/orders?q[email_eq]=${encodeURIComponent(FIXTURE_BOGUS_ORDER_EMAIL)}`,
+ )
+ await page.goto(`/${creds.comma_store_id}/orders/${orders.data[0].id}`)
+
+ await page
+ .locator('tr')
+ .filter({ hasText: FIXTURE_BOGUS_GATEWAY })
+ .getByRole('button', { name: /^actions$/i })
+ .click({ timeout: 15_000 })
+
+ const link = page.getByRole('menuitem', { name: `View at ${FIXTURE_BOGUS_GATEWAY}` })
+ await expect(link).toHaveAttribute(
+ 'href',
+ `https://dashboard.bogus.example/payments/${FIXTURE_BOGUS_TRANSACTION_ID}`,
+ )
+ await expect(link).toHaveAttribute('target', '_blank')
+ })
+})
diff --git a/packages/dashboard/src/components/spree/orders/order-payments-card.tsx b/packages/dashboard/src/components/spree/orders/order-payments-card.tsx
index 5b28d0c857..5a2f5409fa 100644
--- a/packages/dashboard/src/components/spree/orders/order-payments-card.tsx
+++ b/packages/dashboard/src/components/spree/orders/order-payments-card.tsx
@@ -1,4 +1,4 @@
-import type { Order } from '@spree/admin-sdk'
+import type { Order, Payment } from '@spree/admin-sdk'
import { adminClient, currencyParts, Money } from '@spree/dashboard-core'
import {
Badge,
@@ -45,6 +45,7 @@ import {
import {
CreditCardIcon,
EllipsisVerticalIcon,
+ ExternalLinkIcon,
PlusIcon,
XCircleIcon,
} from '@spree/dashboard-ui/icons'
@@ -171,60 +172,42 @@ export function PaymentsCard({ order }: { order: Order }) {
</TableCell>
)}
<TableCell>
- {!grouped &&
- (payment.status === 'checkout' ||
- payment.status === 'pending' ||
- payment.status === 'completed') && (
- <DropdownMenu>
- <DropdownMenuTrigger asChild>
- <Button variant="ghost" size="icon-xs">
- <EllipsisVerticalIcon className="size-4" />
- <span className="sr-only">{t('admin.actions.actions_menu')}</span>
- </Button>
- </DropdownMenuTrigger>
- <DropdownMenuContent align="end">
- {(payment.status === 'checkout' || payment.status === 'pending') && (
- <DropdownMenuItem
- onClick={async () => {
- if (
- await confirm({
- message: t('admin.orders.detail.confirm.capture_message'),
- variant: 'default',
- confirmLabel: t('admin.pages.orders.detail.actions.capture'),
- })
- ) {
- captureMutation.mutate(payment.id)
- }
- }}
- >
- <CreditCardIcon className="size-4" />
- {t('admin.pages.orders.detail.actions.capture')}
- </DropdownMenuItem>
- )}
- {(payment.status === 'checkout' ||
- payment.status === 'pending' ||
- payment.status === 'completed') && (
- <DropdownMenuItem
- variant="destructive"
- onClick={async () => {
- if (
- await confirm({
- message: t('admin.orders.detail.confirm.void_message'),
- variant: 'destructive',
- confirmLabel: t('admin.pages.orders.detail.actions.void'),
- })
- ) {
- voidMutation.mutate(payment.id)
- }
- }}
- >
- <XCircleIcon className="size-4" />
- {t('admin.pages.orders.detail.actions.void')}
- </DropdownMenuItem>
- )}
- </DropdownMenuContent>
- </DropdownMenu>
- )}
+ <PaymentActionsMenu
+ payment={payment}
+ // Capturing or voiding a grouped payment acts on every
+ // order in the checkout, so this page only links out.
+ canCapture={
+ !grouped && (payment.status === 'checkout' || payment.status === 'pending')
+ }
+ canVoid={
+ !grouped &&
+ (payment.status === 'checkout' ||
+ payment.status === 'pending' ||
+ payment.status === 'completed')
+ }
+ onCapture={async () => {
+ if (
+ await confirm({
+ message: t('admin.orders.detail.confirm.capture_message'),
+ variant: 'default',
+ confirmLabel: t('admin.pages.orders.detail.actions.capture'),
+ })
+ ) {
+ captureMutation.mutate(payment.id)
+ }
+ }}
+ onVoid={async () => {
+ if (
+ await confirm({
+ message: t('admin.orders.detail.confirm.void_message'),
+ variant: 'destructive',
+ confirmLabel: t('admin.pages.orders.detail.actions.void'),
+ })
+ ) {
+ voidMutation.mutate(payment.id)
+ }
+ }}
+ />
</TableCell>
</TableRow>
))}
@@ -237,6 +220,59 @@ export function PaymentsCard({ order }: { order: Order }) {
)
}
+function PaymentActionsMenu({
+ payment,
+ canCapture,
+ canVoid,
+ onCapture,
+ onVoid,
+}: {
+ payment: Payment
+ canCapture: boolean
+ canVoid: boolean
+ onCapture: () => void
+ onVoid: () => void
+}) {
+ const { t } = useTranslation()
+ const dashboardUrl = payment.gateway_dashboard_payment_url
+ if (!canCapture && !canVoid && !dashboardUrl) return null
+
+ return (
+ <DropdownMenu>
+ <DropdownMenuTrigger asChild>
+ <Button variant="ghost" size="icon-xs">
+ <EllipsisVerticalIcon className="size-4" />
+ <span className="sr-only">{t('admin.actions.actions_menu')}</span>
+ </Button>
+ </DropdownMenuTrigger>
+ <DropdownMenuContent align="end">
+ {dashboardUrl && (
+ <DropdownMenuItem asChild>
+ <a href={dashboardUrl} target="_blank" rel="noopener noreferrer">
+ <ExternalLinkIcon className="size-4" />
+ {t('admin.orders.detail.payments_table.view_at_gateway', {
+ gateway: payment.payment_method?.name,
+ })}
+ </a>
+ </DropdownMenuItem>
+ )}
+ {canCapture && (
+ <DropdownMenuItem onClick={onCapture}>
+ <CreditCardIcon className="size-4" />
+ {t('admin.pages.orders.detail.actions.capture')}
+ </DropdownMenuItem>
+ )}
+ {canVoid && (
+ <DropdownMenuItem variant="destructive" onClick={onVoid}>
+ <XCircleIcon className="size-4" />
+ {t('admin.pages.orders.detail.actions.void')}
+ </DropdownMenuItem>
+ )}
+ </DropdownMenuContent>
+ </DropdownMenu>
+ )
+}
+
function AddPaymentDialog({
order,
open,
diff --git a/packages/dashboard/src/hooks/use-seller-ledger.ts b/packages/dashboard/src/hooks/use-seller-ledger.ts
index 3b55b861f6..ae46aeaa68 100644
--- a/packages/dashboard/src/hooks/use-seller-ledger.ts
+++ b/packages/dashboard/src/hooks/use-seller-ledger.ts
@@ -105,6 +105,7 @@ export function useOrderGroup(orderGroupId: string | null | undefined) {
queryFn: () =>
adminClient.orderGroups.get(orderGroupId as string, {
fields: ['payments', 'number'],
+ expand: ['payments.payment_method'],
}),
enabled: !!orderGroupId,
})
diff --git a/packages/dashboard/src/locales/ar.json b/packages/dashboard/src/locales/ar.json
index 8f42f192d3..e3d3756b60 100644
--- a/packages/dashboard/src/locales/ar.json
+++ b/packages/dashboard/src/locales/ar.json
@@ -2952,7 +2952,8 @@
"state": "ولاية",
"this_order": "هذا الطلب",
"shared_help": "دُفعت مرة واحدة لسلة تضم عدة بائعين. هذا الطلب له حصة منها.",
- "load_error": "تعذر تحميل مدفوعات هذا الطلب."
+ "load_error": "تعذر تحميل مدفوعات هذا الطلب.",
+ "view_at_gateway": "عرض في {{gateway}}"
},
"priced_by": "التسعير من {{name}}",
"purchase_order": {
diff --git a/packages/dashboard/src/locales/de.json b/packages/dashboard/src/locales/de.json
index 02bb9c1a75..67cb167e4b 100644
--- a/packages/dashboard/src/locales/de.json
+++ b/packages/dashboard/src/locales/de.json
@@ -2932,7 +2932,8 @@
"state": "Status",
"this_order": "Diese Bestellung",
"shared_help": "Einmal bezahlt für einen Warenkorb mehrerer Verkäufer. Diese Bestellung hat einen Anteil daran.",
- "load_error": "Die Zahlungen für diese Bestellung konnten nicht geladen werden."
+ "load_error": "Die Zahlungen für diese Bestellung konnten nicht geladen werden.",
+ "view_at_gateway": "In {{gateway}} ansehen"
},
"priced_by": "Preis von {{name}}",
"purchase_order": {
diff --git a/packages/dashboard/src/locales/en.json b/packages/dashboard/src/locales/en.json
index 13f85b9548..0ffa36a555 100644
--- a/packages/dashboard/src/locales/en.json
+++ b/packages/dashboard/src/locales/en.json
@@ -2932,7 +2932,8 @@
"state": "State",
"this_order": "This order",
"shared_help": "Paid once for a basket spanning several sellers. This order has a share of it.",
- "load_error": "Could not load the payments for this order."
+ "load_error": "Could not load the payments for this order.",
+ "view_at_gateway": "View at {{gateway}}"
},
"priced_by": "Priced by {{name}}",
"purchase_order": {
diff --git a/packages/dashboard/src/locales/es.json b/packages/dashboard/src/locales/es.json
index 3c7fcce5d0..0cd9c5d8dd 100644
--- a/packages/dashboard/src/locales/es.json
+++ b/packages/dashboard/src/locales/es.json
@@ -2718,7 +2718,8 @@
"state": "Estado",
"this_order": "Este pedido",
"shared_help": "Pagado una vez por un carrito que abarca varios vendedores. Este pedido tiene una parte de él.",
- "load_error": "No se pudieron cargar los pagos de este pedido."
+ "load_error": "No se pudieron cargar los pagos de este pedido.",
+ "view_at_gateway": "Ver en {{gateway}}"
},
"priced_by": "Precio según {{name}}",
"purchase_order": {
diff --git a/packages/dashboard/src/locales/fr.json b/packages/dashboard/src/locales/fr.json
index bc542124ff..d0c3aa466c 100644
--- a/packages/dashboard/src/locales/fr.json
+++ b/packages/dashboard/src/locales/fr.json
@@ -2932,7 +2932,8 @@
"state": "État",
"this_order": "Cette commande",
"shared_help": "Payé en une fois pour un panier réparti entre plusieurs vendeurs. Cette commande en détient une part.",
- "load_error": "Impossible de charger les paiements de cette commande."
+ "load_error": "Impossible de charger les paiements de cette commande.",
+ "view_at_gateway": "Voir sur {{gateway}}"
},
"priced_by": "Tarifé par {{name}}",
"purchase_order": {
diff --git a/packages/dashboard/src/locales/pl.json b/packages/dashboard/src/locales/pl.json
index 0d660389c9..e0d98311b4 100644
--- a/packages/dashboard/src/locales/pl.json
+++ b/packages/dashboard/src/locales/pl.json
@@ -2960,7 +2960,8 @@
"state": "Stan",
"this_order": "To zamówienie",
"shared_help": "Zapłacone raz za koszyk obejmujący kilku sprzedawców. To zamówienie ma w nim udział.",
- "load_error": "Nie udało się wczytać płatności tego zamówienia."
+ "load_error": "Nie udało się wczytać płatności tego zamówienia.",
+ "view_at_gateway": "Zobacz w {{gateway}}"
},
"priced_by": "Cena z {{name}}",
"purchase_order": {
diff --git a/packages/dashboard/src/locales/zh-CN.json b/packages/dashboard/src/locales/zh-CN.json
index a50e30a5ef..fc7faf4674 100644
--- a/packages/dashboard/src/locales/zh-CN.json
+++ b/packages/dashboard/src/locales/zh-CN.json
@@ -2924,7 +2924,8 @@
"state": "状态",
"this_order": "本订单",
"shared_help": "该购物车横跨多个卖家,只支付了一次。本订单占其中一部分。",
- "load_error": "无法加载此订单的付款信息。"
+ "load_error": "无法加载此订单的付款信息。",
+ "view_at_gateway": "在 {{gateway}} 中查看"
},
"priced_by": "定价来自 {{name}}",
"purchase_order": {
diff --git a/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb
index fd76d05b61..f1039b0237 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/payment_serializer.rb
@@ -13,9 +13,11 @@ module Spree
order_id: [:string, nullable: true],
avs_response: [:string, nullable: true],
cvv_response_code: [:string, nullable: true],
- cvv_response_message: [:string, nullable: true]
+ cvv_response_message: [:string, nullable: true],
+ gateway_dashboard_payment_url: [:string, nullable: true]
attributes :metadata, :avs_response, :cvv_response_code, :cvv_response_message,
+ :gateway_dashboard_payment_url,
created_at: :iso8601, updated_at: :iso8601
money_attributes :captured_amount
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/order_groups_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/order_groups_controller_spec.rb
index bc92fd846a..5c2d25a254 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/order_groups_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/order_groups_controller_spec.rb
@@ -46,6 +46,14 @@ RSpec.describe Spree::Api::V3::Admin::OrderGroupsController, type: :controller d
numbers = json_response['orders'].map { |order| order['number'] }
expect(numbers).to contain_exactly(first_party_order.number, seller_order.number)
end
+
+ it "expands each payment's method within a narrowed response" do
+ payment = create(:payment, order_group: group, amount: 50)
+
+ get :show, params: { id: group.prefixed_id, fields: 'payments,number', expand: 'payments.payment_method' }
+
+ expect(json_response['payments'].first['payment_method']['name']).to eq(payment.payment_method.name)
+ end
end
# Read-only by routing: a group records a checkout that already happened.
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/orders/payments_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/orders/payments_controller_spec.rb
index 3482e0a25c..32a976d299 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/orders/payments_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/orders/payments_controller_spec.rb
@@ -39,6 +39,14 @@ RSpec.describe Spree::Api::V3::Admin::Orders::PaymentsController, type: :control
expect(json_response['status']).to be_present
end
+ it "returns the payment's page at the gateway dashboard" do
+ allow_any_instance_of(Spree::Payment).to receive(:gateway_dashboard_payment_url).and_return('https://dashboard.example.com/payments/ch_123')
+
+ get :show, params: { order_id: order_with_payment.prefixed_id, id: payment.prefixed_id }, as: :json
+
+ expect(json_response['gateway_dashboard_payment_url']).to eq('https://dashboard.example.com/payments/ch_123')
+ end
+
it 'returns 404 for unknown payment id' do
get :show, params: { order_id: order_with_payment.prefixed_id, id: 'pay_unknown' }, as: :json
diff --git a/spree/core/app/models/spree/gateway/bogus.rb b/spree/core/app/models/spree/gateway/bogus.rb
index ed0c8b0e80..479523712b 100644
--- a/spree/core/app/models/spree/gateway/bogus.rb
+++ b/spree/core/app/models/spree/gateway/bogus.rb
@@ -70,6 +70,13 @@ module Spree
Spree::PaymentResponse.new(true, 'Bogus Gateway: Forced success', {}, test: true, authorization: generate_authorization)
end
+ # A made-up address, so the dashboard link can be tried without a provider.
+ def gateway_dashboard_payment_url(payment)
+ return if payment.transaction_id.blank?
+
+ "https://dashboard.bogus.example/payments/#{payment.transaction_id}"
+ end
+
def test?
# Test mode is not really relevant with bogus gateway (no such thing as live server)
true
diff --git a/spree/core/app/models/spree/payment.rb b/spree/core/app/models/spree/payment.rb
index a510879761..dd64975550 100644
--- a/spree/core/app/models/spree/payment.rb
+++ b/spree/core/app/models/spree/payment.rb
@@ -334,8 +334,19 @@ module Spree
true
end
+ # The payment's page in the provider's dashboard. Only https links are
+ # returned, since staff open it from the admin and a gateway may build it
+ # from values the provider sent back.
+ #
+ # @return [String, nil]
def gateway_dashboard_payment_url
- payment_method.try(:gateway_dashboard_payment_url, self)
+ url = payment_method.try(:gateway_dashboard_payment_url, self)
+ return if url.blank?
+
+ uri = URI.parse(url)
+ url if uri.is_a?(URI::HTTPS) && uri.host.present?
+ rescue URI::InvalidURIError
+ nil
end
def captured_amount
diff --git a/spree/core/spec/models/spree/gateway/bogus_spec.rb b/spree/core/spec/models/spree/gateway/bogus_spec.rb
index 1167b180ef..6debeec40c 100644
--- a/spree/core/spec/models/spree/gateway/bogus_spec.rb
+++ b/spree/core/spec/models/spree/gateway/bogus_spec.rb
@@ -9,5 +9,15 @@ module Spree
bogus.disable_customer_profile(cc)
expect(cc.gateway_customer_profile_id).to be_nil
end
+
+ describe '#gateway_dashboard_payment_url' do
+ it 'links to the payment by its transaction id' do
+ expect(bogus.gateway_dashboard_payment_url(build(:payment, response_code: 'BGS-123'))).to eq('https://dashboard.bogus.example/payments/BGS-123')
+ end
+
+ it 'returns nil before the payment is charged' do
+ expect(bogus.gateway_dashboard_payment_url(build(:payment, response_code: nil))).to be_nil
+ end
+ end
end
end
diff --git a/spree/core/spec/models/spree/gateway_spec.rb b/spree/core/spec/models/spree/gateway_spec.rb
index 68e4eabd1d..a64112d5d4 100644
--- a/spree/core/spec/models/spree/gateway_spec.rb
+++ b/spree/core/spec/models/spree/gateway_spec.rb
@@ -146,11 +146,8 @@ describe Spree::Gateway, type: :model do
end
describe '#gateway_dashboard_payment_url' do
- let(:payment_method) { create(:credit_card_payment_method) }
- let(:payment) { create(:payment, payment_method: payment_method, transaction_id: '123') }
-
it 'returns nil' do
- expect(payment_method.gateway_dashboard_payment_url(payment)).to be_nil
+ expect(TestGateway.new.gateway_dashboard_payment_url(build(:payment, transaction_id: '123'))).to be_nil
end
end
end
diff --git a/spree/core/spec/models/spree/payment_spec.rb b/spree/core/spec/models/spree/payment_spec.rb
index 4262d27a76..63443cb454 100644
--- a/spree/core/spec/models/spree/payment_spec.rb
+++ b/spree/core/spec/models/spree/payment_spec.rb
@@ -1075,8 +1075,8 @@ describe Spree::Payment, type: :model do
end
describe '#gateway_dashboard_payment_url' do
- it 'returns nil' do
- expect(payment.gateway_dashboard_payment_url).to be_nil
+ it 'returns nil when the payment method has no dashboard' do
+ expect(build(:payment, payment_method: create(:check_payment_method)).gateway_dashboard_payment_url).to be_nil
end
let(:payment) { create(:payment, payment_method: gateway, transaction_id: '123') }
@@ -1090,6 +1090,16 @@ describe Spree::Payment, type: :model do
expect(payment.gateway_dashboard_payment_url).to eq("https://dashboard.stripe.com/payments/#{payment.transaction_id}")
end
end
+
+ context 'when the gateway returns a link that is not https' do
+ it 'returns nil' do
+ ['javascript:alert(1)', 'http://dashboard.example.com/payments/123', 'https://exa mple.com', 'https:javascript:alert(1)', 'https:/payments/123'].each do |url|
+ allow(gateway).to receive(:gateway_dashboard_payment_url).with(payment).and_return(url)
+
+ expect(payment.gateway_dashboard_payment_url).to be_nil
+ end
+ end
+ end
end
describe '#add_gateway_processing_error' do
diff --git a/spree/providers/stripe/app/models/spree_stripe/gateway.rb b/spree/providers/stripe/app/models/spree_stripe/gateway.rb
index 15b8dfb455..c867cbf85c 100644
--- a/spree/providers/stripe/app/models/spree_stripe/gateway.rb
+++ b/spree/providers/stripe/app/models/spree_stripe/gateway.rb
@@ -78,10 +78,12 @@ module SpreeStripe
saved_change_to_preferred_secret_key?
end
+ # Stripe shows test-mode payments only under its /test/ dashboard path.
def gateway_dashboard_payment_url(payment)
return if payment.transaction_id.blank?
- "https://dashboard.stripe.com/payments/#{payment.transaction_id}"
+ mode_path = preferred_secret_key.to_s.match?(/\A(sk|rk)_test_/) ? 'test/' : ''
+ "https://dashboard.stripe.com/#{mode_path}payments/#{payment.transaction_id}"
end
# Called by core when a session-created payment moves to pending. The intent
diff --git a/spree/providers/stripe/spec/models/spree_stripe/gateway_spec.rb b/spree/providers/stripe/spec/models/spree_stripe/gateway_spec.rb
index 6c335b0b2f..83f61e1923 100644
--- a/spree/providers/stripe/spec/models/spree_stripe/gateway_spec.rb
+++ b/spree/providers/stripe/spec/models/spree_stripe/gateway_spec.rb
@@ -245,6 +245,30 @@ RSpec.describe SpreeStripe::Gateway do
end
end
+ describe '#gateway_dashboard_payment_url' do
+ subject { gateway.gateway_dashboard_payment_url(payment) }
+
+ let(:payment) { build(:payment, response_code: 'pi_123') }
+
+ it 'links to the test dashboard for a test key' do
+ gateway.preferred_secret_key = 'sk_test_123'
+
+ expect(subject).to eq('https://dashboard.stripe.com/test/payments/pi_123')
+ end
+
+ it 'links to the live dashboard for a live key' do
+ gateway.preferred_secret_key = 'sk_live_123'
+
+ expect(subject).to eq('https://dashboard.stripe.com/payments/pi_123')
+ end
+
+ it 'returns nil without a transaction id' do
+ payment.response_code = nil
+
+ expect(subject).to be_nil
+ end
+ end
+
describe 'creating the payment intent' do
subject { gateway.send(:create_payment_intent, amount, order) }