Get a Quote
GET /quotes/{id}
A client can fetch the latest state of a quote.
Authorizations
Parameters
Path Parameters
Sub-resource identifier
Header Parameters
The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message. Each member describes a single message signature. The member’s key is the label that uniquely identifies the message signature within the context of the HTTP message. The member’s value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label. The following components MUST be included: - “@method” - “@target-uri” - “authorization”. When the message contains a request body, the covered components MUST also include the following: - “content-digest” The keyid parameter of the signature MUST be set to the kid value of the JWK. See ietf-httpbis-message-signatures for more details.
The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message. Each member describes a single message signature. The member’s key is the label that uniquely identifies the message signature within the context of the HTTP message. The member’s value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label. The following components MUST be included: - “@method” - “@target-uri” - “authorization”. When the message contains a request body, the covered components MUST also include the following: - “content-digest” The keyid parameter of the signature MUST be set to the kid value of the JWK. See ietf-httpbis-message-signatures for more details.
The signature generated based on the Signature-Input, using the signing algorithm specified in the “alg” field of the JWK.
The signature generated based on the Signature-Input, using the signing algorithm specified in the “alg” field of the JWK.
Responses
200
Quote Found
A quote resource represents the quoted amount details with which an Outgoing Payment may be created.
object
The URL identifying the quote.
The URL of the wallet address from which this quote’s payment would be sent.
The URL of the incoming payment that the quote is created for.
The total amount that should be received by the receiver when the corresponding outgoing payment has been paid.
object
The value is an unsigned 64-bit integer amount, represented as a string.
The assetCode is a code that indicates the underlying asset. This SHOULD be an ISO4217 currency code.
The scale of amounts denoted in the corresponding asset code.
The total amount that should be deducted from the sender’s account when the corresponding outgoing payment has been paid.
object
The value is an unsigned 64-bit integer amount, represented as a string.
The assetCode is a code that indicates the underlying asset. This SHOULD be an ISO4217 currency code.
The scale of amounts denoted in the corresponding asset code.
The date and time when the calculated debitAmount is no longer valid.
The date and time when the quote was created.
Examples
{ "id": "https://ilp.interledger-test.dev/bob/quotes/3859b39e-4666-4ce5-8745-72f1864c5371", "walletAddress": "https://ilp.interledger-test.dev/bob/", "receiver": "https://ilp.interledger-test.dev/incoming-payments/2f1b0150-db73-49e8-8713-628baa4a17ff", "debitAmount": { "value": "2500", "assetCode": "USD", "assetScale": 2 }, "receiveAmount": { "value": "2198", "assetCode": "EUR", "assetScale": 2 }, "method": "ilp", "createdAt": "2022-03-12T23:20:50.52Z", "expiresAt": "2022-04-12T23:20:50.52Z"}401
Authorization required
Headers
The address of the authorization server for grant requests in the format GNAP as_uri=<URI>
403
Forbidden
404
Quote Not Found