# Orenda Management API

> The administrative API for management systems and operator tools.

## Get started

- [Management API](https://api-management-docs.orenda-apps.com/overview/): The administrative API for management systems and operator tools.
- [Authentication](https://api-management-docs.orenda-apps.com/authentication/): How service users (machine-to-machine) and management operators get a token.
- [Versioning](https://api-management-docs.orenda-apps.com/versioning/): How the Management API changes over time: what we add without notice, what gets a new version, and how long a retired route keeps working.
- [Issuing cards for your users](https://api-management-docs.orenda-apps.com/issue-cards/): End-to-end: invite a user, onboard them, then issue and fund a card.

## Oversight

- [Search](https://api-management-docs.orenda-apps.com/search/): Find applications, accounts, transactions, and payment requests.
- [Reports](https://api-management-docs.orenda-apps.com/reports/): Generate CSV/MT940 reports asynchronously and download them.

## Webhooks

- [Webhooks](https://api-management-docs.orenda-apps.com/webhooks/): Get notified in real time when customers, accounts, cards, or payments change.
- [Authorisation decisions](https://api-management-docs.orenda-apps.com/webhooks/card-authorization-request/): Approve or decline card authorisations in real time, while the network waits.
- [CUSTOMER_STATUS_UPDATE](https://api-management-docs.orenda-apps.com/webhooks/customer-status-update/): Fires when a customer's onboarding/KYC status changes.
- [ACCOUNT_STATUS_UPDATE](https://api-management-docs.orenda-apps.com/webhooks/account-status-update/): Fires when an account's status changes.
- [ACCOUNT_BALANCE_UPDATE](https://api-management-docs.orenda-apps.com/webhooks/account-balance-update/): Fires when an account's settled balance changes.
- [NEW_CARD_ADDED](https://api-management-docs.orenda-apps.com/webhooks/new-card-added/): Fires when a new card is provisioned.
- [CARD_STATUS_UPDATE](https://api-management-docs.orenda-apps.com/webhooks/card-status-update/): Fires when a card's lifecycle status changes.
- [CARD_AUTH_STATUS_UPDATE](https://api-management-docs.orenda-apps.com/webhooks/card-auth-status-update/): Fires when a card authorisation / 3DS challenge is raised or resolved.
- [TRANSACTION_INITIATED](https://api-management-docs.orenda-apps.com/webhooks/transaction-initiated/): Fires when a payment request is created.
- [TRANSACTION_CREATED](https://api-management-docs.orenda-apps.com/webhooks/transaction-created/): Fires when a ledger transaction is created.
- [TRANSACTION_STATUS_CHANGED](https://api-management-docs.orenda-apps.com/webhooks/transaction-status-changed/): Fires when a ledger transaction's status changes.

## Customer operations

- [Acting on a customer](https://api-management-docs.orenda-apps.com/customer-operations/): Accounts, payments, beneficiaries, and batches on a customer's behalf.
- [Card operations](https://api-management-docs.orenda-apps.com/cards-operations/): Manage a customer's cards: issue, activate, control status, limits, and balance.

## Batch payments

- [Batch payments](https://api-management-docs.orenda-apps.com/batch-payments/overview/): Pay many customers in one batch, from the accounts you are responsible for.

## Configuration

- [Fees](https://api-management-docs.orenda-apps.com/fees/): Read the program's fee catalog and generate fee documents.
- [Invite a customer](https://api-management-docs.orenda-apps.com/invite-customer/): How your integration or an operator brings a user into the program: a customer, a company, a sub-user, or a cardholder on a corporate's accounts.

## API reference

- `POST /v1/access-management/customer-invites`: Invite a customer
- `GET /v1/applications`: Search applications and customers
- `GET /v1/accounts`: Search accounts
- `GET /v1/transactions`: Search transactions
- `GET /v1/payments/requests`: Search payments
- `GET /v1/customers/{customerId}/application-meta`: Get customer onboarding metadata
- `POST /v1/customers/{customerId}/accounts/{accountId}/block`: Block an account
- `POST /v1/customers/{customerId}/accounts/{accountId}/unblock`: Unblock an account
- `POST /v1/customers/{customerId}/accounts/{accountId}/close`: Close an account
- `POST /v1/customers/{customerId}/accounts/{accountId}/confirmation/send`: Send account confirmation letter
- `POST /v1/customers/{customerId}/accounts/{accountId}/balance`: Load or unload card balance
- `POST /v1/beneficiaries/verify`: Verify a payee name (CoP / VoP)
- `POST /v1/customers/{customerId}/batch-payments`: Batch action (verify / initiate / submit)
- `GET /v1/batch-payments/verify/{requestId}`: Get verify status
- `GET /v1/batch-payments`: List batches
- `POST /v1/batch-payments`: Multi-customer batch payments
- `POST /v1/customers/{customerId}/batch-payments/verify`: Verify a batch (single customer)
- `POST /v1/batch-payments/verify`: Verify a batch (multi-customer)
- `POST /v1/customers/{customerId}/batch-payments/submit`: Pay a batch (single customer)
- `POST /v1/batch-payments/submit`: Pay a batch (multi-customer)
- `GET /v1/batch-payments/{batchId}`: Get a batch
- `DELETE /v1/batch-payments/{batchId}`: Delete a draft
- `GET /v1/reports/mt940`: MT940 report (synchronous)
- `POST /v1/reports/mt940`: MT940 report (asynchronous email)
- `GET /v1/applications/{applicationId}/documents/legal/acceptance`: Get legal document acceptance

## Full text

- [Complete documentation](https://api-management-docs.orenda-apps.com/llms-full.txt): every page as plain text