@t-0/provider-sdk 1.1.23 → 1.1.24

package/lib/esm/common/gen/tzero/v1/payment/provider_pb.d.ts

@@ -49,8 +49,7 @@ export type AppendLedgerEntriesRequest_Transaction = Message<"tzero.v1.payment.A
     entries: AppendLedgerEntriesRequest_LedgerEntry[];
     /**
      * *
-     * transaction_details is a oneof field that contains details about the transaction.
-     * It can be one of the following: PayIn, PayoutReservation, Payout, ProviderSettlement, FeeSettlement, PayoutReservationRelease.
+     * Identifies which kind of transaction these ledger entries describe.
      *
      * @generated from oneof tzero.v1.payment.AppendLedgerEntriesRequest.Transaction.transaction_details
      */
@@ -279,7 +278,7 @@ export declare const AppendLedgerEntriesResponseSchema: GenMessage<AppendLedgerE
 export type PayoutRequest = Message<"tzero.v1.payment.PayoutRequest"> & {
     /**
      * *
-     * payment id assigned by the network (provider should store this id to provide details in UpdatePayout later)
+     * Payment id assigned by the network. Store it to reference this payment in FinalizePayout later.
      *
      * @generated from field: uint64 payment_id = 10;
      */
@@ -318,8 +317,7 @@ export type PayoutRequest = Message<"tzero.v1.payment.PayoutRequest"> & {
     amount?: Decimal | undefined;
     /**
      * *
-     * payout_method is the payment method for the payout, e.g. bank transfer, crypto transfer, etc.
-     * This is used to specify how the payout should be made.
+     * Payment details specifying how the payout should be made (bank transfer, crypto transfer, etc.).
      *
      * @generated from field: optional tzero.v1.common.PaymentDetails payout_details = 60;
      */
@@ -363,7 +361,7 @@ export type PayoutRequest_TravelRuleData = Message<"tzero.v1.payment.PayoutReque
     /**
      * *
      * IVMS101 travel rule data of the originating provider's legal entity.
-     * Resolved by the network from the entity specified in CreatePaymentRequest.
+     * Taken from the originator entity in the corresponding CreatePaymentRequest.
      *
      * @generated from field: optional ivms101.Person originator_provider = 30;
      */
@@ -865,7 +863,7 @@ export type ApprovePaymentQuoteResponse_Rejected = Message<"tzero.v1.payment.App
 export declare const ApprovePaymentQuoteResponse_RejectedSchema: GenMessage<ApprovePaymentQuoteResponse_Rejected>;
 /**
  * *
- * This service must be implemented by the provider.
+ * Provider surface for executing payouts and receiving payment, limit, and ledger updates.
  *
  * All methods of this service must be idempotent, meaning they are safe to retry and multiple calls with the same parameters must not have additional effect.
  *
@@ -874,7 +872,7 @@ export declare const ApprovePaymentQuoteResponse_RejectedSchema: GenMessage<Appr
 export declare const ProviderService: GenService<{
     /**
      * *
-     * Network instructs the provider to execute a payout to the recipient.
+     * Execute a payout to the recipient.
      * This method should be idempotent, meaning that multiple calls with the same parameters will have no additional effect.
      *
      * @generated from rpc tzero.v1.payment.ProviderService.PayOut
@@ -886,7 +884,7 @@ export declare const ProviderService: GenService<{
     };
     /**
      * *
-     * Network provides an update on the status of a payment. This can be either a success or a failure.
+     * Reports the current status of a payment — either a success or a failure.
      * This method should be idempotent, meaning that multiple calls with the same parameters will have no additional effect.
      *
      * @generated from rpc tzero.v1.payment.ProviderService.UpdatePayment
@@ -898,7 +896,7 @@ export declare const ProviderService: GenService<{
     };
     /**
      * *
-     * This rpc is used to notify the provider about the changes in credit limit and/or credit usage.
+     * Delivers updated credit limit and credit usage.
      *
      * @generated from rpc tzero.v1.payment.ProviderService.UpdateLimit
      */
@@ -909,7 +907,7 @@ export declare const ProviderService: GenService<{
     };
     /**
      * *
-     * Network can send all the updates about ledger entries of the provider's accounts. It can be used to
+     * Carries ledger-entry updates for the provider's accounts. It can be used to
      * keep track of the provider's exposure to other participants and other important financial events. (see the list in the message below)
      *
      * @generated from rpc tzero.v1.payment.ProviderService.AppendLedgerEntries
@@ -921,10 +919,8 @@ export declare const ProviderService: GenService<{
     };
     /**
      * *
-     * Pay-in provider approves the final pay-out quotes.
-     * This is the "Last Look" endpoint - it must be called after manual AML check completes
-     * (if one was required). It allows pay-in provider to verify and approve final rates
-     * before payment is executed.
+     * Approves the final pay-out quotes — the "Last Look" before payment executes.
+     * Applies after a manual AML check completes, when one was required.
      *
      * @generated from rpc tzero.v1.payment.ProviderService.ApprovePaymentQuotes
      */

package/lib/esm/common/gen/tzero/v1/payment/provider_pb.js

@@ -268,7 +268,7 @@ export const ApprovePaymentQuoteResponse_AcceptedSchema = /*@__PURE__*/ messageD
 export const ApprovePaymentQuoteResponse_RejectedSchema = /*@__PURE__*/ messageDesc(file_tzero_v1_payment_provider, 9, 1);
 /**
  * *
- * This service must be implemented by the provider.
+ * Provider surface for executing payouts and receiving payment, limit, and ledger updates.
  *
  * All methods of this service must be idempotent, meaning they are safe to retry and multiple calls with the same parameters must not have additional effect.
  *

package/lib/esm/common/gen/tzero/v1/payment_intent/beneficiary_pb.d.ts

@@ -57,7 +57,7 @@ export declare const PaymentIntentUpdateRequestSchema: GenMessage<PaymentIntentU
 export type PaymentIntentUpdateRequest_FundsReceived = Message<"tzero.v1.payment_intent.PaymentIntentUpdateRequest.FundsReceived"> & {
     /**
      * *
-     * The settlement amount credited to your balance.
+     * The settlement amount credited to the beneficiary balance.
      * This is calculated as: (source_amount / rate) - fix
      *
      * Note: Fees are NOT deducted from this amount. Fees are tracked
@@ -91,7 +91,7 @@ export type PaymentIntentUpdateRequest_FundsReceived = Message<"tzero.v1.payment
     /**
      * *
      * Pay-in's rail-native reference (SEPA EndToEndId, SWIFT UETR, PIX e2e_id), forwarded from ConfirmFundsReceived.
-     * Reconcile against your records; serves as the anchor for dispute resolution.
+     * Reconcile against the beneficiary's records; serves as the anchor for dispute resolution.
      *
      * @generated from field: string transaction_reference = 50;
      */
@@ -107,8 +107,8 @@ export type PaymentIntentUpdateRequest_FundsReceived = Message<"tzero.v1.payment
     /**
      * *
      * Flat USD surcharge retained by the pay-in provider per transfer.
-     * Already subtracted from settlement_amount. Surface to beneficiaries that
-     * need to audit the settlement math: settlement = (payment_amount / rate) - fix.
+     * Already subtracted from settlement_amount.
+     * Settlement is computed as (payment_amount / rate) - fix.
      *
      * @generated from field: tzero.v1.common.Decimal fix = 70;
      */
@@ -152,15 +152,14 @@ export type PaymentIntentUpdateResponse = Message<"tzero.v1.payment_intent.Payme
 export declare const PaymentIntentUpdateResponseSchema: GenMessage<PaymentIntentUpdateResponse>;
 /**
  * *
- * BeneficiaryService must be implemented by beneficiary providers to receive
- * notifications about payment intent status changes.
+ * Beneficiary provider surface for payment intent status notifications.
  *
  * Beneficiary providers are those who:
  * - Create payment intents via CreatePaymentIntent
  * - Receive settlement (in settlement currency via configured blockchain network)
  * - Need to be notified of payment status changes
  *
- * The network calls this service to notify the beneficiary when:
+ * Notifications are delivered when:
  * - Funds have been received from the payer by pay-in provider
  *
  * @generated from service tzero.v1.payment_intent.BeneficiaryService
@@ -170,8 +169,7 @@ export declare const BeneficiaryService: GenService<{
      * *
      * PaymentIntentUpdate notifies the beneficiary provider of status changes.
      *
-     * Idempotency: This endpoint must be idempotent. The network may retry
-     * delivery in case of failures or timeouts.
+     * Delivery is retried on failure or timeout; handling must be idempotent.
      *
      * @generated from rpc tzero.v1.payment_intent.BeneficiaryService.PaymentIntentUpdate
      */

package/lib/esm/common/gen/tzero/v1/payment_intent/beneficiary_pb.js

@@ -32,15 +32,14 @@ export const PaymentIntentUpdateRequest_FundsReceived_TravelRuleDataSchema = /*@
 export const PaymentIntentUpdateResponseSchema = /*@__PURE__*/ messageDesc(file_tzero_v1_payment_intent_beneficiary, 1);
 /**
  * *
- * BeneficiaryService must be implemented by beneficiary providers to receive
- * notifications about payment intent status changes.
+ * Beneficiary provider surface for payment intent status notifications.
  *
  * Beneficiary providers are those who:
  * - Create payment intents via CreatePaymentIntent
  * - Receive settlement (in settlement currency via configured blockchain network)
  * - Need to be notified of payment status changes
  *
- * The network calls this service to notify the beneficiary when:
+ * Notifications are delivered when:
  * - Funds have been received from the payer by pay-in provider
  *
  * @generated from service tzero.v1.payment_intent.BeneficiaryService

package/lib/esm/common/gen/tzero/v1/payment_intent/network_pb.d.ts

@@ -82,7 +82,7 @@ export type UpdateQuoteRequest_Quote_Band = Message<"tzero.v1.payment_intent.Upd
      */
     clientQuoteId: string;
     /**
-     * max amount of USD this quote is applicable for. Please look into documentation for valid amounts.
+     * Maximum amount of USD this band applies to.
      *
      * @generated from field: tzero.v1.common.Decimal max_amount = 40;
      */
@@ -233,7 +233,6 @@ export type GetQuoteResponse_Success_IndicativeQuote = Message<"tzero.v1.payment
     /**
      * *
      * The T-0 provider ID of the pay-in provider offering this quote.
-     * Providers can use this to identify counterparties.
      *
      * @generated from field: uint32 provider_id = 20;
      */
@@ -293,7 +292,6 @@ export type PaymentIntentPayInDetails = Message<"tzero.v1.payment_intent.Payment
     /**
      * *
      * The T-0 provider ID of the pay-in provider offering this quote.
-     * Providers can use this to identify counterparties.
      *
      * @generated from field: uint32 provider_id = 20;
      */
@@ -311,7 +309,7 @@ export type PaymentIntentPayInDetails = Message<"tzero.v1.payment_intent.Payment
      * *
      * Indicative exchange rate USD/XXX (base currency is always USD).
      *
-     * Resolved live from the network's current quote snapshot on every call,
+     * Reflects the current quote on every call,
      * including idempotent retries. The binding rate is locked in at
      * ConfirmFundsReceived and may differ.
      *
@@ -323,7 +321,7 @@ export type PaymentIntentPayInDetails = Message<"tzero.v1.payment_intent.Payment
      * Indicative fixed charge in USD retained by the pay-in provider per transfer.
      * Settlement is calculated as (amount / indicative_rate) - indicative_fix.
      *
-     * Resolved live from the network's current quote snapshot on every call,
+     * Reflects the current quote on every call,
      * including idempotent retries. The binding fix is locked in at
      * ConfirmFundsReceived and may differ.
      *
@@ -465,7 +463,7 @@ export type CreatePaymentIntentResponse_Success = Message<"tzero.v1.payment_inte
      * *
      * Unique identifier for this payment intent.
      * Store this ID to correlate with:
-     * - PaymentIntentUpdate notifications you'll receive
+     * - PaymentIntentUpdate notifications delivered later
      *
      * @generated from field: uint64 payment_intent_id = 10;
      */
@@ -473,13 +471,12 @@ export type CreatePaymentIntentResponse_Success = Message<"tzero.v1.payment_inte
     /**
      * *
      * Available payment options for the end-user.
-     * Present these options to your user so they can choose how to pay.
+     * Present these options to the end-user so they can choose how to pay.
      * Each entry contains the payment details needed to complete the payment.
      *
      * Indicative rate/fix are resolved live on every call, including idempotent
-     * retries. The set of options (provider, payment_method, payment_details)
-     * is fixed at first call; individual options whose underlying quote has
-     * lapsed are omitted on retry.
+     * retries. The set of options is fixed at first call; individual options
+     * whose underlying quote has lapsed are omitted on retry.
      *
      * @generated from field: repeated tzero.v1.payment_intent.PaymentIntentPayInDetails pay_in_details = 20;
      */
@@ -557,12 +554,9 @@ export type ConfirmFundsReceivedRequest = Message<"tzero.v1.payment_intent.Confi
     paymentIntentId: bigint;
     /**
      * *
-     * Confirmation code received in the get payment details along with the payment_intent_id.
-     * This prevents accidental confirmation of the wrong payment intent. The network
-     * generates this as a UUID at CreatePaymentIntent time; non-UUID strings still pass
-     * field-level length validation here and surface as a REJECT_REASON_CONFIRMATION_CODE_MISMATCH
-     * at the orchestrator (preserving the "wrong code is a domain reject, not a transport error"
-     * contract).
+     * Confirmation code received in the GetPaymentDetails response along with the payment_intent_id.
+     * Guards against confirming the wrong payment intent; a mismatch is rejected with
+     * REJECT_REASON_CONFIRMATION_CODE_MISMATCH.
      *
      * @generated from field: string confirmation_code = 20;
      */
@@ -662,8 +656,8 @@ export type ConfirmFundsReceivedResponse_Accept = Message<"tzero.v1.payment_inte
     /**
      * *
      * Flat USD charge retained by the pay-in provider per transfer,
-     * already subtracted from settlement_amount. Surfaced so the pay-in
-     * provider can audit the settlement formula: settlement = (payment_amount / rate) − fix.
+     * already subtracted from settlement_amount.
+     * Settlement is computed as (payment_amount / rate) − fix.
      *
      * @generated from field: tzero.v1.common.Decimal fix = 30;
      */
@@ -721,10 +715,9 @@ export declare enum ConfirmFundsReceivedResponse_Reject_Reason {
     REJECT_REASON_AMOUNT_TOO_SMALL = 40,
     /**
      * *
-     * The (pay-in provider, payment method) tuple was not offered on
-     * this intent. Either the intent was rejected during creation,
-     * or this provider's GetPaymentDetails response was invalid for
-     * the requested method.
+     * The requested payment method was not offered on this intent — either the
+     * intent was rejected at creation, or no valid payment details were returned
+     * for the method. Retry with a method from the returned options.
      *
      * @generated from enum value: REJECT_REASON_NO_VALID_OFFER = 50;
      */
@@ -754,8 +747,6 @@ export declare const ConfirmFundsReceivedResponse_Reject_ReasonSchema: GenEnum<C
  * 3. Pay-in provider confirms funds received
  * 4. Settlement will happen periodically between providers
  *
- * This service is hosted by the T-0 Network and called by providers.
- *
  * @generated from service tzero.v1.payment_intent.PaymentIntentService
  */
 export declare const PaymentIntentService: GenService<{
@@ -792,9 +783,7 @@ export declare const PaymentIntentService: GenService<{
      * *
      * CreatePaymentIntent initiates a new payment intent.
      *
-     * Called by the beneficiary provider (the one who will receive the settlement).
-     * The network finds suitable pay-in providers, retrieves their payment details,
-     * and returns available payment options to present to the end-user.
+     * Returns the available payment options to present to the end-user.
      *
      * The returned payment_intent_id must be stored by the beneficiary provider
      * to correlate with the PaymentIntentUpdate notification received later.

package/lib/esm/common/gen/tzero/v1/payment_intent/network_pb.js

@@ -168,10 +168,9 @@ export var ConfirmFundsReceivedResponse_Reject_Reason;
     ConfirmFundsReceivedResponse_Reject_Reason[ConfirmFundsReceivedResponse_Reject_Reason["REJECT_REASON_AMOUNT_TOO_SMALL"] = 40] = "REJECT_REASON_AMOUNT_TOO_SMALL";
     /**
      * *
-     * The (pay-in provider, payment method) tuple was not offered on
-     * this intent. Either the intent was rejected during creation,
-     * or this provider's GetPaymentDetails response was invalid for
-     * the requested method.
+     * The requested payment method was not offered on this intent — either the
+     * intent was rejected at creation, or no valid payment details were returned
+     * for the method. Retry with a method from the returned options.
      *
      * @generated from enum value: REJECT_REASON_NO_VALID_OFFER = 50;
      */
@@ -201,8 +200,6 @@ export const ConfirmFundsReceivedResponse_Reject_ReasonSchema = /*@__PURE__*/ en
  * 3. Pay-in provider confirms funds received
  * 4. Settlement will happen periodically between providers
  *
- * This service is hosted by the T-0 Network and called by providers.
- *
  * @generated from service tzero.v1.payment_intent.PaymentIntentService
  */
 export const PaymentIntentService = /*@__PURE__*/ serviceDesc(file_tzero_v1_payment_intent_network, 0);

package/lib/esm/common/gen/tzero/v1/payment_intent/pay_in_provider_pb.d.ts

@@ -31,9 +31,8 @@ export type GetPaymentDetailsRequest = Message<"tzero.v1.payment_intent.GetPayme
     confirmationCode: string;
     /**
      * *
-     * Payment methods being requested.
-     * The provider should return PaymentDetails for the methods in the request. All the payment methods will be taken
-     * from the quotes submitted by pay-in provider.
+     * Payment methods to return PaymentDetails for.
+     * Each is drawn from a previously submitted quote.
      *
      * @generated from field: repeated tzero.v1.common.PaymentMethodType payment_methods = 30;
      */
@@ -63,8 +62,7 @@ export type GetPaymentDetailsRequest = Message<"tzero.v1.payment_intent.GetPayme
     /**
      * *
      * The T-0 provider ID of the beneficiary provider (the FI the funds are
-     * destined for). Stable, opaque identifier — pay-in providers can use this
-     * directly to resolve the beneficiary in their own systems.
+     * destined for). Stable, opaque identifier for the beneficiary.
      *
      * @generated from field: uint32 beneficiary_provider_id = 70;
      */
@@ -144,11 +142,9 @@ export declare const GetPaymentDetailsResponseSchema: GenMessage<GetPaymentDetai
 export type GetPaymentDetailsResponse_Details = Message<"tzero.v1.payment_intent.GetPaymentDetailsResponse.Details"> & {
     /**
      * *
-     * Payment details for each supported payment method.
-     *
-     * Each PaymentDetails contains the information needed for an end-user
-     * to send a payment (e.g., bank account details, mobile money number) and payment reference,
-     * which can be used by pay-in provider to identify incoming payment.
+     * Payment details for each supported payment method. Each entry carries the
+     * information an end-user needs to send a payment (bank account, mobile money,
+     * etc.) plus a payment reference that identifies the incoming payment.
      *
      * @generated from field: repeated tzero.v1.common.PaymentDetails payment_details = 10;
      */
@@ -175,8 +171,7 @@ export type GetPaymentDetailsResponse_Rejection = Message<"tzero.v1.payment_inte
 export declare const GetPaymentDetailsResponse_RejectionSchema: GenMessage<GetPaymentDetailsResponse_Rejection>;
 /**
  * *
- * PayInProviderService must be implemented by pay-in providers to participate
- * in the Payment Intent flow.
+ * Pay-in provider surface for the Payment Intent flow.
  *
  * Pay-in providers are those who:
  * - Receive fiat payments from end-users
@@ -184,20 +179,16 @@ export declare const GetPaymentDetailsResponse_RejectionSchema: GenMessage<GetPa
  * - Confirm when payments are received via ConfirmFundsReceived
  * - Settles periodically with the beneficiary provider
  *
- * The network calls this service to obtain payment details that will be
- * presented to end-users for making payments.
+ * Provides the payment details presented to end-users for making payments.
  *
  * @generated from service tzero.v1.payment_intent.PayInProviderService
  */
 export declare const PayInProviderService: GenService<{
     /**
      * *
-     * GetPaymentDetails returns payment details for the end-user.
-     *
-     * Called by the network during CreatePaymentIntent processing.
-     * The provider should return payment details (bank accounts, mobile money info, etc.)
-     * that the end-user can use to send funds. The payment details should contain payment reference,
-     * so that on receiving payment from a payer, the pay-in provider can identify which payment intent this payment belongs to
+     * Returns the payment details (bank account, mobile money, etc.) an end-user uses
+     * to send funds. The details must carry a payment reference that ties an incoming
+     * payment back to its payment intent.
      *
      * @generated from rpc tzero.v1.payment_intent.PayInProviderService.GetPaymentDetails
      */

package/lib/esm/common/gen/tzero/v1/payment_intent/pay_in_provider_pb.js

@@ -37,8 +37,7 @@ export const GetPaymentDetailsResponse_DetailsSchema = /*@__PURE__*/ messageDesc
 export const GetPaymentDetailsResponse_RejectionSchema = /*@__PURE__*/ messageDesc(file_tzero_v1_payment_intent_pay_in_provider, 1, 1);
 /**
  * *
- * PayInProviderService must be implemented by pay-in providers to participate
- * in the Payment Intent flow.
+ * Pay-in provider surface for the Payment Intent flow.
  *
  * Pay-in providers are those who:
  * - Receive fiat payments from end-users
@@ -46,8 +45,7 @@ export const GetPaymentDetailsResponse_RejectionSchema = /*@__PURE__*/ messageDe
  * - Confirm when payments are received via ConfirmFundsReceived
  * - Settles periodically with the beneficiary provider
  *
- * The network calls this service to obtain payment details that will be
- * presented to end-users for making payments.
+ * Provides the payment details presented to end-users for making payments.
  *
  * @generated from service tzero.v1.payment_intent.PayInProviderService
  */

package/lib/esm/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.1.23";
+export declare const SDK_VERSION = "1.1.24";

package/lib/esm/version.js

@@ -1,3 +1,3 @@
 // SDK semantic version. Bumped in lockstep with all other SDKs by the
 // release.yaml workflow.
-export const SDK_VERSION = "1.1.23";
+export const SDK_VERSION = "1.1.24";