---
title: "Create an offramp request"
method: POST
path: "/v1/offramp"
tags: ["Offramp"]
deprecated: true
---

# Create an offramp request

`POST /v1/offramp`

> **Deprecated.**

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

## Request body

- CreateOfframpRequestRequest — Offramp request details
  - `network` string, required
  - `token` string, required
  - `amount` number, required
  - `email` string, email, required
  - `customer` object, required
    - `country` 'US', required
  - `successReturnUrl` string
  - `failReturnUrl` string
  - `settings` object
    - `payByMerchant` true
    - `feePayByMerchant` true
    - `releaseMethod` 'automatic' | 'manual'
  - `clientReferenceId` union
    - boolean
    - number
    - object
    - string

## Response `200`

Success

- object — The created offramp
  - `status` 'SUCCEEDED', required
  - `data` CreateOfframpRequestResponse, required
    - `id` string, required
    - `url` string, required
    - `network` 'ETHEREUM' | 'OPTIMISM' | 'BINANCE' | 'POLYGON' | 'ARBITRUM' | 'AVALANCHE' | 'SOLANA' | 'TRON' | 'BASE' | 'BITCOIN', required
    - `token` string, required
    - `amount` number, required
    - `createdAt` number, required
    - `updatedAt` number
    - `email` string, required
    - `payByMerchant` boolean, required
    - `feePayByMerchant` boolean, required
    - `clientReferenceId` string, required
    - `successReturnUrl` string
    - `failReturnUrl` string
    - `status` 'CREATED' | 'SUCCEEDED' | 'CANCELED' | 'EXPIRED' | 'PENDING_USER_ONBOARDING' | 'USER_ACCOUNT_ISSUE' | 'PENDING_USER_WITHDRAWAL' | 'REQUIRES_RELEASE' | 'PENDING_DEPOSIT_CRYPTO_USER' | 'PENDING_DEPOSIT_CRYPTO_MERCHANT' | 'IN_PROGRESS' | 'PENDING_MANUAL_INVESTIGATION' | 'REFUNDED' | 'REJECTED', required
    - `livemode` boolean, required
    - `customerCountry` string, required
    - `customerRegion` string
    - `releaseMethod` 'automatic' | 'manual', required
    - `refundedAt` number
    - `receiverBankAccountId` string
    - `rejectionReason` union
      - 'UNDERAGE' | 'UNSUPPORTED_STATE' | 'USER_NAME_MISMATCH' | 'RISKY'
      - 'UNSUPPORTED_STATE' | 'UNDERAGE' | 'GENERIC_REJECTION'

## Other responses

- `400` — Bad request
- `401` — Unauthorized

---

[API](https://skmtc.dev/breeze/apis/breeze-api.md) · [All operations](https://skmtc.dev/breeze/apis/breeze-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/breeze/breeze-api/revisions/8911892bdf29/schema)