Remitflex Documentation

This guide walks through a complete flow: get an API key, create a payment link, and poll until it’s paid. Examples use the test key prefix rmf_test_.

Prerequisites

A Remitflex account at dashboard.remitflex.io
curl or Node.js
For integration testing, use a test API key (rmf_test_) — see Testing

API keys are created in the dashboard (JWT login required). You cannot create keys via the public API.

Step 1 — Create an API key

Log in to the dashboard (email + OTP).
Go to Settings → API Keys → Create new key.
Environment: test
Permissions: full access (api:read + api:write)
Copy the key and export it:

export REMITFLEX_API_KEY="rmf_test_YOUR_KEY_HERE"
export API_BASE="https://api.remitflex.io/v1"

Step 2 — Create a payment link

Mutating API-key requests require an idempotency key:

curl -s -X POST "$API_BASE/collections" \
  -H "Authorization: Bearer $REMITFLEX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "linkMode": "invoice",
    "pricingType": "fixed",
    "amount": 10,
    "destinationChainKey": "solana",
    "destinationCurrency": "USDC",
    "destinationAddress": "YOUR_SOLANA_WALLET_ADDRESS",
    "label": "First payment"
  }' | jq .

The response includes a payUrl. Open it to see the hosted pay page, or embed it — see Payment links.

{
  "status": "success",
  "message": "Payment link created",
  "data": {
    "id": "1b2c3d4e-5f6a-7890-bcde-f12345678901",
    "status": "awaiting_origin",
    "payUrl": "https://pay.remitflex.io/1b2c3d4e-5f6a-7890-bcde-f12345678901"
  }
}

Step 3 — Poll link status

LINK_ID="1b2c3d4e-5f6a-7890-bcde-f12345678901"

curl -s "$API_BASE/collections/$LINK_ID" \
  -H "Authorization: Bearer $REMITFLEX_API_KEY" | jq '.data.status'

Step 4 — List transactions

curl -s "$API_BASE/transactions" \
  -H "Authorization: Bearer $REMITFLEX_API_KEY" | jq '.data.transactions[:3]'

Next steps

Customers to organise payers and beneficiaries
Payment links for invoice and checkout pay URLs
Payment routes for cross-chain collection
Local fiat for bank payouts and fiat deposits
Authentication for scopes and key security
Idempotency for retry-safe writes

Get started

Concepts

Collect

Convert & FX

Local money

Customers & ledger

Integration

Quickstart: your first payment

Prerequisites

Step 1 — Create an API key

Step 2 — Create a payment link

Step 3 — Poll link status

Step 4 — List transactions

Next steps

​Prerequisites

​Step 1 — Create an API key

​Step 2 — Create a payment link

​Step 3 — Poll link status

​Step 4 — List transactions

​Next steps

Prerequisites

Step 1 — Create an API key

Step 2 — Create a payment link

Step 3 — Poll link status

Step 4 — List transactions

Next steps