Find the concepts, API references, SDK guidance, and examples needed to explore Orbbitly’s financial infrastructure.
# Conceptual example — not a production endpoint POST /v1/transactions { "type": "marketplace.sale", "amount": 1000, "currency": "BDT", "reference": "order_8841" }
201 Created { "id": "txn_orb_29f", "entries": 3, "status": "recorded" }
Follow five steps in a development environment. Every snippet uses sandbox credentials — never paste real secrets into examples.
- A development account with sandbox access
- Node.js 18+ or any HTTP client
- 10 minutes
# Conceptual example
orbbitly env create --name dev-sandbox✓ Environment dev-sandbox created
Search by capability, check the required parameters, and copy a request in your language.
Example endpoints for illustration — check the API reference for real paths.
POST/transactions
Record a transaction and its ledger entries.
| Parameter | Required |
|---|---|
type | required |
amount | required |
currency | required |
reference | optional |
# Example request (conceptual)
curl -X POST "https://sandbox.api.example.com/v1/transactions" \
-H "Authorization: Bearer $ORBBITLY_TEST_KEY" \
-H "Content-Type: application/json" \
-d '{ "type": "type_123", "amount": 1000, "currency": "currency_123", "reference": "reference_123" }'Response preview 201
{
"id": "txn_29f",
"status": "recorded",
"entries": 3
}401Missing or invalid test key.404The record or schema doesn’t exist.422A field failed validation — the message names it.Select a concept to see how it fits into the flow.
Accounts
Where balances and records are associated — a buyer’s funds, platform fees or a seller’s payable.
- Accounts
Where balances and records are associated — a buyer’s funds, platform fees or a seller’s payable.
Accounts guide - Transactions
A related set of actions or entries that belong together, such as one marketplace sale.
Transactions guide - Entries
The individual financial records that make up a transaction; together they must balance.
Entries guide - Reconciliation
The comparison of internal records with external data, with mismatches queued for review.
Reconciliation guide - Schemas & rules
The structure and constraints a workflow uses, where supported — required fields, limits, mappings.
Schema guide
Each guide covers the use case, prerequisites, code, expected output, and common errors.
- Node.js
Handle a payment status change
View full guidewebhooks.on("payment.updated", (e) => sync(e.data)) - Node.js
Match internal and external records
View full guideorbbitly.reconciliations.create({ source: "bank" }) - Node.js
Handle an error or retry safely
View full guideretry(request, { idempotencyKey: "order_8841" })
Snippets are conceptual examples — confirm method names in the API reference.
- Supported AI tool and MCP patterns, documented only where verified
- Required setup and permissions for each tool
- Read-only actions kept separate from actions that change financial state
- Approval, validation, and audit records built into the flow
- A safe sandbox workflow to test with
- Error code and plain-language explanation
- Request or transaction reference
- Suggested diagnostic steps
- Retry guidance when safe and supported
- Link to the relevant guide or support channel
- Check the fee_rate value sent by your app.
- Compare it with schema marketplace.sale v3.
- Resend with the same idempotency key.
Example output · secrets and sensitive values are redacted
- Create a development environment; it issues sandbox keys that never touch real money.
Open quickstart
# Conceptual example — not a production endpoint POST /v1/transactions { "type": "marketplace.sale", "amount": 1000, "currency": "BDT", "reference": "order_8841" }
201 Created { "id": "txn_orb_29f", "entries": 3, "status": "recorded" }