| description |
|---|
The pending transfers endpoints let you query information about transfers that have not been completed yet. |
| 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 | All incomplete transfers for a specific token and channel |
{% api-method method="get" host="http://localhost:5001" path="/api/v1/pending_transfers" %} {% api-method-summary %} All Incomplete Transfers {% endapi-method-summary %}
{% api-method-description %} The "role" key in the response can either have the value "initiator", "mediator" or "target". {% endapi-method-description %}
{% api-method-spec %} {% api-method-request %} {% api-method-path-parameters %} {% api-method-parameter name="version" type="string" required=true %} Version of the API {% endapi-method-parameter %} {% endapi-method-path-parameters %} {% endapi-method-request %}
{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %} Successful query {% endapi-method-response-example-description %}
[
{
"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"
}
]{% endapi-method-response-example %}
{% api-method-response-example httpCode=500 %} {% api-method-response-example-description %}
{% endapi-method-response-example-description %}
Internal Raiden node error
{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}
{% api-method method="get" host="http://localhost:5001" path="/api/v1/pending_transfers/0xd0A1...029C" %} {% api-method-summary %} All Incomplete Transfers for a Specific Token {% endapi-method-summary %}
{% api-method-description %} 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". {% endapi-method-description %}
{% api-method-spec %} {% api-method-request %} {% api-method-path-parameters %} {% api-method-parameter name="version" type="string" required=true %} Version of the API {% endapi-method-parameter %}
{% api-method-parameter name="token_address" type="string" required=true %} Address of a token {% endapi-method-parameter %} {% endapi-method-path-parameters %} {% endapi-method-request %}
{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %} Successful query {% endapi-method-response-example-description %}
[
{
"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"
}
]{% endapi-method-response-example %}
{% api-method-response-example httpCode=404 %} {% api-method-response-example-description %}
{% endapi-method-response-example-description %}
No results found for the token specified in the query
{% endapi-method-response-example %}
{% api-method-response-example httpCode=500 %} {% api-method-response-example-description %}
{% endapi-method-response-example-description %}
Internal Raiden node error
{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}
{% api-method method="get" host="http://localhost:5001" path="/api/v1/pending_transfers/0xd0A1...029C/0x2c4b...C685" %} {% api-method-summary %} All Incomplete Transfers for a Specific Token and Channel {% endapi-method-summary %}
{% api-method-description %} 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". {% endapi-method-description %}
{% api-method-spec %} {% api-method-request %} {% api-method-path-parameters %} {% api-method-parameter name="version" type="string" required=true %} Version of the API {% endapi-method-parameter %}
{% api-method-parameter name="token_address" type="string" required=true %} Address of a token {% endapi-method-parameter %}
{% api-method-parameter name="partner_address" type="string" required=true %} Address of the receiving node {% endapi-method-parameter %} {% endapi-method-path-parameters %} {% endapi-method-request %}
{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %} Successful query {% endapi-method-response-example-description %}
[
{
"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"
}
]{% endapi-method-response-example %}
{% api-method-response-example httpCode=404 %} {% api-method-response-example-description %}
{% endapi-method-response-example-description %}
No result found for the token specified in the query
No result found for the channel specified in the query
{% endapi-method-response-example %}
{% api-method-response-example httpCode=500 %} {% api-method-response-example-description %}
{% endapi-method-response-example-description %}
Internal Raiden node error
{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}