Skip to main content
GET
/
transfers
/
{transferId}
Get transfer
curl --request GET \
  --url https://api.natural.co/transfers/{transferId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "type": "transfer",
    "id": "trf_550e8400e29b41d4a716446655440000",
    "attributes": {
      "type": "deposit",
      "amount": 50000,
      "currency": "USD",
      "status": "PROCESSING",
      "description": "Wallet top-up",
      "externalAccountDisplayMask": "6789",
      "expectedAvailableAt": null,
      "failure": null,
      "return": null,
      "submittedAt": "2026-01-04T15:30:00Z",
      "settledAt": null,
      "createdAt": "2026-01-04T15:30:00Z",
      "updatedAt": "2026-01-04T15:30:00Z"
    },
    "relationships": {
      "party": {
        "data": {
          "type": "party",
          "id": "pty_7c9e6679e29b41d4a716446655440001"
        }
      },
      "wallet": {
        "data": {
          "type": "wallet",
          "id": "wal_550e8400e29b41d4a716446655440000"
        }
      },
      "externalAccount": {
        "data": {
          "type": "externalAccount",
          "id": "eac_550e8400e29b41d4a716446655440000"
        }
      },
      "transaction": {
        "data": {
          "type": "transaction",
          "id": "txn_550e8400e29b41d4a716446655440000"
        }
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.natural.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Headers

X-Agent-ID
string | null

Agent ID (agt_xxx) identifying which agent is making the request.

X-Instance-ID
string | null

Required when X-Agent-ID is present. Session or conversation ID for agent observability.

Maximum string length: 1024

Path Parameters

transferId
string
required
Pattern: ^trf_[0-9a-f]{32}$

Query Parameters

partyId
string

Party ID for delegated transfer lookup

Pattern: ^pty_[0-9a-f]{32}$

Response

Successful Response

data
TransferResource · object
required