Transfer requests I filed or must decide on

GET /api/v1/transfer_requests

Transfer requests I filed or must decide on

cURL

curl --request GET \
  --url https://api.example.com/api/v1/transfer_requests \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "requested",
    "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "requestedTime": "2023-11-07T05:31:56Z",
    "appId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "apiKeyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "requestedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transactionId": "<string>",
    "contact": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "<string>",
      "walletAddress": "<string>"
    },
    "invoice": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": "<string>",
      "currency": "<string>",
      "status": "<string>",
      "invoiceNumber": "<string>"
    },
    "quote": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "status": "<string>",
      "provider": "<string>",
      "amount": "<string>",
      "currency": "<string>",
      "pendingId": "<string>",
      "externalId": "<string>",
      "txHash": "<string>"
    },
    "amount": 123,
    "memo": "<string>",
    "chatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Authorizations

Authorization · string · header · required

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

Headers

x-api-key · string | null

Query Parameters

limit · integer · default: 50

Required range: 1 <= x <= 200

offset · integer · default: 0

Required range: x >= 0

Response

200

application/json

Successful Response

id · string<uuid> · required

status · enum<string> · required

Client-facing status of a transfer_request proposal.

The record is a proposal (seven statuses); this is the short vocabulary the API keeps for the agent and the web app, mapped from ProposalStatus by :meth:from_proposal.

Available options: requested, approved, declined, failed

accountId · string<uuid> · required

requestedTime · string<date-time> · required

appId · string<uuid> | null

apiKeyId · string<uuid> | null

requestedByUserId · string<uuid> | null

transactionId · string | null

contact · TransferRequestContact · object | null

Show child attributes

invoice · TransferRequestInvoice · object | null

Show child attributes

quote · TransferRequestQuote · object | null

Show child attributes

amount · number | null

memo · string | null

chatId · string<uuid> | null