For AI agents: the documentation index is at /llms.txt, and this page is available as Markdown at /api/gateway/prepare-ramp-transfer.md.

Prepare a ramp's on-chain transfer

Organization tokenNo token

POST
/ramps/{id}/prepare

Returns the unsigned payloads that send the user's stablecoin to the provider's deposit address. Call this once the provider page has been completed, and after the bridge plan if the create response returned one. Offramps only.

Rate limit: counts against the Money movement limit, 20 a minute and 300 a day (user token, per user); 200 a minute and 3,000 a day (organization api key, per organization). See Rate limits.

Authorization

bearerAuth
headerAuthorizationBearer <JWT>

An access token from POST /v1/auth/api-key/token. An organization token lasts one hour and has no refresh token; a personal token can be refreshed.

Path Parameters

id*string

Ramp ID (UUID)

Formatuuid

Header Parameters

TM-On-Behalf-Of?string

Act as one of your organization's users. The value is the user_id returned when the user was created; the request then reads and writes that user's account. Requires an organization token and a user your organization created: 400 for a personal token, a repeated header or a non-UUID, 403 for a user outside your organization. Not accepted on organization-scoped routes.

Formatuuid

Response Body

Transfer prepared successfully

application/json
  1. response

Unsigned payloads for the transfer that sends funds to the provider

transfer_id*string
payloads*array<>
Example Request
curl -X POST 'https://api.truemarkets.co/v1/gateway/ramps/497f6eca-6276-4993-bfeb-53cbbbba6f08/prepare' \  -H 'TM-On-Behalf-Of: 3f6d2c0e-8a41-4c2b-9f1e-2b7d5c0a9e11'
Example Response
{  "transfer_id": "string",  "payloads": [    {      "digest": "string",      "payload": "string"    }  ]}