# RAMFi Developer Documentation

> RAMFi is Reliant Payment's embedded fintech platform: onboard and KYC end users, move fiat over ACH and card rails, hold and convert digital assets, send funds on-chain, and run campaign-based payout disbursements - one REST API plus client SDKs, with compliance, custody, and money-transmission licensing handled by Reliant (a licensed money transmitter with sponsor bank coverage).

Authentication: exchange a long-lived Main Token for a short-term bearer token via ProvisionToken; every authenticated call sends `Authorization: Bearer <token>` plus an `X-OTP` header (RFC 6238 TOTP from your seed). Responses use the envelope `{ isSuccess, result, errorMessage }`. Sandbox base URL: https://FQDN (request access from your Reliant integration specialist); production follows contracting and compliance approval.

## Documentation pages

- [Home](RAMFi_Developer_Guide.html): platform overview, doc map, use cases, and the company onboarding journey (1. learn via Glossary + API Reference, 2. request a testing environment, 3. production after contracting & compliance approval).
- [Getting Started](RAMFi_Getting_Started.html): authentication model, core workflows as swim-lane diagrams, client status lifecycle, best practices.
- [API Reference](RAMFi_NewEndpoints_Documentation.html): all endpoints by task name with typed field tables, per-status-code example responses, and a working cURL generator (including a TOTP generator for X-OTP).
- [SDK Reference](RAMFi_SDKs.html): Bank Connection SDK (open-banking account linking for ACH), End User Agreement SDK (hosted agreement capture), PayPal Connect SDK (popup OAuth to link PayPal for disbursement payouts), Card Capture SDK (tokenizes debit card details for PullFromCard / PushToCard - coming soon, not yet enabled).
- [Data Models](RAMFi_Data_Models.html): interactive object map; click any object for its fields plus the endpoints and SDKs that touch it. Includes enums (AccountStatus, CurrencyType, DocumentType) and the response envelope.
- [Glossary](RAMFi_Glossary.html): every platform term defined, linked to its endpoint or SDK.
- Recipes - end-to-end build patterns with runnable cURL/JavaScript/Python per call:
  - [Recipes Overview](RAMFi_Recipes.html)
  - [Digital Asset On / Off-Ramp](RAMFi_Recipe_Crypto_Ramp.html): USD in -> convert -> on-chain out; or digital asset in -> convert -> ACH out.
  - [Cross-Border Remittance (Stablecoins)](RAMFi_Recipe_Remittance.html): onboard sender, fund USD, convert to stablecoin, deliver on-chain to a recipient wallet.
  - [Cross-Border Remittance (Fiat)](RAMFi_Recipe_Remittance_Fiat.html): fund USD, then deliver fiat abroad through the Cross Border disbursement rail; no recipient wallet needed.
  - [Debt Settlement](RAMFi_Recipe_Debt_Settlement.html): recurring ACH drafts into a settlement balance, monitor returns, disburse to creditors, refund remainder.
  - [Gaming](RAMFi_Recipe_Gaming.html): instant card deposits and payouts around a held player balance.
  - Disbursements: campaign-based payouts (api/Disbursement) — read campaigns and their per-rail fees, provision payees in a batch, update a payee.

## API endpoints

### Authentication
- Provision Token - POST /api/FE/ProvisionToken (RAMFi_NewEndpoints_Documentation.html#endpoint-provision-token)
- Expire Token - DELETE /api/FE/ExpireToken (RAMFi_NewEndpoints_Documentation.html#endpoint-expire-token)

### Client Management
- Create Client - POST /api/FE/NewClient (RAMFi_NewEndpoints_Documentation.html#endpoint-new-client)
- Get Client - GET /api/FE/GetClient (RAMFi_NewEndpoints_Documentation.html#endpoint-get-client)
- Get All Clients - GET /api/FE/GetAllClients (RAMFi_NewEndpoints_Documentation.html#endpoint-get-all-clients)
- Update Client - PATCH /api/FE/UpdateClient (RAMFi_NewEndpoints_Documentation.html#endpoint-update-client)
- Close Client - PATCH /api/FE/CloseClient (RAMFi_NewEndpoints_Documentation.html#endpoint-close-client)

### Document Management
- Add Document - POST /api/FE/AddDocument (RAMFi_NewEndpoints_Documentation.html#endpoint-add-document)
- Get Document Status - GET /api/FE/GetDocumentStatus (RAMFi_NewEndpoints_Documentation.html#endpoint-get-document-status)

### Funds Management
- Add Client Funds - POST /api/FE/AddClientFunds (RAMFi_NewEndpoints_Documentation.html#endpoint-add-client-funds)
- Add Pending Funds - POST /api/FE/AddPendingFunds (RAMFi_NewEndpoints_Documentation.html#endpoint-add-pending-funds)
- Get Deposit Info - GET /api/FE/GetDepositInfo (RAMFi_NewEndpoints_Documentation.html#endpoint-get-deposit-info)
- Add Funds from Bank Account - POST /api/FE/AddFundsFromBankAccount (RAMFi_NewEndpoints_Documentation.html#endpoint-add-funds-from-bank)
- Add Funds from Wallet Address - POST /api/FE/AddFundsFromAddress (RAMFi_NewEndpoints_Documentation.html#endpoint-add-funds-from-address)
- Withdraw Client Funds - POST /api/FE/WithdrawClientFunds (RAMFi_NewEndpoints_Documentation.html#endpoint-withdraw-client-funds)
- Convert Client Funds - POST /api/FE/ConvertClientFunds (RAMFi_NewEndpoints_Documentation.html#endpoint-convert-client-funds)
- Spot Price - GET /api/FE/SpotPrice (RAMFi_NewEndpoints_Documentation.html#endpoint-spot-price)
- Transfer Client Funds - POST /api/FE/TransferClientFunds (RAMFi_NewEndpoints_Documentation.html#endpoint-transfer-client-funds)
- Cancel Bank Draft - PATCH /api/FE/CancelBankDraft (RAMFi_NewEndpoints_Documentation.html#endpoint-cancel-bank-draft)

### Digital Asset Wallet Operations
- Send Funds to Address - POST /api/FE/SendFundsToAddress (RAMFi_NewEndpoints_Documentation.html#endpoint-send-funds-to-address)
- Add Wallet Address - POST /api/FE/AddWalletAddress (RAMFi_NewEndpoints_Documentation.html#endpoint-add-wallet-address)

### Reporting
- All Balances - GET /api/FE/Reporting/AllBalances (RAMFi_NewEndpoints_Documentation.html#endpoint-all-balances)
- Client Balance - GET /api/FE/Reporting/ClientBalance (RAMFi_NewEndpoints_Documentation.html#endpoint-client-balance)
- Client Ledger - GET /api/FE/Reporting/ClientLedger/{clientId} (RAMFi_NewEndpoints_Documentation.html#endpoint-client-ledger)
- Returns Report - GET /api/FE/Reporting/Returns (RAMFi_NewEndpoints_Documentation.html#endpoint-returns)
- Held Clients - GET /api/FE/Reporting/HeldClients (RAMFi_NewEndpoints_Documentation.html#endpoint-held-clients)
- Transactions Report - GET /api/FE/Reporting/Transactions (RAMFi_NewEndpoints_Documentation.html#endpoint-transactions)

### Linked Account Intelligence
> Coming soon - not yet enabled. Request schemas are confirmed; response shapes and rollout timing are not yet finalized.
- Account Holder Name - GET /api/FE/LinkedAccount/AccountHolderName/{clientId}/{linkedAccountId} (RAMFi_NewEndpoints_Documentation.html#endpoint-account-holder-name)
- Linked Account Balance - GET /api/FE/LinkedAccount/Balance/{clientId}/{linkedAccountId} (RAMFi_NewEndpoints_Documentation.html#endpoint-linked-account-balance)
- Linked Account History - GET /api/FE/LinkedAccount/History/{clientId}/{linkedAccountId} (RAMFi_NewEndpoints_Documentation.html#endpoint-linked-account-history)
- Account Validation - POST /api/FE/LinkedAccount/AccountValidation (RAMFi_NewEndpoints_Documentation.html#endpoint-account-validation)
- Transaction Risk Score - POST /api/FE/LinkedAccount/AccountValidation/TransactionRiskScore (RAMFi_NewEndpoints_Documentation.html#endpoint-transaction-risk-score)

### Bank Account Management
- Get Bank Account - GET /api/FE/BankAccount/{clientId} (RAMFi_NewEndpoints_Documentation.html#endpoint-get-bank-account)
- Update Default Bank Account - POST /api/FE/BankAccount/UpdateDefault (RAMFi_NewEndpoints_Documentation.html#endpoint-update-default-bank)

### Card Operations
> Coming soon - not yet enabled. Request schemas are confirmed; response shapes and rollout timing are not yet finalized.
- Get Card on File - GET /api/FE/Card/{clientId} (RAMFi_NewEndpoints_Documentation.html#endpoint-get-card-on-file)
- Pull from Card - POST /api/FE/Card/PullFromCard (RAMFi_NewEndpoints_Documentation.html#endpoint-pull-from-card)
- Push to Card - POST /api/FE/Card/PushToCard (RAMFi_NewEndpoints_Documentation.html#endpoint-push-to-card)

### Disbursements
Campaign-based payouts on the api/Disbursement controller. Standard { resultModel, isSuccess, errorMessage } envelope; bearer token + X-OTP. Campaigns are created/updated by Reliant administrators, so this API is read-only for campaigns.
- Get Campaign - GET /api/Disbursement/Campaign?payeeId={int} (RAMFi_NewEndpoints_Documentation.html#endpoint-get-campaign)
- Add Consumers - POST /api/Disbursement/Consumers (RAMFi_NewEndpoints_Documentation.html#endpoint-add-consumers)
- Get Consumers - GET /api/Disbursement/Consumers (RAMFi_NewEndpoints_Documentation.html#endpoint-get-consumers)
- Update Consumer - PATCH /api/Disbursement/Consumers (RAMFi_NewEndpoints_Documentation.html#endpoint-update-consumers)

## Key concepts

- clientID: your external identifier for an end user, set at Create Client and used on nearly every call.
- externalReference: your unique per-transaction reconciliation key; query Transactions / Client Ledger to reconcile.
- PUSD: pending USD from ACH drafts; non-tradable for ~2 business days until cleared.
- Whitelisting / KYA: digital asset addresses must be registered and AML-screened via Add Wallet Address before sends or deposits.
- Hold status: set after a returned draft; resolve and set the client back to Active via Update Client before retrying.
- cardId: a tokenized card identifier (never a raw PAN); raw card numbers never reach your application.
- Disbursements (api/Disbursement): campaigns are created/updated by Reliant administrators (read-only via the API) and read via Get Campaign (with per-rail fees); payees (consumers) are provisioned in a batch via Add Consumers, listed via Get Consumers, and edited via Update Consumer. A consumer's dscid is the payeeId used to filter Get Campaign.
- Get Client is modeled on Reliant's Fund Disbursement API; confirm availability and final field shapes with RAMFi before building.

## Optional

- Support: contact your RAMFi integration specialist.