@payabli/component-contracts 0.2.0 → 0.3.0

package/README.md

@@ -386,16 +386,21 @@ const payin = payabli.create('payin', {
 #### Success and errors
 
 `success` and React's `onSuccess` report confirmed success only. `submit()` resolves with the same result data.
-`PayInSuccessPayload.transactionId` identifies a pay or auth transaction when present.
-The wire success data remains an open record. The SDK preserves fields it does not interpret.
-
-For tokenize sessions, `SUBMIT_RESULT.data`, the `success` event, and the `submit()` result contain:
+The payload is `PayInSuccessPayload`, one closed shape for every operation:
 
 ```ts
-{ referenceId: string, customerId?: number, methodReferenceId?: string }
+{
+  operation: 'pay' | 'auth' | 'tokenize',
+  method: 'card' | 'ach' | 'check' | 'applepay' | 'googlepay',
+  transactionId?: string,   // pay, auth
+  storedMethodId?: string,  // tokenize; pay or auth that saved the method
+  customerId?: number,      // when the API created or matched a customer
+  paymentMethod?: { maskedAccount?, accountType?, expiration?, holderName? },
+  amount?: { total: number, serviceFee?: number, currency?: string }, // pay, auth
+}
 ```
 
-`referenceId` is the saved payment method ID, not a transaction ID. `PayInSuccessPayload` declares it as an optional string.
+`transactionId` is the Payabli transaction id. `storedMethodId` is the saved payment method id: pass it back as `storedMethodId` on a later payment. The API response body does not reach the page.
 
 A failed `SUBMIT_RESULT` rejects `submit()` and emits `error`, mapped to React's `onError`.
 Errors have `{ code, message, recoverable, details? }`. The SDK forwards the code and message unchanged.

package/dist/payin/schema.d.ts

@@ -92,13 +92,41 @@ export declare const payinEvents: {
         vendorId: z.ZodMiniString<string>;
     }, z.core.$strip>;
 };
+/** The session operation the payload reports on. */
+export type PayInOperation = 'pay' | 'auth' | 'tokenize';
 /**
- * SUBMIT_RESULT.data for PayIn. Open on purpose: the transaction result grows
- * fields the SDK does not interpret, and it forwards all of them.
+ * SUBMIT_RESULT.data for PayIn: the `success` event payload and the `submit()`
+ * result. One closed shape for every operation, so a partner handles the
+ * result without branching on the operation. payhub builds it from the API
+ * result; the API body itself never reaches the page.
  */
 export type PayInSuccessPayload = {
-    /** The transaction ID for pay or auth sessions. */
+    operation: PayInOperation;
+    /** The method the buyer used. */
+    method: PaymentMethodName;
+    /** The Payabli transaction id. Present for `pay` and `auth`. */
     transactionId?: string;
-    /** The saved payment method ID for tokenize sessions. */
-    referenceId?: string;
-} & Record<string, unknown>;
+    /**
+     * The saved payment method id. Present for `tokenize`, and for `pay` or `auth`
+     * when the session saved the method. Pass it back as `storedMethodId` on a
+     * later payment.
+     */
+    storedMethodId?: string;
+    /** The Payabli customer id when the API created or matched a customer. */
+    customerId?: number;
+    paymentMethod?: {
+        /** The account with every digit but the last four hidden, for example `5XXXXXXXXXXX0055`. */
+        maskedAccount?: string;
+        /** The card brand (`mastercard`) or the bank account type (`checking`). */
+        accountType?: string;
+        /** The card expiration, `MM/YY`. */
+        expiration?: string;
+        holderName?: string;
+    };
+    /** The charged or authorized amount. Present for `pay` and `auth`. */
+    amount?: {
+        total: number;
+        serviceFee?: number;
+        currency?: string;
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payabli/component-contracts",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Wire schemas, component registry, and partner-facing types shared by the Payabli embedded components SDK and payhub.",
   "private": false,
   "license": "MIT",