Skip to content
GitHub

List Incoming Payments

GET
/incoming-payments

List all incoming payments on the wallet address

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
wallet-address
required
string

URL of a wallet address hosted by a Rafiki instance.

cursor
string
>= 1 characters

The cursor key to list from.

first
integer
>= 1 <= 100

The number of items to return after the cursor.

last
integer
>= 1 <= 100

The number of items to return before the cursor.

Header Parameters

Section titled “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

Section titled “ Responses ”

200

Section titled “200 ”

OK

object
pagination
object
startCursor

Cursor corresponding to the first element in the result array.

string
>= 1 characters
endCursor

Cursor corresponding to the last element in the result array.

string
>= 1 characters
hasNextPage
required

Describes whether the data set has further entries.

boolean
hasPreviousPage
required

Describes whether the data set has previous entries.

boolean
result
Array<object>
Incoming Payment

An incoming payment resource represents a payment that will be, is currently being, or has been received by the account.

object
id
required

The URL identifying the incoming payment.

string format: uri
walletAddress
required

The URL of the wallet address this payment is being made into.

string format: uri
completed
required

Describes whether the incoming payment has completed receiving fund.

boolean
incomingAmount
amount

The maximum amount that should be paid into the wallet address under this incoming payment.

object
value
required

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

string format: uint64
assetCode
required
Asset code

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.

string
assetScale
required
Asset scale

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.

integer
<= 255
receivedAmount
required
amount

The total amount that has been paid into the wallet address under this incoming payment.

object
value
required

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

string format: uint64
assetCode
required
Asset code

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.

string
assetScale
required
Asset scale

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.

integer
<= 255
expiresAt

The date and time when payments under this incoming payment will no longer be accepted.

string format: date-time
metadata

Additional metadata associated with the incoming payment. (Optional)

object
key
additional properties
any
createdAt
required

The date and time when the incoming payment was created.

string format: date-time
Examples
{
  "pagination": {
    "startCursor": "241de237-f989-42be-926d-c0c1fca57708",
    "endCursor": "315581f8-9967-45a0-9cd3-87b60b6d6414",
    "hasPreviousPage": false,
    "hasNextPage": true
  },
  "result": [
    {
      "id": "https://ilp.interledger-test.dev/incoming-payments/016da9d5-c9a4-4c80-a354-86b915a04ff8",
      "walletAddress": "https://ilp.interledger-test.dev/alice/",
      "incomingAmount": {
        "value": "250",
        "assetCode": "USD",
        "assetScale": 2
      },
      "receivedAmount": {
        "value": "250",
        "assetCode": "USD",
        "assetScale": 2
      },
      "metadata": {
        "description": "Hi Mo, this is for the cappuccino I bought for you the other day.",
        "externalRef": "Coffee w/ Mo on 10 March 22"
      },
      "expiresAt": "2022-04-12T23:20:50.52Z",
      "createdAt": "2022-03-12T23:20:50.52Z",
      "completed": true
    },
    {
      "id": "https://ilp.interledger-test.dev/incoming-payments/32abc219-3dc3-44ec-a225-790cacfca8fa",
      "walletAddress": "https://ilp.interledger-test.dev/alice/",
      "receivedAmount": {
        "value": "100",
        "assetCode": "USD",
        "assetScale": 2
      },
      "expiresAt": "2022-04-12T23:20:50.52Z",
      "createdAt": "2022-03-12T23:20:50.52Z",
      "metadata": {
        "description": "I love your website, Alice! Thanks for the great content"
      },
      "completed": false
    }
  ]
}

401

Section titled “401 ”

Authorization required

object
error
required
object
code
required
string
description
required
string
details

Additional details about the error.

object
key
additional properties
any
Examples
{
  "error": {
    "code": "invalid_request",
    "description": "Error description",
    "details": {
      "anyKey": "anyValue"
    }
  }
}

Headers

Section titled “Headers ”
WWW-Authenticate
string

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

403

Section titled “403 ”

Forbidden

object
error
required
object
code
required
string
description
required
string
details

Additional details about the error.

object
key
additional properties
any
Examples
{
  "error": {
    "code": "invalid_request",
    "description": "Error description",
    "details": {
      "anyKey": "anyValue"
    }
  }
}