v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB

Flow Internal

Set funding address for Flow transfer

Allows onramps (agents in a Flow transfer) to provide funding address information. The funding information is stored in the transfer (replacing any existing) and a Fund TAP message is broadcast to all agents in the transfer. This endpoint should be called after the onramp is added as an agent to the Flow transfer.

post/entities/{entityDID}/flow/{transferId}/fund

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

Example:did:web:vasps.id:jxnl0411:at

The DID of the entity

transferIdstring uuid required

Transfer ID for the Flow transaction

Request body

amountstring required

Amount to fund in the specified currency

currencystring required

Currency code (ISO-4217 for fiat)

fundingAddressstring

CAIP-10 address for crypto funding

fundingAccountstring

PayTo URI for fiat funding (RFC 8905). Supports iban, ach, bitcoin, void types.

forstring required

DID of the party this funding is for (customerDID or merchantDID)

feestring

Optional fee percentage

Example request

{
  "amount": "100.00",
  "currency": "USD",
  "fundingAddress": "eip155:1:0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
  "fundingAccount": "payto://iban/DE75512108001245126199",
  "for": "did:example:customer",
  "fee": "1.5"
}

Response

Funding address added successfully

successboolean

transferobject

Updated transfer object