latestOpenAPI 3.1.02026-08-108094177.6 KB

087dcf516ce2

Delegated Contract Mode

Create on-ramp request

Delegated Contract Mode will be deprecated soon; new partners should use Managed Custody Mode. On-ramp is not yet generally available; this endpoint is documented for preview only. Exchanges a fiat token to USDC and optionally performs a swap or bridge to the target token based on the quote from /v1/onramp/quote. Omit the dst* fields to perform fiat to USDC only.

post/v1/onramp

Headers

X-Api-Signaturestring required

Partner's EIP-191 signature (0x-prefixed hex).

X-Api-Deadlinestring required

Unix seconds when the request signature expires (within 5 minutes).

X-Api-PublicKeystring

Partner's signer Ethereum address.

Request body

quoteIdstring required

Quote ID from /v1/onramp/quote.

requestIdstring required

Idempotency key; reuse on retry.

urIdinteger required

UR user ID.

tokenInstring required

Fiat token symbol from /v1/tokens.

amountInstring required

Input amount in smallest units. After conversion, must be at least 5 USDC.

withdrawAddressstring

User-specified withdrawal address for the on-ramp.

chainIdstring

Source chain ID (currently Mantle only).

dstChainIdstring

Destination chain ID for the bridge or swap.

dstAggregatorstring

Aggregator contract address from best.aggregator in the quote.

dstTokenOutstring

Destination token symbol.

dstSwapCalldatastring

best.swapCalldata from the quote.

dstMinAmountOutstring

Minimum acceptable amount in smallest units, from best.minUsdcAmount.

Response

Response envelope. For the user API, retCode 0 means success; for the partner API, code 0 means success. Business rejections return HTTP 200 with a non-zero code.

codeinteger required

0 on success; non-zero indicates a business rejection.

messagestring required

Human-readable diagnostic; empty on success.

{"stackTrail":"components:schemas:DcEnvelope:properties:data","oasType":"schema","type":"unknown","description":"Business payload. Shape depends on the endpoint."}