Skip to main content

Beneficiaries — Reference

Auth: X-API-Key on all routes.

POST /v1/beneficiaries — create​

curl -X POST "$BASE_URL/v1/beneficiaries" \
  -H "X-API-Key: $THIQWAVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participant_id": "'"$PARTICIPANT_ID"'",
    "type": "business",
    "full_name": "Mumbai Exports Pvt Ltd",
    "country": "IN",
    "account": {
      "kind": "BANK_ACCOUNT",
      "destination_asset": "INR",
      "iban": "IN00BANK0000000001",
      "bank_name": "HDFC Bank",
      "bank_country": "IN",
      "routing": "HDFC0001234",
      "is_default": true
    }
  }'

Body: participant_id, type (business|individual), full_name, country, optional gov_id_ref (if individual), and account (kind + kind-specific fields — see guide).

Response 201 returns BeneficiaryResponseDto with nested account. Errors: 400 VAL_0001, 404 participant not found.

GET /v1/beneficiaries — list​

participant_id query required. Plus limit, cursor.

GET /v1/beneficiaries/:id — get​

Errors: 404 BEN_0001.