Skip to main content
POST
/
transfers
/
withdraw
Initiate withdrawal
curl --request POST \
  --url https://api.natural.co/transfers/withdraw \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "data": {
    "attributes": {
      "amount": 12500,
      "currency": "USD",
      "externalAccountId": "eac_550e8400e29b41d4a716446655440000",
      "description": "Payout transfer"
    }
  }
}
'
{
  "data": {
    "type": "transfer",
    "id": "trf_650e8400e29b41d4a716446655440000",
    "attributes": {
      "type": "withdrawal",
      "amount": 12500,
      "currency": "USD",
      "status": "PROCESSING",
      "description": "Payout transfer",
      "externalAccountDisplayMask": "6789",
      "expectedAvailableAt": "2026-01-06T15:30:00Z",
      "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_650e8400e29b41d4a716446655440000"
        }
      }
    }
  }
}

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

Idempotency-Key
string
required

Unique key for idempotent request handling. If a request with the same key was already processed, the original response is returned.

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

Body

application/json
data
WithdrawCreateData · object
required

Response

Successful Response

data
TransferResource · object
required