List requests

Deprecated

GET

https://your-protect-instance.example.com/api/rest/v1/requests

GET

/api/rest/v1/requests

curl https://your-protect-instance.example.com/api/rest/v1/requests \
     -H "Authorization: Bearer <token>"

{
  "result": [
    {
      "id": "442",
      "tenantId": "1",
      "currency": "BTC",
      "envelope": "CgM0NDIQmfGjk6Ops/oVGAEqmgUSrAEKPwoPbS80NCcvMCcvMCcvMC8wGiAeyruP7CoNYcGISzRo8iZmuVnV6M9gLiZuShy7aDtKKiABKNHEFDD/////DxIoCiIxQ3Zoeml0ZFZMUGhOVGZ3NU5rUm9YWHZveldacGZhWXQ2EJ/nBRoVCg9tLzQ0Jy8wJy8wJy8wLzAYsbcOMig0NDI6NDY5ZTMxOGUtYjcxZC00MGUwLTg0ZjctNzVlOGQwOWE3Yzg2IhMKCnJlcXVlc3RfaWQQARoDNDQyIhIKCXJ1bGVzX2tleRABGgNCVEMiEQoIY3VycmVuY3kQARoDQlRDIlsKBnNvdXJjZRAEGkcIARJDCAESIjFKTUJZTU1pOWlqSlJlVFlxdEZUU2RlVkJ6azhOSGRzVHUaCm5vc3RybyBCVEMiD20vNDQnLzAnLzAnLzAvMCIGc291cmNlImIKC2Rlc3RpbmF0aW9uEAUaRBJCCMwBEiIxQ3Zoeml0ZFZMUGhOVGZ3NU5rUm9YWHZveldacGZhWXQ2GghteSBsYWJlbCIPbS80NCcvMCcvMCcvMC84IgtkZXN0aW5hdGlvbiKeAQoGYW1vdW50EAoaiQEKAwGGoBIHMTAuMDQzMBoKMTAwNDIuOTcwMCAIKgNCVEMyA0NIRjphCh12YWxpZGF0b3ItY29yZUB0YXVydXNncm91cC5jaBJAffe4nBGVSajYYQxxzEZbQuj0snr8WOC1P506eXRn2EUsDrAnkWvNW9wfU+pwUoBVUaXl/veYW/6m/DJsEKijLCIGYW1vdW50Ih4KEXRvdGFsX2ZpYXRfYW1vdW50EAEaBzEwLjA0MzAiCwoDZmVlEAIaAhMBIh4KFGZlZV9wYWlkX2J5X3JlY2VpdmVyEAEaBHRydWU=",
      "status": "CREATED",
      "trails": [
        {
          "userId": "11",
          "externalUserId": "team1@bank.com",
          "action": "created",
          "comment": "IchbineineflyingRoastedButternutSquashBoodles",
          "date": "2020-02-19T12:24:47.748229Z",
          "requestStatus": "CREATED"
        },
        {
          "userId": "1",
          "externalUserId": "validator-core@taurusgroup.ch",
          "action": "approvers_assigned",
          "comment": "rule=[source:any,destination:any,amount:10.0000],approvals=['team1':1sig,'team2':1sig]",
          "date": "2020-02-19T12:24:47.774836Z",
          "requestStatus": "CREATED"
        }
      ],
      "creationDate": "2020-02-19T12:24:47.586041Z",
      "updateDate": "2020-02-19T12:24:47.713648Z",
      "metadata": {
        "hash": "fda859afd5dcc16f7abec8e7ab7fc528d90b094e43eeb111037581c45f8e16b5",
        "payload": [
          {
            "column": "",
            "key": "request_id",
            "type": "String",
            "value": "442"
          },
          {
            "column": "",
            "key": "rules_key",
            "type": "String",
            "value": "BTC"
          },
          {
            "column": "",
            "key": "currency",
            "type": "String",
            "value": "BTC"
          },
          {
            "column": "source",
            "key": "source",
            "type": "Source",
            "value": {
              "payload": {
                "address": "1JMBYMMi9ijJReTYqtFTSdeVBzk8NHdsTu",
                "id": "1",
                "label": "nostroBTC",
                "path": "m/44'/0'/0'/0/0"
              },
              "type": "SourceInternalAddress"
            }
          },
          {
            "column": "destination",
            "key": "destination",
            "type": "Destination",
            "value": {
              "payload": {
                "address": "1CvhzitdVLPhNTfw5NkRoXXvozWZpfaYt6",
                "id": "204",
                "label": "mylabel",
                "path": "m/44'/0'/0'/0/8"
              },
              "type": "DestinationInternalAddress"
            }
          },
          {
            "column": "amount",
            "key": "amount",
            "type": "Amount",
            "value": {
              "currencyFrom": "BTC",
              "currencyTo": "CHF",
              "decimals": "8",
              "rate": "10042.9700",
              "valueFrom": "100000",
              "valueTo": "10.0430"
            }
          },
          {
            "column": "",
            "key": "total_fiat_amount",
            "type": "String",
            "value": "10.0430"
          },
          {
            "column": "",
            "key": "fee",
            "type": "BigInt",
            "value": "4865"
          },
          {
            "column": "",
            "key": "fee_paid_by_receiver",
            "type": "String",
            "value": "true"
          }
        ]
      },
      "rule": "rule=[source:any,destination:any,amount:10.0000],approvals=['team1':1sig,'team2':1sig]",
      "approvers": {
        "parallel": [
          {
            "sequential": [
              {
                "externalGroupID": "team1",
                "minimumSignatures": 1
              },
              {
                "externalGroupID": "team2",
                "minimumSignatures": 1
              }
            ]
          }
        ]
      }
    }
  ],
  "totalItems": "1"
}

Deprecated: Use /api/rest/v2/requests instead. This endpoint returns a list of requests

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitlongOptional

offsetlongOptional

fromdatetimeOptional

todatetimeOptional

currencieslist of stringsOptional

Filter on IDs or symbols of the currency

typestringOptional

deprecated, use the multi-valued propery "types" instead

statuseslist of stringsOptional

typeslist of stringsOptional

idslist of stringsOptional

uint64; Filter for specific requests, identified by their unique ID

Response

A successful response.

resultlist of objectsOptional

totalItemsstringOptionalformat: "uint64"

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error