Check whether a string is syntactically a valid PayID.
the PayID to check
true
if the PayID is valid, otherwise false
Parse a PayID into PayIdComponents.
the PayID to parse
the PayIdComponents if the PayID is syntactically valid, otherwise undefined
Retrieve one or more addresses associated with a PayID.
By default, this retrieves all of a PayID's addresses by passing the payid
network in the header of the request.
To retrieve an address for a particular payment network, set options.network
to the desired PaymentNetwork.
The PayID to resolve for one or more addresses
Promise resolves to PaymentInformation. If useInsecureHttp
was set, then usedInsecureHttp: true
will be set
Generated using TypeDoc
Payment Network strings.
The general standard form of the
Accept:
header for cryptocurrencies is:application/{payment-network}-{environment}+json
The special value
payid
asks the server to return ALL of the addresses associated with the PayID.https://payid.org/whitepaper.pdf