payment-authorization API

Source-derived exports, parameter and result types, public methods and source links.

This reference is generated from the checked-out TypeScript exports. Types and signatures describe the package contract; source presence does not establish deployment or service availability. Error expressions below are direct throws, not an exhaustive list of failures from dependencies.

Source module. See the reference index for package import boundaries and verification scope.

buildPaymentAuthorizationIntentRequest

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/payment-authorization. Implementation, line 184.

buildPaymentAuthorizationIntentRequest(params: { paymentId: string; recipientHash: string; recipientTin: string; tokenMintAddress: string; tokenDecimals: number; senderWallet: string; senderAuthorizationMessage: string; senderAuthorizationSignature: string; senderAuthorizationNonce: string; senderAuthorizationIssuedAt: string; senderAuthorizationExpiresAt: string; senderFeeAmount?: string | number | null; senderSignedFundingTransaction: string; senderFundingMode: "tcap_deposit_v2"; amount: string | number; destinationNetwork?: string | null; destinationExecutor?: string | null; destinationToken?: string | null; settlementRouteId?: string | null; recipientAmount?: number; source?: string; }): CreateIntentRequest

Direct failure expressions:

new Error("Payment amount cannot be represented exactly in the TSN intent request")
new Error("Sender fee cannot be represented exactly in the TSN intent request")

createCrossChainPaymentAuthorization

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/payment-authorization. Implementation, line 145.

createCrossChainPaymentAuthorization(params: { intentId: string; senderWallet: string; senderIdentity: string; receiverIdentity: string; tokenMintAddress: string; destinationToken: string; amount: string | number; senderFeeAmount: string | number; nonce?: string; issuedAt?: string; expiresAt?: string; destinationNetwork: string; destinationExecutor: string; settlementRouteId: string; }): { message: string; nonce: string; issuedAt: string; expiresAt: string; }

Direct failure expressions:

new Error("recipient TIN is required for canonical TSN payment authorization")

createPaymentAuthorization

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/payment-authorization. Implementation, line 74.

createPaymentAuthorization(params: { senderWallet: string; senderIdentity: string; receiverIdentity: string; recipientDisplayName?: string; recipientDisplayNameSource?: "owner-provided" | "not provided"; recipientVerifiedCredentials?: readonly VerifiedRecipientCredential[]; tokenMintAddress: string; tokenDecimals: number; amount: string | number; senderFeeAmount: string | number; totalTokenRequiredUi: number; nonce?: string; issuedAt?: string; expiresAt?: string; fundingMode?: "tcap_deposit_v2"; }): { message: string; amountBaseUnits: string; feeBaseUnits: string; nonce: string; issuedAt: string; expiresAt: string; }

createPaymentAuthorizationExpiry

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/payment-authorization. Implementation, line 70.

createPaymentAuthorizationExpiry(ttlMs?: number): string

createPaymentAuthorizationNonce

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/payment-authorization. Implementation, line 62.

createPaymentAuthorizationNonce(): string

createSenderPaymentAuthorizationMessage

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/payment-authorization. Implementation, line 17.

createSenderPaymentAuthorizationMessage(params: { senderWallet: string; senderIdentity: string; receiverIdentity: string; recipientDisplayName?: string; recipientDisplayNameSource?: "owner-provided" | "not provided"; recipientVerifiedCredentials?: readonly VerifiedRecipientCredential[]; tokenMintAddress: string; tokenDecimals: number; amount: string | number; senderFeeAmount: string | number; totalTokenRequiredUi: number; nonce?: string; issuedAt: string; expiresAt?: string; fundingMode?: "tcap_deposit_v2"; }): string

Direct failure expressions:

new Error( "recipient TIN is required for canonical TSN payment authorization", )

createTcapAssetPaymentAuthorization

Resolve the active TCAP asset first, then sign using its registered mint and decimals.

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/payment-authorization. Implementation, line 115.

createTcapAssetPaymentAuthorization(params: Omit<Parameters<typeof createPaymentAuthorization>[0], "tokenMintAddress" | "tokenDecimals"> & { connection: Connection; depositor: PublicKey; mint: PublicKey; tcapProgramId?: PublicKey; }): Promise<{ asset: { tokenId: number; mint: string; tokenProgram: string; decimals: number; assetEntry: string; }; message: string; amountBaseUnits: string; feeBaseUnits: string; nonce: string; issuedAt: string; expiresAt: string; }>

Direct failure expressions:

new Error("TOKEN_MINT_ACCOUNT_NOT_FOUND")