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

All Incomplete Transfers

GET http://localhost:5001/api/v1/pending_transfers

The "role" key in the response can either have the value "initiator", "mediator" or "target".

Path Parameters

Name	Type	Description
version	string	Version of the API

200 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

All Incomplete Transfers for a Specific Token

GET 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".

Path Parameters

Name	Type	Description
version	string	Version of the API
token_address	string	Address of a token

200 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

500

All Incomplete Transfers for a Specific Token and Channel

GET 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".

Path Parameters

Name	Type	Description
version	string	Version of the API
token_address	string	Address of a token
partner_address	string	Address of the receiving node

200 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

500