Skip to content

BRIJ Tier 1 Partner Integration Guide

Overview

This guide describes how to integrate with BRIJ as a Tier 1 Partner. As a Tier 1 partner, BRIJ acts as an aggregator for your crypto on/off-ramp services, displaying your payment options alongside other partners. When customers select your service, they are redirected to your platform to complete the transaction.

Prerequisites

  • API Key: BRIJ will provide you with an API key for authentication
  • Base URLs: Provide BRIJ with your JSON API base URLs for:
    • Quote endpoint
    • Redirect order creation endpoint
  • Supported configurations: Define your supported countries, currencies, payment methods, and limits

Part 1: Sync Your Payment Options to BRIJ

See Syncing Payment Options page.

Part 2: Implement Your Partner API

BRIJ will call your API endpoints to get quotes and create redirect orders. You must implement two JSON API endpoints:

For information on verifying that requests originate from BRIJ, see Signature Verification.

Integration Flow

1. Initial Setup

  1. BRIJ provides you with an API key
  2. You provide BRIJ with your API endpoint URLs
  3. You call SyncPaymentOptions to register your capabilities

2. Runtime Flow

  1. Customer browses available options on BRIJ
  2. BRIJ calls your /quote endpoint to get live prices
  3. Customer selects your service
  4. BRIJ calls your /redirect-order endpoint
  5. Customer is redirected to your platform via redirectUrl
  6. Customer completes transaction on your platform

Best Practices

1. Sync Frequency

  • Sync payment options whenever your capabilities change
  • Full replacement mode means you don't need to track deltas

2. Quote Caching

  • Return fresh quotes on each request
  • Consider short-lived quote IDs (e.g., 5-10 minutes)
  • Include expiration times in rawResponse

3. Error Handling

  • Return appropriate HTTP status codes
  • Include descriptive error messages for debugging
  • Log all requests for troubleshooting

4. Performance

  • Quote endpoint should respond within 2 seconds
  • Redirect order endpoint should respond within 5 seconds

5. Security

  • Use HTTPS for all endpoints
  • Validate all input parameters
  • Use the X-Forwarded-For header for fraud detection
  • Implement your own authentication if needed (via URL parameters)

Testing

Test Credentials

Contact BRIJ support for test API keys and sandbox endpoint URLs.