Get a Quote
GET /quotes/{id}
A client can fetch the latest state of a quote.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Sub-resource identifier
Header Parameters
Section titled “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
Section titled “ Responses ”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. An ISO4217 currency code should be used whenever possible. The ISO4217 representation of the US Dollar is USD.
The number of decimal places that defines the scale of the smallest divisible unit for the given asset code. It determines how an integer amount is scaled to derive the actual monetary value. For example, USD has an asset scale of 2 with the smallest unit being 0.01. An integer amount of 1000 with an assetCode of USD and assetScale of 2 translates to $10.00.
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. An ISO4217 currency code should be used whenever possible. The ISO4217 representation of the US Dollar is USD.
The number of decimal places that defines the scale of the smallest divisible unit for the given asset code. It determines how an integer amount is scaled to derive the actual monetary value. For example, USD has an asset scale of 2 with the smallest unit being 0.01. An integer amount of 1000 with an assetCode of USD and assetScale of 2 translates to $10.00.
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"}Authorization required
object
object
Additional details about the error.
object
Examples
{ "error": { "code": "invalid_request", "description": "Error description", "details": { "anyKey": "anyValue" } }}{ "error": { "code": "invalid_request", "description": "Error description" }}Headers
Section titled “Headers ”The address of the authorization server for grant requests in the format GNAP as_uri=<URI>
Forbidden
object
object
Additional details about the error.
object
Examples
{ "error": { "code": "invalid_request", "description": "Error description", "details": { "anyKey": "anyValue" } }}{ "error": { "code": "invalid_request", "description": "Error description" }}Quote Not Found
object
object
Additional details about the error.
object
Examples
{ "error": { "code": "invalid_request", "description": "Error description", "details": { "anyKey": "anyValue" } }}{ "error": { "code": "invalid_request", "description": "Error description" }}