Skip to main content
Preview Documentation — This integration is in final testing. API shapes are stable; endpoints will be live shortly. Contact your RebelFi rep if you have questions before go-live.

Create Merchant

Creates a new merchant and initiates KYB verification.
POST /v1/ramp/merchants

Request

name
string
required
Business name
type
string
default:"business"
Business type
external_id
string
Your internal reference ID for this merchant
curl -X POST "https://api.rebelfi.io/v1/ramp/merchants" \
  -H "x-api-key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "OnEdge",
    "type": "business",
    "external_id": "your-internal-ref-123"
  }'

Response

{
  "id": 1,
  "name": "OnEdge",
  "type": "business",
  "external_id": "your-internal-ref-123",
  "kyb_status": "pending",
  "kyb_url": "https://kyb.provider.com/verify/abc123",
  "created_at": "2026-03-15T10:00:00Z"
}
id
number
Unique merchant identifier
name
string
Business name
type
string
Business type
external_id
string
Your internal reference ID (if provided)
kyb_status
string
Current KYB status: pending, submitted, approved, or declined
kyb_url
string
Hosted KYB verification URL — send this to your merchant
created_at
string
ISO 8601 creation timestamp

List Merchants

Returns all merchants with KYB status and volume summaries.
GET /v1/ramp/merchants

Query Parameters

status
string
Filter by KYB status: pending, submitted, approved, declined
page
integer
default:"1"
Page number
per_page
integer
default:"20"
Results per page (max 100)
curl "https://api.rebelfi.io/v1/ramp/merchants?status=approved&page=1&per_page=20" \
  -H "x-api-key: your_api_key"

Response

{
  "data": [
    {
      "id": 1,
      "name": "OnEdge",
      "type": "business",
      "kyb_status": "approved",
      "kyb_url": "https://kyb.provider.com/verify/abc123",
      "bank_account": {
        "id": 1,
        "account_number": "12345678",
        "routing_number": "987654321",
        "bank_name": "Lead Bank",
        "capabilities": ["ach", "fedwire"],
        "status": "active"
      },
      "total_volume_usd": 450000,
      "monthly_volume_usd": 125000,
      "transaction_count": 28,
      "created_at": "2026-03-15T10:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 12
  }
}

Get Merchant

Returns a single merchant with full detail. The bank_account object is only present when kyb_status is approved.
GET /v1/ramp/merchants/{id}
id
integer
required
Merchant ID
curl "https://api.rebelfi.io/v1/ramp/merchants/1" \
  -H "x-api-key: your_api_key"

Response

{
  "id": 1,
  "name": "OnEdge",
  "type": "business",
  "external_id": "your-internal-ref-123",
  "kyb_status": "approved",
  "kyb_url": "https://kyb.provider.com/verify/abc123",
  "bank_account": {
    "id": 1,
    "account_number": "12345678",
    "routing_number": "987654321",
    "bank_name": "Lead Bank",
    "capabilities": ["ach", "fedwire"],
    "status": "active"
  },
  "total_volume_usd": 450000,
  "monthly_volume_usd": 125000,
  "transaction_count": 28,
  "created_at": "2026-03-15T10:00:00Z"
}