Get Vault Deposit Instructions

{
  "path": {
    "vaultId": "vault_123"
  },
  "query": {
    "asset": "USDC",
    "chain": "ETHEREUM"
  }
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request GET \
  --url "https://api.primevault.com/api/external/vaults/vault_123/deposit_instructions/?asset=USDC&chain=ETHEREUM" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Accept: application/json"

// Bank funding: asset plus paymentRail.
const bankFunding = await apiClient.getVaultDepositInstructions(
  "vault_ngn_business",
  { asset: "NGN", paymentRail: "NIP" },
);

// results can contain zero, one, or multiple instructions.
for (const instruction of bankFunding.results) {
  console.log(instruction.asset, instruction.paymentRail);
  // Present instruction.bankDetails and instruction.memo in your funding UI.
}

// Crypto funding: asset plus chain.
const cryptoFunding = await apiClient.getVaultDepositInstructions(
  "vault_123",
  { asset: "USDC", chain: "ETHEREUM" },
);
console.log(cryptoFunding.results);

{
  "results": [
    {
      "type": "VAULT",
      "asset": "USDC",
      "chain": "ETHEREUM",
      "address": "0xAbC1234567890abcdef1234567890abcdef1234"
    }
  ]
}

interface VaultDepositInstructionsResponse {
  results: DepositInstructions[];
}

interface DepositInstructions {
  type?: TransferPartyType | string;
  paymentRail?: string;
  bankDetails?: BankDetails;
  asset?: string;
  address?: string;
  chain?: string;
  memo?: string;
}