Skip to content
GitHub

Get an Outgoing Payment

GET
/outgoing-payments/{id}

A client can fetch the latest state of an outgoing payment.

Authorizations

Parameters

Path Parameters

id
required
string

Sub-resource identifier

Header Parameters

Signature-Input
required

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.

Signature
required

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

Outgoing Payment Found

An outgoing payment resource represents a payment that will be, is currently being, or has previously been, sent from the wallet address.

object
id
required

The URL identifying the outgoing payment.

string format: uri
walletAddress
required

The URL of the wallet address from which this payment is sent.

string format: uri
quoteId

The URL of the quote defining this payment’s amounts.

string format: uri
failed

Describes whether the payment failed to send its full amount.

boolean
receiver
required

The URL of the incoming payment that is being paid.

string format: uri
/^(https|http)://(.+)/incoming-payments/(.+)$/
receiveAmount
required

The total amount that should be received by the receiver when this outgoing payment has been paid.

object
value
required

The value is an unsigned 64-bit integer amount, represented as a string.

string format: uint64
assetCode
required

The assetCode is a code that indicates the underlying asset. This SHOULD be an ISO4217 currency code.

string
assetScale
required

The scale of amounts denoted in the corresponding asset code.

integer
<= 255
debitAmount
required

The total amount that should be deducted from the sender’s account when this outgoing payment has been paid.

object
value
required

The value is an unsigned 64-bit integer amount, represented as a string.

string format: uint64
assetCode
required

The assetCode is a code that indicates the underlying asset. This SHOULD be an ISO4217 currency code.

string
assetScale
required

The scale of amounts denoted in the corresponding asset code.

integer
<= 255
sentAmount
required

The total amount that has been sent under this outgoing payment.

object
value
required

The value is an unsigned 64-bit integer amount, represented as a string.

string format: uint64
assetCode
required

The assetCode is a code that indicates the underlying asset. This SHOULD be an ISO4217 currency code.

string
assetScale
required

The scale of amounts denoted in the corresponding asset code.

integer
<= 255
metadata

Additional metadata associated with the outgoing payment. (Optional)

object
createdAt
required

The date and time when the outgoing payment was created.

string format: date-time
updatedAt
required

The date and time when the outgoing payment was updated.

string format: date-time
Examples
{
  "id": "https://ilp.interledger-test.dev/bob/outgoing-payments/3859b39e-4666-4ce5-8745-72f1864c5371",
  "walletAddress": "https://ilp.interledger-test.dev/bob/",
  "failed": false,
  "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
  },
  "sentAmount": {
    "value": "1205",
    "assetCode": "USD",
    "assetScale": 2
  },
  "createdAt": "2022-03-12T23:20:50.52Z",
  "updatedAt": "2022-04-01T10:24:36.11Z",
  "metadata": {
    "description": "Thanks for the flowers!",
    "externalRef": "INV-12876"
  }
}

401

Authorization required

Headers

WWW-Authenticate
string

The address of the authorization server for grant requests in the format GNAP as_uri=<URI>

403

Forbidden

404

Outgoing Payment Not Found