@bcc-code/payment-client 1.3.0 → 1.3.1

package/README.md

@@ -61,8 +61,9 @@ const payment = await client.createPayment({
   ]
 })
 
-// Get payment status
+// Get payment status (use { sync: true } after redirect e.g. Vipps to fetch latest from provider)
 const status = await client.getPayment(payment.paymentId)
+// status.paymentMethod (e.g. "vipps"), status.providerStatus (e.g. "CANCELLED") when known
 
 // Get receipt
 const receipt = await client.getReceipt(payment.paymentId)

package/dist/index.d.mts

@@ -64,6 +64,10 @@ interface PaymentResponse {
     amount: number;
     currency: string;
     status: string;
+    /** Payment method used (e.g. "vipps", "scheme") when known from provider. */
+    paymentMethod?: string | null;
+    /** Raw status from the provider (e.g. "AUTHORISED", "CANCELLED") when known. */
+    providerStatus?: string | null;
     payerUid: string;
     orgId: string;
     createdAt: string;
@@ -172,7 +176,14 @@ declare class PaymentClient {
     private timeout?;
     constructor(options: PaymentClientOptions);
     createPayment(request: CreatePaymentRequest): Promise<CreatePaymentResponse>;
-    getPayment(paymentId: string): Promise<PaymentResponse | null>;
+    /**
+     * Get payment status and details.
+     * @param paymentId - Payment ID
+     * @param options.sync - When true, asks the API to fetch latest status from the provider (e.g. after redirect). Use on first request after returning from Vipps/redirect.
+     */
+    getPayment(paymentId: string, options?: {
+        sync?: boolean;
+    }): Promise<PaymentResponse | null>;
     getReceipt(paymentId: string): Promise<PaymentReceiptResponse | null>;
     getTotalAmountByPrefix(prefix: string): Promise<number>;
     getPaymentMethods(options?: GetPaymentMethodsOptions): Promise<PaymentMethodsConfigResponse>;

package/dist/index.d.ts

@@ -64,6 +64,10 @@ interface PaymentResponse {
     amount: number;
     currency: string;
     status: string;
+    /** Payment method used (e.g. "vipps", "scheme") when known from provider. */
+    paymentMethod?: string | null;
+    /** Raw status from the provider (e.g. "AUTHORISED", "CANCELLED") when known. */
+    providerStatus?: string | null;
     payerUid: string;
     orgId: string;
     createdAt: string;
@@ -172,7 +176,14 @@ declare class PaymentClient {
     private timeout?;
     constructor(options: PaymentClientOptions);
     createPayment(request: CreatePaymentRequest): Promise<CreatePaymentResponse>;
-    getPayment(paymentId: string): Promise<PaymentResponse | null>;
+    /**
+     * Get payment status and details.
+     * @param paymentId - Payment ID
+     * @param options.sync - When true, asks the API to fetch latest status from the provider (e.g. after redirect). Use on first request after returning from Vipps/redirect.
+     */
+    getPayment(paymentId: string, options?: {
+        sync?: boolean;
+    }): Promise<PaymentResponse | null>;
     getReceipt(paymentId: string): Promise<PaymentReceiptResponse | null>;
     getTotalAmountByPrefix(prefix: string): Promise<number>;
     getPaymentMethods(options?: GetPaymentMethodsOptions): Promise<PaymentMethodsConfigResponse>;

package/dist/index.js

@@ -56,13 +56,19 @@ var PaymentClient = class {
     }
     return await response.json();
   }
-  async getPayment(paymentId) {
+  /**
+   * Get payment status and details.
+   * @param paymentId - Payment ID
+   * @param options.sync - When true, asks the API to fetch latest status from the provider (e.g. after redirect). Use on first request after returning from Vipps/redirect.
+   */
+  async getPayment(paymentId, options) {
     const token = await this.getAuthToken();
     const controller = new AbortController();
     if (this.timeout) {
       setTimeout(() => controller.abort(), this.timeout);
     }
-    const response = await fetch(`${this.baseUrl}/api/v1/payments/${paymentId}`, {
+    const url = options?.sync ? `${this.baseUrl}/api/v1/payments/${paymentId}?sync=true` : `${this.baseUrl}/api/v1/payments/${paymentId}`;
+    const response = await fetch(url, {
       headers: {
         "Authorization": `Bearer ${token}`,
         "X-Tenant-ID": this.tenantId

package/dist/index.mjs

@@ -30,13 +30,19 @@ var PaymentClient = class {
     }
     return await response.json();
   }
-  async getPayment(paymentId) {
+  /**
+   * Get payment status and details.
+   * @param paymentId - Payment ID
+   * @param options.sync - When true, asks the API to fetch latest status from the provider (e.g. after redirect). Use on first request after returning from Vipps/redirect.
+   */
+  async getPayment(paymentId, options) {
     const token = await this.getAuthToken();
     const controller = new AbortController();
     if (this.timeout) {
       setTimeout(() => controller.abort(), this.timeout);
     }
-    const response = await fetch(`${this.baseUrl}/api/v1/payments/${paymentId}`, {
+    const url = options?.sync ? `${this.baseUrl}/api/v1/payments/${paymentId}?sync=true` : `${this.baseUrl}/api/v1/payments/${paymentId}`;
+    const response = await fetch(url, {
       headers: {
         "Authorization": `Bearer ${token}`,
         "X-Tenant-ID": this.tenantId

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bcc-code/payment-client",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Client SDK for BCC Payment Orchestrator API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",