Offramp

Create an offramp request

Changed on Nov 3, 2026

Creates a new offramp request. Deprecated in favor of Payout Pages.

post/v1/offramp

Request

Base URL
https://api.breeze.cash
Auth
HTTP basic
TypeScript
https://skmtc.dev/breeze/apis/breeze-api/docs/v1/offramp/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

networkstring required

tokenstring required

amountnumber required

emailstring email required

successReturnUrlstring

failReturnUrlstring

Response

Success

status'SUCCEEDED' required

Changes

Nov 3, 20264af083d182a6 Revision changes
- info
  the request property's max was increased from 1000000.00 to 10000000.00

Operation history