Pending Transfers

The pending transfers endpoints let you query information about transfers that have not been completed yet.

Pending Transfers Resource Overview

HTTP Method

Resource

Description

GET

/api/<version>/pending_transfers

All incomplete transfers

GET

/api/<version>/pending_transfers/<token_address>

All incomplete transfers for a specific token

GET

/api/<version>/pending_transfers/<token_address>

/<partner_address>

All incomplete transfers for a specific token and channel

Pending Transfers Resource Details

get
All Incomplete Transfers

http://localhost:5001/api/v1/pending_transfers
The "role" key in the response can either have the value "initiator", "mediator" or "target".
Request
Response
Request
Path Parameters
version
required
string
Version of the API
Response
200: OK
Successful query
[
{
"channel_identifier": "255",
"initiator": "0x5E1a3601538f94c9e6D2B40F7589030ac5885FE7",
"locked_amount": "119",
"payment_identifier": "1",
"role": "initiator",
"target": "0x00AF5cBfc8dC76cd599aF623E60F763228906F3E",
"token_address": "0xd0A1E359811322d97991E03f863a0C30C2cF029C",
"token_network_addrss": "0x111157460c0F41EfD9107239B7864c062aA8B978",
"transferred_amout": "331"
}
]
500: Internal Server Error
Internal Raiden node error

get
All Incomplete Transfers for a Specific Token

http://localhost:5001/api/v1/pending_transfers/0xd0A1...029C
Limits the response to pending transfers of the specified token. The "role" key in the response can either have the value "initiator", "mediator" or "target".
Request
Response
Request
Path Parameters
version
required
string
Version of the API
token_address
required
string
Address of a token
Response
200: OK
Successful query
[
{
"channel_identifier": "255",
"initiator": "0x5E1a3601538f94c9e6D2B40F7589030ac5885FE7",
"locked_amount": "119",
"payment_identifier": "1",
"role": "initiator",
"target": "0x00AF5cBfc8dC76cd599aF623E60F763228906F3E",
"token_address": "0xd0A1E359811322d97991E03f863a0C30C2cF029C",
"token_network_addrss": "0x111157460c0F41EfD9107239B7864c062aA8B978",
"transferred_amout": "331"
}
]
404: Not Found
No results found for the token specified in the query
500: Internal Server Error
Internal Raiden node error

get
All Incomplete Transfers for a Specific Token and Channel

http://localhost:5001/api/v1/pending_transfers/0xd0A1...029C/0x2c4b...C685
Limits the response to pending transfers of the specified token and channel. The "role" key in the response can either have the value "initiator", "mediator" or "target".
Request
Response
Request
Path Parameters
version
required
string
Version of the API
token_address
required
string
Address of a token
partner_address
required
string
Address of the receiving node
Response
200: OK
Successful query
[
{
"channel_identifier": "255",
"initiator": "0x5E1a3601538f94c9e6D2B40F7589030ac5885FE7",
"locked_amount": "119",
"payment_identifier": "1",
"role": "initiator",
"target": "0x00AF5cBfc8dC76cd599aF623E60F763228906F3E",
"token_address": "0xd0A1E359811322d97991E03f863a0C30C2cF029C",
"token_network_addrss": "0x111157460c0F41EfD9107239B7864c062aA8B978",
"transferred_amout": "331"
}
]
404: Not Found
No result found for the token specified in the query
No result found for the channel specified in the query
500: Internal Server Error
Internal Raiden node error