Skip to main content
GET
/
rate
/
offramp
Get rate
curl --request GET \
  --url https://processor-prod.up.railway.app/rate/offramp \
  --header 'x-service-key: <api-key>'
{
  "success": true,
  "status": 200,
  "message": "Offramp rate fetched successfully",
  "timestamp": "2025-09-10T01:34:18.649Z",
  "data": {
    "rate": 1515
  }
}

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

Query Parameters

​
currency
enum<string>
required

The currency code to get the offramp rate for

Available options:
NGN
Example:

"NGN"

Response

200 - application/json

Offramp rate fetched successfully

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Offramp rate fetched successfully"

​
timestamp
string<date-time>
Example:

"2025-09-10T01:34:18.649Z"

​
data
object