Gets the amount that destination will receive.
Optional.
Sets the amount that destination will receive.
Optional.
Gets the asset code the destination will receive.
Optional.
Sets the asset code the destination will receive.
Optional.
Gets the account ID of asset issuer the destination will receive
Optional.
Sets the account ID of asset issuer the destination will receive
Optional.
Gets the callback for this URI.
Note: This returns the callback without the 'url:' prefix that may be present in the callback.
Optional.
Sets the callback for this URI.
Note: You may set it with or without the 'url:' prefix. If the prefix is not present it will added in the final URI string.
Optional.
Gets the destination of the payment request, which is a valid account ID or payment address.
Required.
Sets the destination of the payment request, which is a valid account ID or payment address.
Required.
Returns whether or not the network_passphase for this URI indicates that it is on the public network.
This is true if network_passphrase is not set or if it's set to the public network's passphrase.
Returns whether or not the network_passphase for this URI indicates that it is on the test network.
Gets the memo to be included in the payment / path payment. Memos of type MEMO_HASH and MEMO_RETURN should be base64 encoded.
Optional.
Sets the memo to be included in the payment / path payment. Memos of type MEMO_HASH and MEMO_RETURN should be base64 encoded.
Optional.
Gets the type of the memo.
Optional.
Sets the type of the memo.
Optional.
Gets the message to show to the user.
Optional.
Sets the message to show to the user. This must be 300 characters or less.
Optional.
Gets the network passphrase of the Stellar network to use for this request.
If this is not set, the Stellar public network should be assumed.
Optional.
Sets the network passphrase of the Stellar network to use for this request.
Optional.
Gets the operation type of the URI.
Gets the fully qualified domain name that specifies the originating domain of the URI request.
Wallets must validate the URI request against the included signature before they display the origin_domain to the user.
Sets the fully qualified domain name that specifies the originating domain of the URI request.
Wallets must validate the URI request against the included signature before they display the origin_domain to the user.
Gets which public key you want the URI handler to sign for.
Optional.
Sets which public key you want the URI handler to sign for.
Optional.
A signature of the hash of the URI request (excluding the signature field and value itself).
Wallets should use the URI_REQUEST_SIGNING_KEY specified in the domain's stellar.toml file to validate this signature. If the verification fails, wallets must alert the user.
Adds an additional replacement.
The replacement to add.
Signs the URI with the given keypair. This should be the last step done before generating the URI string, otherwise the signature will be invalid for the URI.
The keypair (including secret key), used to sign the request. This should be the keypair found in the URI_REQUEST_SIGNING_KEY field of the origin domains' stellar.toml.
Creates a deep clone of the PayStellarUri
Gets a list of fields in the transaction that need to be replaced.
Removes all replacements with the given identifier.
The identifier to remove.
Sets the "replace" key, which is a list of fields in the transaction that needs to be replaced.
A list of replacements to set.
Returns the URI as a string.
Sets the network_passphrase to be the passphrase of the public network.
Sets the network_passphrase to be the passphrase of the test network.
Verifies a that the signature added to the URI is valid.
Returns true if the signature is valid for the current URI and origin domain, or if there is no origin domain and signature. Returns false if signature verification fails, or if there is a problem looking up the stellar.toml associated with the origin domain.
Creates a PayStellarUri instance and sets the given destination.
A valid account ID or payment address.
Generated using TypeDoc
The pay operation represents a request to pay a specific address with a specific asset, regardless of the source asset used by the payer.
https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0007.md#operation-pay