Execute a Ramp Quote

Request example

{
  "intent": null,
  "quoteId": "quote_ramp_payroll_1042",
  "externalId": "payroll-top-up-1042",
  "memo": "Convert 10000 USDC to USD for payroll"
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request POST \
  --url "https://api.primevault.com/api/external/transactions/intent/create/" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Content-Type: application/json" \
  --data '{
    "intent": null,
    "quoteId": "quote_ramp_payroll_1042",
    "externalId": "payroll-top-up-1042",
    "memo": "Convert 10000 USDC to USD for payroll"
  }'

const transaction = await apiClient.createTransactionFromIntent({
  quoteId: "quote_ramp_payroll_1042",
  externalId: "payroll-top-up-1042",
  memo: "Convert 10000 USDC to USD for payroll",
});
console.log(transaction.id, transaction.status);

{
  "id": "transaction_ramp_payroll_1042",
  "orgId": "org_456",
  "vaultId": "vault_usdc_treasury",
  "status": "PENDING",
  "transactionType": "OUTGOING",
  "category": "RAMP",
  "subCategory": "OFF_RAMP",
  "createdAt": "2026-08-04T10:40:00Z",
  "updatedAt": "2026-08-04T10:40:00Z",
  "isDeleted": false,
  "externalId": "payroll-top-up-1042",
  "memo": "Convert 10000 USDC to USD for payroll",
  "blockChain": "ETHEREUM",
  "source": { "type": "VAULT", "id": "vault_usdc_treasury", "chain": "ETHEREUM" },
  "destination": { "type": "BANK_ACCOUNT", "id": "bank_account_usd_payroll", "paymentRail": "ACH" },
  "balanceChanges": {
    "changes": [
      {
        "party": { "type": "VAULT", "id": "vault_usdc_treasury" },
        "asset": "USDC",
        "amount": "-10000.00",
        "chain": "ETHEREUM"
      },
      {
        "party": { "type": "BANK_ACCOUNT", "id": "bank_account_usd_payroll" },
        "asset": "USD",
        "amount": "9975.00",
        "paymentRail": "ACH"
      }
    ]
  },
  "fees": {
    "amount": "25.00",
    "asset": "USDC"
  },
  "quoteResponse": {
    "quoteId": "quote_ramp_payroll_1042",
    "rate": "1",
    "fees": { "amount": "25.00", "asset": "USDC" },
    "input": { "asset": "USDC", "amount": "10000.00" },
    "output": { "asset": "USD", "amount": "9975.00", "vaultId": "vault_usd_settlement" },
    "source": { "type": "VAULT", "id": "vault_usdc_treasury", "chain": "ETHEREUM" },
    "destination": { "type": "BANK_ACCOUNT", "id": "bank_account_usd_payroll", "paymentRail": "ACH" },
    "expiresAt": "2026-09-30T10:00:30+00:00"
  }
}

POST /api/external/transactions/intent/create/ Example: executes the off-ramp quote quote_ramp_payroll_1042, converting 10,000 USDC into 9,975 USD (after a 25 USDC fee) for a payroll bank account.

Request body

string

required

The quoteId returned by Get Quote.

null

Send null when executing a quote. Do not repeat the quote intent.

string

Client reference.

string

Human-readable note.

Response

Returns HTTP 201 with a full Transaction. Optional fields depend on the payment route and status.

string

Transaction ID. Use it with Retrieve Transaction to track status.

string

Lifecycle status. Track it until COMPLETED, FAILED, or DECLINED.

QuoteResponseItem

The executed quote, including its input, output, source, destination, and expiresAt. See QuoteResponseItem.

TransferPartyData

Where the funds come from, as a TransferPartyData. Which fields are present depends on type.

Show Properties

string

VAULT, BANK_ACCOUNT, CONTACT, EXTERNAL_ADDRESS, or EXTERNAL_BANK_ACCOUNT.

string

ID of the vault, bank account, or contact.

string

Display name.

string

Wallet address, for crypto parties.

string

Blockchain, for crypto parties.

string

Payment rail, for bank parties, such as ACH.

TransferPartyData

Where the funds go. Same fields as source. See TransferPartyData.

Show Properties

string

VAULT, BANK_ACCOUNT, CONTACT, EXTERNAL_ADDRESS, or EXTERNAL_BANK_ACCOUNT.

string

ID of the vault, bank account, or contact.

string

Display name.

string

Wallet address, for crypto parties.

string

Blockchain, for crypto parties.

string

Payment rail, for bank parties, such as ACH.

TransactionOperationBalanceChanges | null

Aggregate balance movements across the transaction, when present: the input asset debited and the output asset credited. See TransactionOperationBalanceChanges.

Show Properties

TransactionOperationBalanceChange[]

One entry per party and asset. See TransactionOperationBalanceChange.

Show Properties

TransferPartyData | null

Party whose balance changed. Same fields as source. See TransferPartyData.

string

Asset symbol.

string

Signed decimal string: negative for a debit, positive for a credit.

string

Blockchain, for crypto movements.

string

Payment rail, for fiat movements.

DepositInstructions

Present when funding is required. Use the returned details exactly. See DepositInstructions.

If execution returns a PENDING transaction, the SDK signs and submits the associated change approval and then retrieves the updated transaction.

Request example

{
  "intent": null,
  "quoteId": "quote_ramp_payroll_1042",
  "externalId": "payroll-top-up-1042",
  "memo": "Convert 10000 USDC to USD for payroll"
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request POST \
  --url "https://api.primevault.com/api/external/transactions/intent/create/" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Content-Type: application/json" \
  --data '{
    "intent": null,
    "quoteId": "quote_ramp_payroll_1042",
    "externalId": "payroll-top-up-1042",
    "memo": "Convert 10000 USDC to USD for payroll"
  }'

const transaction = await apiClient.createTransactionFromIntent({
  quoteId: "quote_ramp_payroll_1042",
  externalId: "payroll-top-up-1042",
  memo: "Convert 10000 USDC to USD for payroll",
});
console.log(transaction.id, transaction.status);

{
  "id": "transaction_ramp_payroll_1042",
  "orgId": "org_456",
  "vaultId": "vault_usdc_treasury",
  "status": "PENDING",
  "transactionType": "OUTGOING",
  "category": "RAMP",
  "subCategory": "OFF_RAMP",
  "createdAt": "2026-08-04T10:40:00Z",
  "updatedAt": "2026-08-04T10:40:00Z",
  "isDeleted": false,
  "externalId": "payroll-top-up-1042",
  "memo": "Convert 10000 USDC to USD for payroll",
  "blockChain": "ETHEREUM",
  "source": { "type": "VAULT", "id": "vault_usdc_treasury", "chain": "ETHEREUM" },
  "destination": { "type": "BANK_ACCOUNT", "id": "bank_account_usd_payroll", "paymentRail": "ACH" },
  "balanceChanges": {
    "changes": [
      {
        "party": { "type": "VAULT", "id": "vault_usdc_treasury" },
        "asset": "USDC",
        "amount": "-10000.00",
        "chain": "ETHEREUM"
      },
      {
        "party": { "type": "BANK_ACCOUNT", "id": "bank_account_usd_payroll" },
        "asset": "USD",
        "amount": "9975.00",
        "paymentRail": "ACH"
      }
    ]
  },
  "fees": {
    "amount": "25.00",
    "asset": "USDC"
  },
  "quoteResponse": {
    "quoteId": "quote_ramp_payroll_1042",
    "rate": "1",
    "fees": { "amount": "25.00", "asset": "USDC" },
    "input": { "asset": "USDC", "amount": "10000.00" },
    "output": { "asset": "USD", "amount": "9975.00", "vaultId": "vault_usd_settlement" },
    "source": { "type": "VAULT", "id": "vault_usdc_treasury", "chain": "ETHEREUM" },
    "destination": { "type": "BANK_ACCOUNT", "id": "bank_account_usd_payroll", "paymentRail": "ACH" },
    "expiresAt": "2026-09-30T10:00:30+00:00"
  }
}

⌘I

Request example

{
  "intent": null,
  "quoteId": "quote_ramp_payroll_1042",
  "externalId": "payroll-top-up-1042",
  "memo": "Convert 10000 USDC to USD for payroll"
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request POST \
  --url "https://api.primevault.com/api/external/transactions/intent/create/" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Content-Type: application/json" \
  --data '{
    "intent": null,
    "quoteId": "quote_ramp_payroll_1042",
    "externalId": "payroll-top-up-1042",
    "memo": "Convert 10000 USDC to USD for payroll"
  }'

const transaction = await apiClient.createTransactionFromIntent({
  quoteId: "quote_ramp_payroll_1042",
  externalId: "payroll-top-up-1042",
  memo: "Convert 10000 USDC to USD for payroll",
});
console.log(transaction.id, transaction.status);

{
  "id": "transaction_ramp_payroll_1042",
  "orgId": "org_456",
  "vaultId": "vault_usdc_treasury",
  "status": "PENDING",
  "transactionType": "OUTGOING",
  "category": "RAMP",
  "subCategory": "OFF_RAMP",
  "createdAt": "2026-08-04T10:40:00Z",
  "updatedAt": "2026-08-04T10:40:00Z",
  "isDeleted": false,
  "externalId": "payroll-top-up-1042",
  "memo": "Convert 10000 USDC to USD for payroll",
  "blockChain": "ETHEREUM",
  "source": { "type": "VAULT", "id": "vault_usdc_treasury", "chain": "ETHEREUM" },
  "destination": { "type": "BANK_ACCOUNT", "id": "bank_account_usd_payroll", "paymentRail": "ACH" },
  "balanceChanges": {
    "changes": [
      {
        "party": { "type": "VAULT", "id": "vault_usdc_treasury" },
        "asset": "USDC",
        "amount": "-10000.00",
        "chain": "ETHEREUM"
      },
      {
        "party": { "type": "BANK_ACCOUNT", "id": "bank_account_usd_payroll" },
        "asset": "USD",
        "amount": "9975.00",
        "paymentRail": "ACH"
      }
    ]
  },
  "fees": {
    "amount": "25.00",
    "asset": "USDC"
  },
  "quoteResponse": {
    "quoteId": "quote_ramp_payroll_1042",
    "rate": "1",
    "fees": { "amount": "25.00", "asset": "USDC" },
    "input": { "asset": "USDC", "amount": "10000.00" },
    "output": { "asset": "USD", "amount": "9975.00", "vaultId": "vault_usd_settlement" },
    "source": { "type": "VAULT", "id": "vault_usdc_treasury", "chain": "ETHEREUM" },
    "destination": { "type": "BANK_ACCOUNT", "id": "bank_account_usd_payroll", "paymentRail": "ACH" },
    "expiresAt": "2026-09-30T10:00:30+00:00"
  }
}

API Basics

Accounts

Sub-Orgs

Transactions

Request body

Response

​Request body

​Response

Request body

Response