> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bridge.linkio.world/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an offramp

> Start a payment where the customer sends stablecoin and receives fiat.

Requires the **Ramps, banks & methods** scope (offramp write). See [Offramp](https://docs.bridge.linkio.world/flows/offramp.md) for a walkthrough.

## Headers

**API-Version** `string` *required* (default: 2026-10-29-atlas)

Your account's API version.

**Idempotency-Key** `string`

Recommended. A unique value so retries don't create a second payment.

## Body

**customer\_id** `string` *required*

The customer. Must match the quote's customer.

**quote\_id** `string` *required*

An unexpired, unused offramp quote.

**party** `string` (default: 1st)

`1st` if the money goes to the customer, `3rd` if it goes to someone else.

**payment\_details** `object` *required*

The account that receives the fiat.

**fields**

**type** `string` *required*

`bank_transfer` or `momo`. Must match the quote's `payout_method`.

**currency** `string` *required*

Must match the quote's `target_currency`.

**details.bank\_code** `string` *required*

Bank code, or mobile money network code.

**details.account\_number** `string` *required*

Account number (NGN: 10 digits) or mobile money number (10 to 12 digits).

**details.account\_name** `string` *required*

Account holder's name, 2 to 100 characters.

**source\_wallet** `object` *required*

The wallet the stablecoin is sent from.

**fields**

**currency** `string` *required*

The stablecoin, for example `USDC`. Must match the quote's `source_currency`.

**address** `string` *required*

The wallet address.

**network** `string` *required*

The network.

## Response

`202 Accepted`

**status** `string`

`success`

**message** `string`

`Offramp payment initiated`

**payment** `object`

**fields**

**id** `string`

Payment ID, starting with `pay_`.

**status** `string`

`pending`

**state** `string`

The current state, usually `initiated`.

**event\_id** `string`

The first event's ID.

**deposit** `object`

Where the customer sends the stablecoin.

**fields**

**type** `string`

`stablecoin`

**currency** `string`

The stablecoin, for example `USDC`.

**details.address** `string`

The deposit address.

**details.network** `string`

The network to send on.

**details.tag** `string | null`

A memo or tag. Include it if it isn't `null`.

## Errors

The same as [Create an onramp](https://docs.bridge.linkio.world/api-reference/payments/onramp.md#errors). Offramp-specific `validation_failed` messages are listed on the [Offramp](https://docs.bridge.linkio.world/flows/offramp.md#what-can-go-wrong-when-you-create-it) page.

```bash NGN bank theme={null}
curl -X POST https://sandbox.core.linkio.world/api/payments/offramp \
  -H "X-BRIDGE-API-Key: $BRIDGE_API_KEY" \
  -H "API-Version: 2026-10-29-atlas" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: withdrawal-2001" \
  -d '{
    "customer_id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE",
    "quote_id": "qte_1wZ4cB6dE8fK2mQ9xLp3VnR7tY",
    "payment_details": {
      "type": "bank_transfer",
      "currency": "NGN",
      "details": { "bank_code": "058", "account_number": "0123456789", "account_name": "Ada Obi" }
    },
    "source_wallet": { "currency": "USDC", "address": "0x666AA9b24a7D604Fe5C534aEd4885d2B4DD387e8", "network": "base" }
  }'
```

```json 202 theme={null}
{
  "status": "success",
  "message": "Offramp payment initiated",
  "payment": {
    "id": "pay_3VnR7tY1wZ4cB6dE8fK2mQ9xLp",
    "status": "pending",
    "state": "initiated",
    "event_id": "evt_7tY1wZ4cB6dE8fK2mQ9xLp3VnR",
    "deposit": {
      "type": "stablecoin",
      "currency": "USDC",
      "details": {
        "address": "0x666AA9b24a7D604Fe5C534aEd4885d2B4DD387e8",
        "network": "base",
        "tag": null
      }
    }
  }
}
```

```json 422 theme={null}
{
  "error": {
    "type": "validation_error",
    "code": "validation_failed",
    "message": "source_wallet is required",
    "request_id": "req_3VnR7tY1wZ4cB6dE8fK2mQ9xLp",
    "status": 422,
    "errors": [
      { "field": "source_wallet", "message": "source_wallet is required" }
    ]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.