@augustusbank/typescript-sdk 0.32.0 → 0.33.0

package/resources/webhooks.d.ts

@@ -3070,9 +3070,9 @@ export declare namespace CounterpartyPendingWebhookEvent {
          */
         email: string | null;
         /**
-         * Whether the counterparty is a business or an individual.
+         * Classification of the counterparty.
          */
-        entity_type: 'business' | 'individual';
+        entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
         /**
          * Financial address of the counterparty.
          */
@@ -3294,9 +3294,9 @@ export declare namespace CounterpartyActiveWebhookEvent {
          */
         email: string | null;
         /**
-         * Whether the counterparty is a business or an individual.
+         * Classification of the counterparty.
          */
-        entity_type: 'business' | 'individual';
+        entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
         /**
          * Financial address of the counterparty.
          */
@@ -3518,9 +3518,9 @@ export declare namespace CounterpartyRejectedWebhookEvent {
          */
         email: string | null;
         /**
-         * Whether the counterparty is a business or an individual.
+         * Classification of the counterparty.
          */
-        entity_type: 'business' | 'individual';
+        entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
         /**
          * Financial address of the counterparty.
          */
@@ -3742,9 +3742,9 @@ export declare namespace CounterpartyBlockedWebhookEvent {
          */
         email: string | null;
         /**
-         * Whether the counterparty is a business or an individual.
+         * Classification of the counterparty.
          */
-        entity_type: 'business' | 'individual';
+        entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
         /**
          * Financial address of the counterparty.
          */
@@ -3966,9 +3966,9 @@ export declare namespace CounterpartyUnblockedWebhookEvent {
          */
         email: string | null;
         /**
-         * Whether the counterparty is a business or an individual.
+         * Classification of the counterparty.
          */
-        entity_type: 'business' | 'individual';
+        entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
         /**
          * Financial address of the counterparty.
          */
@@ -4190,9 +4190,9 @@ export declare namespace CounterpartyUpdatedWebhookEvent {
          */
         email: string | null;
         /**
-         * Whether the counterparty is a business or an individual.
+         * Classification of the counterparty.
          */
-        entity_type: 'business' | 'individual';
+        entity_type: 'business' | 'individual' | 'non_profit' | 'sole_proprietor';
         /**
          * Financial address of the counterparty.
          */
@@ -4370,6 +4370,188 @@ export declare namespace CounterpartyUpdatedWebhookEvent {
         }
     }
 }
+export interface PayoutTrackingEventCreatedWebhookEvent {
+    /**
+     * Unique identifier for the event. Stable across retries.
+     */
+    id: string;
+    /**
+     * API version the payload was rendered at. Stable across retries and redeliveries.
+     */
+    api_version: string;
+    /**
+     * ISO 8601 UTC timestamp when the event was created.
+     */
+    date: string;
+    /**
+     * Full resource snapshot at the time of the event.
+     */
+    payload: PayoutTrackingEventCreatedWebhookEvent.Payload;
+    /**
+     * Event type in resource.action format.
+     */
+    type: 'payout_tracking_event.created';
+}
+export declare namespace PayoutTrackingEventCreatedWebhookEvent {
+    /**
+     * Full resource snapshot at the time of the event.
+     */
+    interface Payload {
+        /**
+         * Unique identifier of the tracking event.
+         */
+        id: string;
+        /**
+         * Amount credited to the beneficiary. Set only on a credited event, otherwise
+         * null.
+         */
+        beneficiary_amount: Payload.BeneficiaryAmount | null;
+        /**
+         * ISO 8601 UTC timestamp when Augustus recorded the event.
+         */
+        created_at: string;
+        /**
+         * Fee deducted at this step. Null when none was reported.
+         */
+        fee: Payload.Fee | null;
+        /**
+         * Institution that acted on or reported this step. Null when unknown.
+         */
+        institution: Payload.Institution | null;
+        /**
+         * Whether Augustus considers delivery finished. A later event, such as returned,
+         * can still follow.
+         */
+        is_terminal: boolean;
+        /**
+         * Normalized point in the payout journey. New values may be added.
+         */
+        milestone: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned' | 'accepted' | 'settled' | 'forwarded' | 'credited' | 'rejected' | 'returning' | 'visibility_lost' | 'other';
+        /**
+         * Raw network status. Null when the step has none.
+         */
+        network_status: Payload.NetworkStatus | null;
+        /**
+         * ISO 8601 UTC timestamp when the step happened. Null when the source has no
+         * timestamp. Can be out of order with sequence.
+         */
+        occurred_at: string | null;
+        /**
+         * ID of the payout this event belongs to.
+         */
+        payout_id: string;
+        /**
+         * How far Augustus can follow the payout: end_to_end when the rail confirms the
+         * beneficiary credit, network when it only confirms settlement. New values may be
+         * added.
+         */
+        scope: 'network' | 'end_to_end';
+        /**
+         * Gap-free counter per payout, in the order Augustus recorded the events. A gap
+         * means you missed a recorded event, such as a dropped webhook. A sequence without
+         * gaps does not mean every network step was observed.
+         */
+        sequence: number;
+        /**
+         * Where Augustus learned this step: augustus for steps Augustus records itself,
+         * swift_gpi for SWIFT gpi statuses, other for any other source. New values may be
+         * added.
+         */
+        source: 'augustus' | 'swift_gpi' | 'other';
+        /**
+         * Reason for the current state. Null when none applies.
+         */
+        status_reason: Payload.StatusReason | null;
+        /**
+         * Resource type discriminator.
+         */
+        type: 'payout_tracking_event';
+    }
+    namespace Payload {
+        /**
+         * Amount credited to the beneficiary. Set only on a credited event, otherwise
+         * null.
+         */
+        interface BeneficiaryAmount {
+            /**
+             * Credited amount as a string decimal (e.g. "100.50").
+             */
+            amount: string;
+            /**
+             * ISO 4217 currency code of the credited amount.
+             */
+            currency: string;
+        }
+        /**
+         * Fee deducted at this step. Null when none was reported.
+         */
+        interface Fee {
+            /**
+             * Fee amount as a string decimal (e.g. "10.00").
+             */
+            amount: string;
+            /**
+             * Who bears the charges under the payment charge agreement: debtor (OUR), creditor
+             * (BEN), shared (SHA), or other for any other agreement. New values may be added.
+             */
+            borne_by: 'debtor' | 'creditor' | 'shared' | 'other';
+            /**
+             * ISO 4217 currency code of the fee.
+             */
+            currency: string;
+        }
+        /**
+         * Institution that acted on or reported this step. Null when unknown.
+         */
+        interface Institution {
+            /**
+             * Identifier of the institution, typed by scheme.
+             */
+            identifier: Institution.Identifier;
+        }
+        namespace Institution {
+            /**
+             * Identifier of the institution, typed by scheme.
+             */
+            interface Identifier {
+                /**
+                 * Identifier scheme. Only bic today.
+                 */
+                type: 'bic';
+                /**
+                 * ISO 9362 Bank Identifier Code (8 or 11 characters).
+                 */
+                value: string;
+            }
+        }
+        /**
+         * Raw network status. Null when the step has none.
+         */
+        interface NetworkStatus {
+            /**
+             * Status code reported by the network, such as ACSP, ACSC, ACCC or RJCT.
+             */
+            code: string;
+            /**
+             * Reason code for the status, such as G000. Null when the network reports none.
+             */
+            reason_code: string | null;
+        }
+        /**
+         * Reason for the current state. Null when none applies.
+         */
+        interface StatusReason {
+            /**
+             * Normalized reason code assigned by Augustus. New codes may be added.
+             */
+            code: string;
+            /**
+             * Explanation of the reason code, written by Augustus.
+             */
+            description: string;
+        }
+    }
+}
 export interface PingTestWebhookEvent {
     /**
      * Unique identifier for the event. Stable across retries.
@@ -4420,8 +4602,8 @@ export declare namespace PingTestWebhookEvent {
         type: 'ping';
     }
 }
-export type UnwrapWebhookEvent = PayoutInitiatedWebhookEvent | PayoutSubmittedWebhookEvent | PayoutSentWebhookEvent | PayoutFailedWebhookEvent | PayoutReturnedWebhookEvent | ReturnInitiatedWebhookEvent | ReturnSubmittedWebhookEvent | ReturnSentWebhookEvent | ReturnFailedWebhookEvent | ReturnReturnedWebhookEvent | DepositSettledWebhookEvent | ConversionCreatedWebhookEvent | ConversionCompletedWebhookEvent | ConversionFailedWebhookEvent | AccountHolderActiveWebhookEvent | AccountHolderClosedWebhookEvent | CounterpartyPendingWebhookEvent | CounterpartyActiveWebhookEvent | CounterpartyRejectedWebhookEvent | CounterpartyBlockedWebhookEvent | CounterpartyUnblockedWebhookEvent | CounterpartyUpdatedWebhookEvent | PingTestWebhookEvent;
+export type UnwrapWebhookEvent = PayoutInitiatedWebhookEvent | PayoutSubmittedWebhookEvent | PayoutSentWebhookEvent | PayoutFailedWebhookEvent | PayoutReturnedWebhookEvent | ReturnInitiatedWebhookEvent | ReturnSubmittedWebhookEvent | ReturnSentWebhookEvent | ReturnFailedWebhookEvent | ReturnReturnedWebhookEvent | DepositSettledWebhookEvent | ConversionCreatedWebhookEvent | ConversionCompletedWebhookEvent | ConversionFailedWebhookEvent | AccountHolderActiveWebhookEvent | AccountHolderClosedWebhookEvent | CounterpartyPendingWebhookEvent | CounterpartyActiveWebhookEvent | CounterpartyRejectedWebhookEvent | CounterpartyBlockedWebhookEvent | CounterpartyUnblockedWebhookEvent | CounterpartyUpdatedWebhookEvent | PayoutTrackingEventCreatedWebhookEvent | PingTestWebhookEvent;
 export declare namespace Webhooks {
-    export { type PayoutInitiatedWebhookEvent as PayoutInitiatedWebhookEvent, type PayoutSubmittedWebhookEvent as PayoutSubmittedWebhookEvent, type PayoutSentWebhookEvent as PayoutSentWebhookEvent, type PayoutFailedWebhookEvent as PayoutFailedWebhookEvent, type PayoutReturnedWebhookEvent as PayoutReturnedWebhookEvent, type ReturnInitiatedWebhookEvent as ReturnInitiatedWebhookEvent, type ReturnSubmittedWebhookEvent as ReturnSubmittedWebhookEvent, type ReturnSentWebhookEvent as ReturnSentWebhookEvent, type ReturnFailedWebhookEvent as ReturnFailedWebhookEvent, type ReturnReturnedWebhookEvent as ReturnReturnedWebhookEvent, type DepositSettledWebhookEvent as DepositSettledWebhookEvent, type ConversionCreatedWebhookEvent as ConversionCreatedWebhookEvent, type ConversionCompletedWebhookEvent as ConversionCompletedWebhookEvent, type ConversionFailedWebhookEvent as ConversionFailedWebhookEvent, type AccountHolderActiveWebhookEvent as AccountHolderActiveWebhookEvent, type AccountHolderClosedWebhookEvent as AccountHolderClosedWebhookEvent, type CounterpartyPendingWebhookEvent as CounterpartyPendingWebhookEvent, type CounterpartyActiveWebhookEvent as CounterpartyActiveWebhookEvent, type CounterpartyRejectedWebhookEvent as CounterpartyRejectedWebhookEvent, type CounterpartyBlockedWebhookEvent as CounterpartyBlockedWebhookEvent, type CounterpartyUnblockedWebhookEvent as CounterpartyUnblockedWebhookEvent, type CounterpartyUpdatedWebhookEvent as CounterpartyUpdatedWebhookEvent, type PingTestWebhookEvent as PingTestWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, };
+    export { type PayoutInitiatedWebhookEvent as PayoutInitiatedWebhookEvent, type PayoutSubmittedWebhookEvent as PayoutSubmittedWebhookEvent, type PayoutSentWebhookEvent as PayoutSentWebhookEvent, type PayoutFailedWebhookEvent as PayoutFailedWebhookEvent, type PayoutReturnedWebhookEvent as PayoutReturnedWebhookEvent, type ReturnInitiatedWebhookEvent as ReturnInitiatedWebhookEvent, type ReturnSubmittedWebhookEvent as ReturnSubmittedWebhookEvent, type ReturnSentWebhookEvent as ReturnSentWebhookEvent, type ReturnFailedWebhookEvent as ReturnFailedWebhookEvent, type ReturnReturnedWebhookEvent as ReturnReturnedWebhookEvent, type DepositSettledWebhookEvent as DepositSettledWebhookEvent, type ConversionCreatedWebhookEvent as ConversionCreatedWebhookEvent, type ConversionCompletedWebhookEvent as ConversionCompletedWebhookEvent, type ConversionFailedWebhookEvent as ConversionFailedWebhookEvent, type AccountHolderActiveWebhookEvent as AccountHolderActiveWebhookEvent, type AccountHolderClosedWebhookEvent as AccountHolderClosedWebhookEvent, type CounterpartyPendingWebhookEvent as CounterpartyPendingWebhookEvent, type CounterpartyActiveWebhookEvent as CounterpartyActiveWebhookEvent, type CounterpartyRejectedWebhookEvent as CounterpartyRejectedWebhookEvent, type CounterpartyBlockedWebhookEvent as CounterpartyBlockedWebhookEvent, type CounterpartyUnblockedWebhookEvent as CounterpartyUnblockedWebhookEvent, type CounterpartyUpdatedWebhookEvent as CounterpartyUpdatedWebhookEvent, type PayoutTrackingEventCreatedWebhookEvent as PayoutTrackingEventCreatedWebhookEvent, type PingTestWebhookEvent as PingTestWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, };
 }
 //# sourceMappingURL=webhooks.d.ts.map