mirror of
https://github.com/xtr-dev/payload-billing.git
synced 2025-12-10 02:43:24 +00:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 4fde492e0f |
11
README.md
11
README.md
@@ -111,9 +111,9 @@ const payment = await payload.create({
|
||||
|
||||
**What you get back:**
|
||||
|
||||
- **Stripe**: `providerId` = PaymentIntent ID, `providerData.raw.client_secret` for Stripe.js
|
||||
- **Mollie**: `providerId` = Transaction ID, `providerData.raw._links.checkout.href` for redirect URL
|
||||
- **Test**: `providerId` = Test payment ID, `providerData.raw.paymentUrl` for interactive test UI
|
||||
- **Stripe**: `providerId` = PaymentIntent ID, use `providerData.raw.client_secret` with Stripe.js on frontend
|
||||
- **Mollie**: `providerId` = Transaction ID, redirect user to `checkoutUrl` to complete payment
|
||||
- **Test**: `providerId` = Test payment ID, navigate to `checkoutUrl` for interactive test UI
|
||||
|
||||
## Payment Providers
|
||||
|
||||
@@ -407,6 +407,7 @@ Tracks payment transactions with provider integration.
|
||||
amount: number // Amount in cents
|
||||
currency: string // ISO 4217 currency code
|
||||
description?: string
|
||||
checkoutUrl?: string // Checkout URL (if applicable)
|
||||
invoice?: Invoice | string // Linked invoice
|
||||
metadata?: Record<string, any> // Custom metadata
|
||||
providerData?: ProviderData // Raw provider response (read-only)
|
||||
@@ -639,12 +640,14 @@ const payment = await payload.create({
|
||||
}
|
||||
})
|
||||
|
||||
// Get client secret for Stripe.js
|
||||
// Get client secret for Stripe.js (Stripe doesn't use checkoutUrl)
|
||||
const clientSecret = payment.providerData.raw.client_secret
|
||||
|
||||
// Frontend: Confirm payment with Stripe.js
|
||||
// const stripe = Stripe('pk_...')
|
||||
// await stripe.confirmCardPayment(clientSecret, { ... })
|
||||
|
||||
// For Mollie/Test: redirect to payment.checkoutUrl instead
|
||||
```
|
||||
|
||||
### Creating an Invoice with Line Items
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@xtr-dev/payload-billing",
|
||||
"version": "0.1.15",
|
||||
"version": "0.1.16",
|
||||
"description": "PayloadCMS plugin for billing and payment provider integrations with tracking and local testing",
|
||||
"license": "MIT",
|
||||
"type": "module",
|
||||
|
||||
@@ -78,6 +78,14 @@ export function createPaymentsCollection(pluginConfig: BillingPluginConfig): Col
|
||||
description: 'Payment description',
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'checkoutUrl',
|
||||
type: 'text',
|
||||
admin: {
|
||||
description: 'Checkout URL where user can complete payment (if applicable)',
|
||||
readOnly: true,
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'invoice',
|
||||
type: 'relationship',
|
||||
|
||||
@@ -22,6 +22,10 @@ export interface Payment {
|
||||
* Payment description
|
||||
*/
|
||||
description?: string | null;
|
||||
/**
|
||||
* Checkout URL where user can complete payment (if applicable)
|
||||
*/
|
||||
checkoutUrl?: string | null;
|
||||
invoice?: (Id | null) | Invoice;
|
||||
/**
|
||||
* Additional metadata for the payment
|
||||
|
||||
@@ -155,6 +155,7 @@ export const mollieProvider = (mollieConfig: MollieProviderConfig & {
|
||||
});
|
||||
payment.providerId = molliePayment.id
|
||||
payment.providerData = molliePayment.toPlainObject()
|
||||
payment.checkoutUrl = molliePayment._links?.checkout?.href || null
|
||||
return payment
|
||||
},
|
||||
} satisfies PaymentProvider
|
||||
|
||||
@@ -492,6 +492,7 @@ export const testProvider = (testConfig: TestProviderConfig) => {
|
||||
|
||||
// Set provider ID and data
|
||||
payment.providerId = testPaymentId
|
||||
const paymentUrl = `${baseUrl}/api/payload-billing/test/payment/${testPaymentId}`
|
||||
const providerData: ProviderData = {
|
||||
raw: {
|
||||
id: testPaymentId,
|
||||
@@ -500,7 +501,7 @@ export const testProvider = (testConfig: TestProviderConfig) => {
|
||||
description: payment.description,
|
||||
status: 'pending',
|
||||
testMode: true,
|
||||
paymentUrl: `${baseUrl}/api/payload-billing/test/payment/${testPaymentId}`,
|
||||
paymentUrl,
|
||||
scenarios: scenarios.map(s => ({ id: s.id, name: s.name, description: s.description })),
|
||||
methods: Object.entries(PAYMENT_METHODS).map(([key, value]) => ({
|
||||
id: key,
|
||||
@@ -512,6 +513,7 @@ export const testProvider = (testConfig: TestProviderConfig) => {
|
||||
provider: 'test'
|
||||
}
|
||||
payment.providerData = providerData
|
||||
payment.checkoutUrl = paymentUrl
|
||||
|
||||
return payment
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user