Skip to content

Docs

API reference

The Monerails REST API: base URL, authentication and every endpoint.

The Monerails API is a REST API. It accepts and returns JSON, uses standard HTTP status codes and authenticates with a secret key.

Base URL

text

https://api.monerails.com/v1

Every request goes over HTTPS. The mode (test or live) comes from the key, not the URL.

Authentication

bash

curl https://api.monerails.com/v1/balance \
  -H "Authorization: Bearer mr_test_..."

See Authentication for keys and roles.

Conventions

Topic	Rule
Bodies	JSON, with `Content-Type: application/json`. Unknown parameters are rejected.
IDs	UUIDs, for example `3b8f6c1e-2a47-4d1b-9e35-7c0a9d2f4e61`.
Amounts	Integers in minor units (details).
Dates	ISO 8601, UTC.
Lists	Cursor pagination (details).
POST requests	Accept an `Idempotency-Key` (details).
Errors	An `error` object with `type`, `code`, `message` (details).

The OpenAPI 3.1 file of the API is available here: openapi.json. To try the API without writing code, import the Postman collection; to generate a typed client, see Client libraries.

Endpoints

Balance

GET/v1/balanceRetrieve the balance

Collections

POST/v1/collectionsCreate a collection GET/v1/collections/{id}Retrieve a collection GET/v1/collectionsList collections POST/v1/collections/{id}/authorizeAuthorize with a code POST/v1/collections/{id}/resend_otpResend the code

Payouts

POST/v1/payoutsCreate a payout GET/v1/payouts/{id}Retrieve a payout GET/v1/payoutsList payouts

Beneficiaries

POST/v1/beneficiariesCreate a beneficiary GET/v1/beneficiaries/{id}Retrieve a beneficiary POST/v1/beneficiaries/{id}Update a beneficiary GET/v1/beneficiariesList beneficiaries DELETE/v1/beneficiaries/{id}Delete a beneficiary

Settlements

POST/v1/settlementsCreate a settlement GET/v1/settlements/{id}Retrieve a settlement GET/v1/settlementsList settlements

Transactions

GET/v1/transactionsList transactions GET/v1/transactions/{id}Retrieve a transaction

Cardholders

POST/v1/cardholdersCreate a cardholder POST/v1/cardholders/{id}/verificationSubmit identity verification GET/v1/cardholders/{id}Retrieve a cardholder GET/v1/cardholdersList cardholders

Cards

POST/v1/cardsCreate a card GET/v1/cards/{id}Retrieve a card GET/v1/cardsList cards POST/v1/cards/{id}/fundFund a card POST/v1/cards/{id}/withdrawWithdraw from a card POST/v1/cards/{id}/freezeFreeze a card POST/v1/cards/{id}/unfreezeUnfreeze a card POST/v1/cards/{id}/terminateTerminate a card

Webhook endpoints

POST/v1/webhook_endpointsCreate a webhook endpoint GET/v1/webhook_endpoints/{id}Retrieve a webhook endpoint GET/v1/webhook_endpointsList webhook endpoints DELETE/v1/webhook_endpoints/{id}Delete a webhook endpoint POST/v1/webhook_endpoints/{id}/rotate_secretRotate the secret

Events

GET/v1/eventsList events GET/v1/events/{id}Retrieve an event POST/v1/events/{id}/retryRedeliver an event

Reference data

GET/v1/operatorsList operators GET/v1/banksList banks

Test helpers

POST/v1/test/cardholders/{id}/verificationSimulate a verification decision POST/v1/test/cards/{id}/authorizationsSimulate a card payment