@augustusbank/typescript-sdk 0.21.0 → 0.22.1

package/src/resources/deposits.ts

@@ -34,55 +34,45 @@ export interface DepositRetrieveResponse {
   id: string;
 
   /**
-   * Amount as a string decimal (e.g. "100.50").
+   * ID of the account that was credited with the deposit.
    */
-  amount: string;
+  account_id: string;
 
   /**
-   * Reference visible on the bank statement, or null when not applicable.
+   * Amount as a string decimal (e.g. "100.50").
    */
-  bank_statement_reference: string | null;
+  amount: string;
 
   /**
-   * ISO 8601 UTC timestamp when the deposit was created.
+   * ID of the counterparty that sent the money, or null when not known.
    */
-  created_at: string;
+  counterparty_id: string | null;
 
   /**
-   * Supported fiat or crypto currency code for the deposit amount.
+   * Currency code (ISO 4217 or crypto).
    */
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
-   * ID of the merchant account that received the deposit.
-   */
-  destination_account_id: string;
-
-  /**
-   * Payment rail or blockchain used for the deposit, or null when unknown.
+   * Payment scheme or blockchain used for the deposit, or null when unknown.
    */
   rail:
+    | 'sepa'
     | 'sepa_instant'
     | 'faster_payments'
-    | 'sepa'
-    | 'elixir'
-    | 'express_elixir'
-    | 'sek_account_to_account'
-    | 'sumclearing'
-    | 'straksclearing'
     | 'swift'
     | 'internal'
     | 'target'
     | 'ach'
     | 'fedwire'
-    | 'btc'
-    | 'btc_testnet4'
-    | 'eth'
-    | 'eth_sepolia'
-    | 'sol'
-    | 'sol_devnet'
-    | 'matic'
-    | 'matic_amoy'
+    | 'bitcoin'
+    | 'bitcoin_testnet4'
+    | 'ethereum'
+    | 'ethereum_sepolia'
+    | 'solana'
+    | 'solana_devnet'
+    | 'polygon'
+    | 'polygon_amoy'
     | null;
 
   /**
@@ -91,21 +81,24 @@ export interface DepositRetrieveResponse {
   returns: Array<string>;
 
   /**
-   * Counterparty bank account or crypto wallet that sent the funds.
+   * ISO 8601 UTC timestamp when the deposit was settled.
    */
-  source:
-    | DepositRetrieveResponse.Iban
-    | DepositRetrieveResponse.UkSortCode
-    | DepositRetrieveResponse.Aba
-    | DepositRetrieveResponse.Wallet;
+  settled_at: string;
 
   /**
    * Current status of the deposit.
    */
-  status: 'received' | 'in_return' | 'returned' | 'return_failed' | 'return_returned';
+  status: 'settled';
+
+  /**
+   * Reference used to track the payment across the payment network, such as the UETR
+   * for SWIFT payments.
+   */
+  tracking_reference: string | null;
 
   /**
-   * Transaction hash for crypto deposits, or null when not known.
+   * Transaction hash for crypto deposits, or null when not known. Only blockchain
+   * rails support this field.
    */
   tx_hash: string | null;
 
@@ -115,102 +108,10 @@ export interface DepositRetrieveResponse {
   type: 'deposit';
 
   /**
-   * ISO 8601 UTC timestamp when the deposit was last updated.
+   * Unstructured remittance information attached to the transfer. Not all rails
+   * support this field.
    */
-  updated_at: string;
-}
-
-export namespace DepositRetrieveResponse {
-  export interface Iban {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * Bank Identifier Code, or null if not provided.
-     */
-    bic: string | null;
-
-    /**
-     * International Bank Account Number.
-     */
-    iban: string;
-
-    /**
-     * Discriminator for IBAN source.
-     */
-    type: 'iban';
-  }
-
-  export interface UkSortCode {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * UK account number (8 digits).
-     */
-    account_number: string;
-
-    /**
-     * UK sort code (6 digits).
-     */
-    sort_code: string;
-
-    /**
-     * Discriminator for UK sort code source.
-     */
-    type: 'sort_code';
-  }
-
-  export interface Aba {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * Bank account number.
-     */
-    account_number: string;
-
-    /**
-     * ABA routing number (9 digits).
-     */
-    routing_number: string;
-
-    /**
-     * Discriminator for ABA wire source.
-     */
-    type: 'aba';
-  }
-
-  export interface Wallet {
-    /**
-     * Wallet address on the specified blockchain.
-     */
-    address: string;
-
-    /**
-     * Blockchain network for the crypto wallet.
-     */
-    blockchain:
-      | 'bitcoin'
-      | 'ethereum'
-      | 'solana'
-      | 'polygon'
-      | 'bitcoin_testnet4'
-      | 'ethereum_sepolia'
-      | 'solana_devnet'
-      | 'polygon_amoy';
-
-    /**
-     * Discriminator for crypto wallet source.
-     */
-    type: 'crypto_wallet';
-  }
+  unstructured_remittance_information: string | null;
 }
 
 export interface DepositListResponse {
@@ -220,55 +121,45 @@ export interface DepositListResponse {
   id: string;
 
   /**
-   * Amount as a string decimal (e.g. "100.50").
+   * ID of the account that was credited with the deposit.
    */
-  amount: string;
+  account_id: string;
 
   /**
-   * Reference visible on the bank statement, or null when not applicable.
+   * Amount as a string decimal (e.g. "100.50").
    */
-  bank_statement_reference: string | null;
+  amount: string;
 
   /**
-   * ISO 8601 UTC timestamp when the deposit was created.
+   * ID of the counterparty that sent the money, or null when not known.
    */
-  created_at: string;
+  counterparty_id: string | null;
 
   /**
-   * Supported fiat or crypto currency code for the deposit amount.
+   * Currency code (ISO 4217 or crypto).
    */
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
-   * ID of the merchant account that received the deposit.
-   */
-  destination_account_id: string;
-
-  /**
-   * Payment rail or blockchain used for the deposit, or null when unknown.
+   * Payment scheme or blockchain used for the deposit, or null when unknown.
    */
   rail:
+    | 'sepa'
     | 'sepa_instant'
     | 'faster_payments'
-    | 'sepa'
-    | 'elixir'
-    | 'express_elixir'
-    | 'sek_account_to_account'
-    | 'sumclearing'
-    | 'straksclearing'
     | 'swift'
     | 'internal'
     | 'target'
     | 'ach'
     | 'fedwire'
-    | 'btc'
-    | 'btc_testnet4'
-    | 'eth'
-    | 'eth_sepolia'
-    | 'sol'
-    | 'sol_devnet'
-    | 'matic'
-    | 'matic_amoy'
+    | 'bitcoin'
+    | 'bitcoin_testnet4'
+    | 'ethereum'
+    | 'ethereum_sepolia'
+    | 'solana'
+    | 'solana_devnet'
+    | 'polygon'
+    | 'polygon_amoy'
     | null;
 
   /**
@@ -277,21 +168,24 @@ export interface DepositListResponse {
   returns: Array<string>;
 
   /**
-   * Counterparty bank account or crypto wallet that sent the funds.
+   * ISO 8601 UTC timestamp when the deposit was settled.
    */
-  source:
-    | DepositListResponse.Iban
-    | DepositListResponse.UkSortCode
-    | DepositListResponse.Aba
-    | DepositListResponse.Wallet;
+  settled_at: string;
 
   /**
    * Current status of the deposit.
    */
-  status: 'received' | 'in_return' | 'returned' | 'return_failed' | 'return_returned';
+  status: 'settled';
+
+  /**
+   * Reference used to track the payment across the payment network, such as the UETR
+   * for SWIFT payments.
+   */
+  tracking_reference: string | null;
 
   /**
-   * Transaction hash for crypto deposits, or null when not known.
+   * Transaction hash for crypto deposits, or null when not known. Only blockchain
+   * rails support this field.
    */
   tx_hash: string | null;
 
@@ -301,123 +195,26 @@ export interface DepositListResponse {
   type: 'deposit';
 
   /**
-   * ISO 8601 UTC timestamp when the deposit was last updated.
+   * Unstructured remittance information attached to the transfer. Not all rails
+   * support this field.
    */
-  updated_at: string;
-}
-
-export namespace DepositListResponse {
-  export interface Iban {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * Bank Identifier Code, or null if not provided.
-     */
-    bic: string | null;
-
-    /**
-     * International Bank Account Number.
-     */
-    iban: string;
-
-    /**
-     * Discriminator for IBAN source.
-     */
-    type: 'iban';
-  }
-
-  export interface UkSortCode {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * UK account number (8 digits).
-     */
-    account_number: string;
-
-    /**
-     * UK sort code (6 digits).
-     */
-    sort_code: string;
-
-    /**
-     * Discriminator for UK sort code source.
-     */
-    type: 'sort_code';
-  }
-
-  export interface Aba {
-    /**
-     * Name of the account holder.
-     */
-    account_holder_name: string;
-
-    /**
-     * Bank account number.
-     */
-    account_number: string;
-
-    /**
-     * ABA routing number (9 digits).
-     */
-    routing_number: string;
-
-    /**
-     * Discriminator for ABA wire source.
-     */
-    type: 'aba';
-  }
-
-  export interface Wallet {
-    /**
-     * Wallet address on the specified blockchain.
-     */
-    address: string;
-
-    /**
-     * Blockchain network for the crypto wallet.
-     */
-    blockchain:
-      | 'bitcoin'
-      | 'ethereum'
-      | 'solana'
-      | 'polygon'
-      | 'bitcoin_testnet4'
-      | 'ethereum_sepolia'
-      | 'solana_devnet'
-      | 'polygon_amoy';
-
-    /**
-     * Discriminator for crypto wallet source.
-     */
-    type: 'crypto_wallet';
-  }
+  unstructured_remittance_information: string | null;
 }
 
 export interface DepositListParams extends CursorPageParams {
-  created_at?: DepositListParams.CreatedAt;
-
-  /**
-   * Filter by deposit status.
-   */
-  status?: 'received' | 'in_return' | 'returned' | 'return_failed' | 'return_returned';
+  settled_at?: DepositListParams.SettledAt;
 }
 
 export namespace DepositListParams {
-  export interface CreatedAt {
+  export interface SettledAt {
     /**
-     * Include deposits whose created_at is greater than or equal to this ISO 8601
+     * Include deposits whose settled_at is greater than or equal to this ISO 8601
      * timestamp.
      */
     gte?: string;
 
     /**
-     * Include deposits whose created_at is less than or equal to this ISO 8601
+     * Include deposits whose settled_at is less than or equal to this ISO 8601
      * timestamp.
      */
     lte?: string;

package/src/resources/events.ts

@@ -55,15 +55,17 @@ export interface EventRetrieveResponse {
    * Event type.
    */
   event_type:
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'
@@ -104,15 +106,17 @@ export interface EventListResponse {
    * Event type.
    */
   event_type:
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'
@@ -133,15 +137,17 @@ export interface EventListParams extends CursorPageParams {
    * Filter by event type.
    */
   event_type?:
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'

package/src/resources/index.ts

@@ -19,6 +19,7 @@ export {
   type AccountProgramListResponse,
   type AccountProgramRetrieveBalanceResponse,
   type AccountProgramListParams,
+  type AccountProgramRetrieveBalanceParams,
   type AccountProgramListResponsesCursorPage,
 } from './account-programs';
 export {
@@ -33,6 +34,7 @@ export {
   type AccountCreateParams,
   type AccountListParams,
   type AccountCloseParams,
+  type AccountRetrieveBalanceParams,
   type AccountListResponsesCursorPage,
 } from './accounts';
 export {
@@ -44,6 +46,18 @@ export {
   type ConversionListParams,
   type ConversionListResponsesCursorPage,
 } from './conversions';
+export {
+  Counterparties,
+  type CounterpartyCreateResponse,
+  type CounterpartyRetrieveResponse,
+  type CounterpartyUpdateResponse,
+  type CounterpartyListResponse,
+  type CounterpartyBlockResponse,
+  type CounterpartyCreateParams,
+  type CounterpartyUpdateParams,
+  type CounterpartyListParams,
+  type CounterpartyListResponsesCursorPage,
+} from './counterparties';
 export {
   Deposits,
   type DepositRetrieveResponse,
@@ -78,6 +92,7 @@ export {
   type ReturnListResponsesCursorPage,
 } from './returns';
 export { Scopes, type ScopeListResponse } from './scopes';
+export { Simulations } from './simulations/simulations';
 export {
   Transactions,
   type TransactionRetrieveResponse,
@@ -108,15 +123,17 @@ export {
 } from './webhook-subscriptions';
 export {
   Webhooks,
-  type PayoutCreatedWebhookEvent,
   type PayoutInitiatedWebhookEvent,
-  type PayoutPaidWebhookEvent,
+  type PayoutSubmittedWebhookEvent,
+  type PayoutSentWebhookEvent,
   type PayoutFailedWebhookEvent,
+  type PayoutReturnedWebhookEvent,
   type ReturnInitiatedWebhookEvent,
-  type ReturnPaidWebhookEvent,
+  type ReturnSubmittedWebhookEvent,
+  type ReturnSentWebhookEvent,
   type ReturnFailedWebhookEvent,
   type ReturnReturnedWebhookEvent,
-  type DepositReceivedWebhookEvent,
+  type DepositSettledWebhookEvent,
   type ConversionCreatedWebhookEvent,
   type ConversionCompletedWebhookEvent,
   type ConversionFailedWebhookEvent,