Skip to main content
POST
/
offramp
Execute offramp
curl --request POST \
  --url https://processor-prod.up.railway.app/offramp \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: <api-key>' \
  --data '
{
  "wallet_id": "68bb7d8399900e253084e6f9",
  "amount": 100,
  "beneficiary_id": "68bf2eba196a18d7bd166184",
  "asset": "base:usdc"
}
'
{
  "success": true,
  "status": 200,
  "message": "Offramp initiated successfully",
  "timestamp": "2025-09-09T23:34:20.478Z",
  "data": {
    "reference": "n4ri27oeopl9m5tuzbpe03cmvq4d1j80"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bread.africa/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-service-key
string
header
required

Body

application/json
​
wallet_id
string
required

The wallet ID to offramp from

Example:

"68bb7d8399900e253084e6f9"

​
amount
number
required

Amount to offramp

Example:

100

​
beneficiary_id
string
required

The beneficiary ID to receive the offramp payout

Example:

"68bf2eba196a18d7bd166184"

​
asset
enum<string>
required

The asset to offramp

Available options:
ethereum:usdc,
base:usdc,
arbitrum:usdc,
solana:usdc,
bsc:usdc,
polygon:usdc,
optimism:usdc,
avalanche:usdc,
ethereum:usdt,
arbitrum:usdt,
solana:usdt,
polygon:usdt,
bsc:usdt,
optimism:usdt,
avalanche:usdt,
base:cngn,
bsc:cngn
Example:

"base:usdc"

Response

200 - application/json

Offramp initiated successfully

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Offramp initiated successfully"

​
timestamp
string<date-time>
Example:

"2025-09-09T23:34:20.478Z"

​
data
object