MoneroPay

https://moneropay.eu/
Admin
MoneroPay is a backend service and standalone daemon that provides a simple HTTP API for receiving,...
Tokens:9,659
Snippets:47
Trust Score:5.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Docker Compose Setup for MoneroPay

Source: https://moneropay.eu/print

This snippet shows the commands to set up MoneroPay using Docker Compose. It involves copying example configuration files and then starting the services in detached mode.

```bash
cp .env.example .env
cp docker-compose.override.yaml.example docker-compose.override.yaml
vim .env
vim docker-compose.override.yaml

docker compose up -d
```

--------------------------------

### MoneroPay Docker Setup: Copy Example Files and Configure

Source: https://moneropay.eu/guide/install

This snippet shows the initial steps to set up MoneroPay using Docker. It involves copying example configuration files and then editing them to suit specific needs.

```shell
cp .env.example .env
cp docker-compose.override.yaml.example docker-compose.override.yaml
vim .env
vim docker-compose.override.yaml
```

--------------------------------

### MoneroPay Docker Setup: Start Services

Source: https://moneropay.eu/guide/install

This command starts the MoneroPay application and its dependencies (PostgreSQL, monero-wallet-rpc) in detached mode using Docker Compose. If no wallet file exists, a new one will be created.

```shell
docker compose up -d
```

--------------------------------

### MoneroPay Balance Response

Source: https://moneropay.eu/print

Example JSON response from the MoneroPay /balance endpoint, showing the total and unlocked amounts in atomic units (piconero).

```json
{
  "total": 2513444800,
  "unlocked": 800000000
}
```

--------------------------------

### Caddy2 Reverse Proxy Configuration with Basic Auth

Source: https://moneropay.eu/guide/secscale

Example Caddy2 configuration file to reverse proxy MoneroPay and enable basic authentication. It directs traffic to the local MoneroPay instance and secures it with a password hash.

```caddyfile
moneropay.example.net {
    basicauth {
        admin your_password_hash
    }
    reverse_proxy localhost:5000
}
```

--------------------------------

### MoneroPay Health Response (Healthy)

Source: https://moneropay.eu/print

Example JSON response indicating a healthy status for MoneroPay, where both walletrpc and postgresql services are reported as true.

```json
{
  "status": 200,
  "services": {
    "walletrpc": true,
    "postgresql": true
  }
}
```

--------------------------------

### Get Wallet Balance

Source: https://moneropay.eu/print

Retrieves the entire wallet balance, including total and unlocked amounts.

```APIDOC
## GET /balance

### Description
Get the entire wallet balance.

### Method
GET

### Endpoint
/balance

### Response
#### Success Response (200)
- **total** (integer) - The total balance in atomic units (piconero).
- **unlocked** (integer) - The unlocked balance in atomic units (piconero).

#### Response Example
```json
{
  "total": 2513444800,
  "unlocked": 800000000
}
```
```

--------------------------------

### GET /transfer/{tx_hash}

Source: https://moneropay.eu/print

Retrieves information about a specific transaction using its transaction hash.

```APIDOC
## GET /transfer/{tx_hash}

### Description
Retrieves information about a transaction via its hash.

### Method
GET

### Endpoint
`/transfer/{tx_hash}`

#### Path Parameters
- **tx_hash** (string) - Required - The hash of the transaction to retrieve.

### Response
#### Success Response (200)
- **amount** (integer) - The amount of the transaction.
- **fee** (integer) - The transaction fee.
- **state** (string) - The state of the transfer (e.g., "completed").
- **transfer** (array) - Details of the transfer.
  - **amount** (integer) - The amount transferred.
  - **address** (string) - The recipient's address.
- **confirmations** (integer) - The number of confirmations.
- **double_spend_seen** (boolean) - Indicates if double spending was detected.
- **height** (integer) - The block height of the transaction.
- **timestamp** (string) - The timestamp of the transaction.
- **unlock_time** (integer) - The unlock time of the transaction.
- **tx_hash** (string) - The transaction hash.

### Request Example
```bash
curl -s -X GET "${endpoint}/transfer/${tx_hash}"
```

### Response Example
```json
{
  "amount": 79990000,
  "fee": 9110000,
  "state": "completed",
  "transfer": [
    {
      "amount": 79990000,
      "address": "453biCQpM6oSSr7jgTwmtC9YfiXUWZY1wEfSZJD4r6rf7mPqPj8NZpp7WYpAHVq7p69SYa1B1zMN6SeRc8exYi1WEenqu2c"
    }
  ],
  "confirmations": 15,
  "double_spend_seen": false,
  "height": 2407445,
  "timestamp": "2022-07-18T11:37:50Z",
  "unlock_time": 10,
  "tx_hash": "cf448effb86f24f81476c0012a6636700488e13accd91f8f43302ae90fed25ce"
}
```
```

--------------------------------

### Monero Subaddress Creation Response

Source: https://moneropay.eu/api/receive

This is an example of the JSON response received after successfully creating a Monero subaddress using the MoneroPay API. It includes the generated subaddress, the requested amount, the description, and the creation timestamp.

```json
{
  "address": "84WsptnLmjTYQjm52SMkhQWsepprkcchNguxdyLkURTSW1WLo3tShTnCRvepijbc2X8GAKPGxJK9hfQhLHzoKSxh7y8Yqrg",
  "amount": 123000000,
  "description": "Server expenses",
  "created_at": "2022-07-18T11:54:49.780542861Z"
}
```

--------------------------------

### GET /receive/{address}

Source: https://moneropay.eu/print

Retrieves information about incoming transactions for a given Monero address. It can optionally filter transactions by minimum and maximum block height.

```APIDOC
## GET /receive/{address}

### Description
Retrieves information about incoming transactions for a given Monero address. Optionally filter transactions by minimum and maximum block height.

### Method
GET

### Endpoint
`/receive/{address}`

#### Query Parameters
- **min** (integer) - Optional - The minimum block height to filter transactions.
- **max** (integer) - Optional - The maximum block height to filter transactions.

### Response
#### Success Response (200)
- **amount** (object) - Details about the expected and covered amount.
- **complete** (boolean) - Indicates if the payment is complete.
- **description** (string) - A description of the payment.
- **created_at** (string) - The timestamp when the payment was created.
- **transactions** (array) - A list of transactions associated with the payment.
  - **amount** (integer) - The amount of the transaction.
  - **confirmations** (integer) - The number of confirmations for the transaction.
  - **double_spend_seen** (boolean) - Indicates if double spending was detected.
  - **fee** (integer) - The transaction fee.
  - **height** (integer) - The block height of the transaction.
  - **timestamp** (string) - The timestamp of the transaction.
  - **tx_hash** (string) - The transaction hash.
  - **unlock_time** (integer) - The unlock time of the transaction.
  - **locked** (boolean) - Indicates if the transaction is locked.

### Request Example
```bash
curl -s -X GET "${endpoint}/receive/${address}?min=${min_height}&max=${max_height}"
```

### Response Example
```json
{
  "amount": {
    "expected": 200000000,
    "covered": {
      "total": 200000000,
      "unlocked": 200000000
    }
  },
  "complete": true,
  "description": "Donation to Kernal",
  "created_at": "2022-07-11T19:04:24.574583Z",
  "transactions": [
    {
      "amount": 200000000,
      "confirmations": 10,
      "double_spend_seen": false,
      "fee": 9200000,
      "height": 2402648,
      "timestamp": "2022-07-11T19:19:05Z",
      "tx_hash": "0c9a7b40b15596fa9a06ba32463a19d781c075120bb59ab5e4ed2a97ab3b7f33",
      "unlock_time": 0,
      "locked": false
    }
  ]
}
```
```

--------------------------------

### Get MoneroPay Wallet Balance (curl)

Source: https://moneropay.eu/print

This snippet shows how to retrieve the total and unlocked balance of the MoneroPay wallet using a cURL command against the /balance endpoint.

```bash
curl -s -X GET "${endpoint}/balance"
```

--------------------------------

### MoneroPay Health Response (Unhealthy)

Source: https://moneropay.eu/print

Example JSON response indicating an unhealthy status for MoneroPay, where the walletrpc service is reported as false.

```json
{
  "status": 503,
  "services": {
    "walletrpc": false,
    "postgresql": true
  }
}
```

--------------------------------

### GET /transfer/{tx_hash}

Source: https://moneropay.eu/api/transfer

Retrieves detailed information about a specific transaction using its hash.

```APIDOC
## GET /transfer/{tx_hash}

### Description
Get information about a transaction via its hash.

### Method
GET

### Endpoint
/transfer/${tx_hash}

### Parameters
#### Path Parameters
- **tx_hash** (string) - Required - The hash of the transaction to retrieve.

### Request Example
```bash
curl -s -X GET "${endpoint}/transfer/${tx_hash}"
```

### Response
#### Success Response (200)
- **amount** (integer) - The amount of the transaction.
- **fee** (integer) - The transaction fee.
- **state** (string) - The current state of the transaction (e.g., "completed").
- **transfer** (array) - Details of the transfer, including amount and address.
- **confirmations** (integer) - The number of confirmations for the transaction.
- **double_spend_seen** (boolean) - Indicates if double spending has been detected.
- **height** (integer) - The block height at which the transaction was included.
- **timestamp** (string) - The timestamp of the transaction.
- **unlock_time** (integer) - The unlock time for the transaction.
- **tx_hash** (string) - The hash of the transaction.

#### Response Example
```json
{
  "amount": 79990000,
  "fee": 9110000,
  "state": "completed",
  "transfer": [
    {
      "amount": 79990000,
      "address": "453biCQpM6oSSr7jgTwmtC9YfiXUWZY1wEfSZJD4r6rf7mPqPj8NZpp7WYpAHVq7p69SYa1B1zMN6SeRc8exYi1WEenqu2c"
    }
  ],
  "confirmations": 15,
  "double_spend_seen": false,
  "height": 2407445,
  "timestamp": "2022-07-18T11:37:50Z",
  "unlock_time": 10,
  "tx_hash": "cf448effb86f24f81476c0012a6636700488e13accd91f8f43302ae90fed25ce"
}
```
```

--------------------------------

### Get Transfer Status

Source: https://moneropay.eu/print

Retrieves the status of a previously initiated Monero transfer using its transaction ID.

```APIDOC
## GET /transfer/:tx_hash

### Description
Check the status of a Monero transfer by its transaction hash.

### Method
GET

### Endpoint
/transfer/:tx_hash

### Parameters
#### Path Parameters
- **tx_hash** (string) - The transaction hash (txid) of the Monero transfer.

### Response
#### Success Response (200)
- **status** (string) - The status of the transfer (e.g., "pending", "confirmed").
- **confirmations** (integer) - The number of confirmations for the transfer.

#### Response Example
```json
{
  "status": "confirmed",
  "confirmations": 5
}
```
```

--------------------------------

### GET /receive/:subaddress

Source: https://moneropay.eu/api/receive

Retrieves details of incoming transfers for a given subaddress. You can optionally filter the results by minimum and maximum block height.

```APIDOC
## GET /receive/:subaddress

### Description
Views incoming transfers for a specific subaddress. Transactions can be filtered by `min` and `max` block height.

### Method
GET

### Endpoint
/receive/:subaddress

### Parameters
#### Path Parameters
- **subaddress** (string) - Required - The Monero subaddress to query.

#### Query Parameters
- **min** (integer) - Optional - The minimum block height to filter transactions.
- **max** (integer) - Optional - The maximum block height to filter transactions.

### Request Example
```bash
curl -s -X GET "${endpoint}/receive/${address}?min=${min_height}&max=${max_height}"
```

### Response
#### Success Response (200)
- **amount.expected** (integer) - The total expected amount in atomic units.
- **amount.covered.total** (integer) - The total amount received in atomic units.
- **amount.covered.unlocked** (integer) - The unlocked amount in atomic units.
- **complete** (boolean) - Indicates if the expected amount has been fully covered.
- **description** (string) - The description associated with the transfer.
- **created_at** (string) - The timestamp when the transfer was initiated.
- **transactions** (array) - A list of individual transactions contributing to the transfer.
  - **amount** (integer) - The amount of the individual transaction.
  - **confirmations** (integer) - The number of confirmations for the transaction.
  - **double_spend_seen** (boolean) - Whether double spending was detected.
  - **fee** (integer) - The transaction fee.
  - **height** (integer) - The block height of the transaction.
  - **timestamp** (string) - The timestamp of the transaction.
  - **tx_hash** (string) - The transaction hash.
  - **unlock_time** (integer) - The unlock time of the transaction.
  - **locked** (boolean) - Indicates if the transaction is locked.

#### Response Example
```json
{
  "amount": {
    "expected": 200000000,
    "covered": {
      "total": 200000000,
      "unlocked": 200000000
    }
  },
  "complete": true,
  "description": "Donation to Kernal",
  "created_at": "2022-07-11T19:04:24.574583Z",
  "transactions": [
    {
      "amount": 200000000,
      "confirmations": 10,
      "double_spend_seen": false,
      "fee": 9200000,
      "height": 2402648,
      "timestamp": "2022-07-11T19:19:05Z",
      "tx_hash": "0c9a7b40b15596fa9a06ba32463a19d781c075120bb59ab5e4ed2a97ab3b7f33",
      "unlock_time": 0,
      "locked": false
    }
  ]
}
```
```

--------------------------------

### GET /receive/:address

Source: https://moneropay.eu/api/callback

Retrieve details of incoming transactions associated with a specific Monero address. This endpoint is useful for polling or verifying transaction status, especially if callback delivery might have failed.

```APIDOC
## GET /receive/:address

### Description
Retrieves information about incoming transactions for a given Monero payment address. This endpoint allows users to query transaction status directly and is recommended for applications that need to ensure they have received payment notifications, especially in case of callback delivery issues.

### Method
GET

### Endpoint
/receive/:address

### Parameters
#### Path Parameters
- **address** (string) - Required - The Monero payment address for which to retrieve transaction details.

### Response
#### Success Response (200)
- **amount** (object) - Details about the transaction amount, including expected and covered amounts.
  - **expected** (integer) - The expected amount for the payment.
  - **covered** (object) - Information about the covered amount.
    - **total** (integer) - The total amount covered by the transaction.
    - **unlocked** (integer) - The amount that is currently unlocked.
- **complete** (boolean) - Indicates if the payment is considered complete.
- **description** (string) - A description associated with the payment.
- **created_at** (string) - The timestamp when the payment was created.
- **transaction** (object) - Detailed information about the Monero transaction.
  - **amount** (integer) - The amount of the transaction.
  - **confirmations** (integer) - The number of confirmations for the transaction.
  - **double_spend_seen** (boolean) - Indicates if a double spend attempt was detected.
  - **fee** (integer) - The transaction fee.
  - **height** (integer) - The block height at which the transaction was included.
  - **timestamp** (string) - The timestamp of the transaction.
  - **tx_hash** (string) - The unique hash of the transaction.
  - **unlock_time** (integer) - The unlock time for the transaction.
  - **locked** (boolean) - Indicates if the transaction is locked.

#### Response Example
```json
{
  "amount": {
    "expected": 0,
    "covered": {
      "total": 200000000,
      "unlocked": 200000000
    }
  },
  "complete": true,
  "description": "Donation to Kernal",
  "created_at": "2022-07-11T19:04:24.574583Z",
  "transaction": {
    "amount": 200000000,
    "confirmations": 10,
    "double_spend_seen": false,
    "fee": 9200000,
    "height": 2402648,
    "timestamp": "2022-07-11T19:19:05Z",
    "tx_hash": "0c9a7b40b15596fa9a06ba32463a19d781c075120bb59ab5e4ed2a97ab3b7f33",
    "unlock_time": 0,
    "locked": false
  }
}
```
```

--------------------------------

### MoneroPay CLI Configuration Options

Source: https://moneropay.eu/print

Displays the command-line interface usage and configuration options for the MoneroPay executable. Includes settings for binding address, logging, database connections, and Monero RPC details.

```bash
$ ./moneropay -h
Usage of ./moneropay:
  -bind="localhost:5000": Bind address:port for moneropayd
  -config="": Path to configuration file
  -log-format="pretty": Log format (pretty or json)
  -poll-frequency=5s: Interval for checking new incoming and pool payments.
  -postgresql="postgresql://moneropay:s3cret@localhost:5432/moneropay": PostgreSQL connection string
  -rpc-address="http://localhost:18082/json_rpc": Wallet RPC server address
  -rpc-password="": Password for monero-wallet-rpc
  -rpc-username="": Username for monero-wallet-rpc
  -sqlite="": SQLite3 connection string
  -transfer-mixin=8: Number of outputs from the blockchain to mix with (0 means no mixing)
  -transfer-priority=0: Set a priority for transactions
  -transfer-unlock-time=10: Number of blocks before the monero can be spent (0 to not add a lock)
  -zero-conf=false: Enable 0-conf mode. Sends 3 callbacks (0-conf, 1-conf, 10-conf).
```

--------------------------------

### MoneroPay Standalone Build: Clone and Compile

Source: https://moneropay.eu/guide/install

This snippet demonstrates how to build MoneroPay directly from its Go source code. It requires the Go compiler, a PostgreSQL server, monero-wallet-rpc, and a Monero wallet.

```shell
git clone https://gitlab.com/moneropay/moneropay.git
cd moneropay
go build ./cmd/moneropay
```

--------------------------------

### MoneroPay Command-Line Usage

Source: https://moneropay.eu/options/options

Displays the help message for the MoneroPay executable, outlining all available command-line flags and their default values. These flags control various aspects of the MoneroPay daemon's operation, including network binding, logging, database connections, and Monero RPC configuration.

```bash
$ ./moneropay -h
Usage of ./moneropay:
  -bind="localhost:5000": Bind address:port for moneropayd
  -config="": Path to configuration file
  -log-format="pretty": Log format (pretty or json)
  -poll-frequency=5s: Interval for checking new incoming and pool payments.
  -postgresql="postgresql://moneropay:s3cret@localhost:5432/moneropay": PostgreSQL connection string
  -rpc-address="http://localhost:18082/json_rpc": Wallet RPC server address
  -rpc-password="": Password for monero-wallet-rpc
  -rpc-username="": Username for monero-wallet-rpc
  -sqlite="": SQLite3 connection string
  -transfer-mixin=8: Number of outputs from the blockchain to mix with (0 means no mixing)
  -transfer-priority=0: Set a priority for transactions
  -transfer-unlock-time=10: Number of blocks before the monero can be spent (0 to not add a lock)
  -zero-conf=false: Enable 0-conf mode. Sends 3 callbacks (0-conf, 1-conf, 10-conf).

```

--------------------------------

### Create Monero Transfer

Source: https://moneropay.eu/print

Initiates a Monero transfer to specified destinations. Requires a list of destinations, each with an amount and address.

```APIDOC
## POST /transfer

### Description
Send Monero to specified destinations.

### Method
POST

### Endpoint
/transfer

### Parameters
#### Request Body
- **destinations** (array) - An array of destination objects.
  - **amount** (integer) - The amount to send in atomic units (piconero).
  - **address** (string) - The recipient's Monero address.

### Request Example
```json
{
  "destinations": [
    {
      "amount": 1337000000,
      "address": "47stn..."
    }
  ]
}
```

### Response
#### Success Response (200)
- **txid** (string) - The transaction ID of the initiated transfer.

#### Response Example
```json
{
  "txid": "abcdef1234567890..."
}
```
```

--------------------------------

### Create Receive Address

Source: https://moneropay.eu/print

Creates a new subaddress for incoming Monero transfers. Optionally accepts an amount, description, and a callback URL for status updates.

```APIDOC
## POST /receive

### Description
Create a subaddress for incoming transfers.

### Method
POST

### Endpoint
/receive

### Parameters
#### Request Body
- **amount** (integer) - The target amount in atomic units (piconero) for the transfer. Optional.
- **description** (string) - A description for the payment. Optional.
- **callback_url** (string) - A URL to receive payment status updates via HTTP POST. Optional.

### Request Example
```json
{
  "amount": 123000000,
  "description": "Server expenses",
  "callback_url": "http://merchant/callback/moneropay_tio2foogaaLo9olaew4o"
}
```

### Response
#### Success Response (200)
- **address** (string) - The newly created Monero subaddress.
- **amount** (integer) - The specified target amount in atomic units (piconero).
- **description** (string) - The provided description for the payment.
- **created_at** (string) - The timestamp when the subaddress was created.

#### Response Example
```json
{
  "address": "84WsptnLmjTYQjm52SMkhQWsepprkcchNguxdyLkURTSW1WLo3tShTnCRvepijbc2X8GAKPGxJK9hfQhLHzoKSxh7y8Yqrg",
  "amount": 123000000,
  "description": "Server expenses",
  "created_at": "2022-07-18T11:54:49.780542861Z"
}
```

> Note: If `callback_url` is provided, MoneroPay will send a POST request to the specified URL with payment status details when the transaction is confirmed and the amount matches or exceeds the specified amount.
```

--------------------------------

### POST /transfer

Source: https://moneropay.eu/print

Initiates a transfer of Monero to one or more recipients. The transfer can be split into multiple transactions if necessary.

```APIDOC
## POST /transfer

### Description
Initiates a transfer of Monero to one or more recipients. If necessary, split the transfer into multiple transactions.

### Method
POST

### Endpoint
`/transfer`

#### Request Body
- **destinations** (array) - Required - A list of destinations for the transfer.
  - **amount** (integer) - Required - The amount to send to the recipient.
  - **address** (string) - Required - The Monero address of the recipient.

### Request Example
```bash
curl -s -X POST "${endpoint}/transfer" \
    -H 'Content-Type: application/json' \
    -d '{"destinations": [{"amount": 1337000000, "address": "47stn..."}]}'
```

### Response
#### Success Response (200)
- **amount** (integer) - The total amount transferred.
- **fee** (integer) - The transaction fee.
- **tx_hash** (string) - The transaction hash. Deprecated, use `tx_hash_list` instead.
- **tx_hash_list** (array) - A list of transaction hashes.
- **destinations** (array) - A list of destinations for the transfer.
  - **amount** (integer) - The amount sent to the recipient.
  - **address** (string) - The Monero address of the recipient.

### Response Example
```json
{
  "amount": 1337000000,
  "fee": 87438594,
  "tx_hash": "5ca34...",
  "tx_hash_list": ["5ca34...", "cf448..."],
  "destinations": [
    {
      "amount": 1337000000,
      "address": "47stn..."
    }
  ]
}
```
```

--------------------------------

### View Incoming Transfers by Address

Source: https://moneropay.eu/print

Retrieves information about incoming Monero transfers associated with a specific subaddress.

```APIDOC
## GET /receive/:address

### Description
View incoming transfers for a subaddress.

### Method
GET

### Endpoint
/receive/:address

### Parameters
#### Path Parameters
- **address** (string) - The Monero subaddress to query.

#### Query Parameters
- **min** (integer) - Minimum amount in atomic units (piconero) to filter transfers. Optional.
- **max** (integer) - Maximum amount in atomic units (piconero) to filter transfers. Optional.

### Response
#### Success Response (200)
- **transfers** (array) - A list of incoming transfers.
  - **txid** (string) - The transaction ID.
  - **height** (integer) - The block height of the transaction.
  - **amount** (integer) - The amount received in atomic units (piconero).
  - **unlock_time** (integer) - The unlock time of the transaction.
  - **subaddr_account** (integer) - The subaddress account index.
  - **subaddr_index** (integer) - The subaddress index.
  - **confirmations** (integer) - The number of confirmations.
  - **locked** (boolean) - Indicates if the transfer is locked.
  - **subaddr_label** (string) - The label associated with the subaddress. (Optional)
  - **memo** (string) - The memo associated with the transfer. (Optional)
  - **full_amount** (integer) - The full amount of the transaction in atomic units (piconero), including amounts not allocated to this subaddress. (Optional)

#### Response Example
```json
{
  "transfers": [
    {
      "txid": "a1b2c3d4e5f67890...",
      "height": 1234567,
      "amount": 500000000,
      "unlock_time": 0,
      "subaddr_account": 0,
      "subaddr_index": 1,
      "confirmations": 10,
      "locked": false
    }
  ]
}
```
```

--------------------------------

### MoneroPay API Overview

Source: https://moneropay.eu/index

MoneroPay provides a simple HTTP API for merchants or individuals who want to accept XMR. It supports optional status updates via HTTP Callbacks. MoneroPay is a standalone backend daemon that can be used for various purposes, including online stores, donation websites, ATMs, and paid services.

```APIDOC
## MoneroPay API Overview

### Description
MoneroPay provides a simple HTTP API for merchants or individuals who want to accept XMR. It supports optional status updates via HTTP Callbacks. MoneroPay is a standalone backend daemon that can be used for various purposes, including online stores, donation websites, ATMs, and paid services.

### Technologies Used
* Monero Wallet RPC
* PostgreSQL (or SQLite)
```

--------------------------------

### POST /receive

Source: https://moneropay.eu/api/receive

Creates a new subaddress for receiving Monero transfers. Optionally, you can specify an amount, description, and a callback URL to be notified upon receiving funds.

```APIDOC
## POST /receive

### Description
Creates a subaddress for incoming transfers. Optionally, set `amount`, `description`, and `callback_url`.

### Method
POST

### Endpoint
/receive

### Parameters
#### Request Body
- **amount** (integer) - Optional - The expected amount in atomic units (piconero).
- **description** (string) - Optional - A description for the transfer.
- **callback_url** (string) - Optional - A URL to receive POST notifications when the amount is covered.

### Request Example
```json
{
  "amount": 123000000,
  "description": "Server expenses",
  "callback_url": "http://merchant/callback/moneropay_tio2foogaaLo9olaew4o"
}
```

### Response
#### Success Response (200)
- **address** (string) - The newly created Monero subaddress.
- **amount** (integer) - The expected amount specified in the request.
- **description** (string) - The description specified in the request.
- **created_at** (string) - The timestamp when the subaddress was created.

#### Response Example
```json
{
  "address": "84WsptnLmjTYQjm52SMkhQWsepprkcchNguxdyLkURTSW1WLo3tShTnCRvepijbc2X8GAKPGxJK9hfQhLHzoKSxh7y8Yqrg",
  "amount": 123000000,
  "description": "Server expenses",
  "created_at": "2022-07-18T11:54:49.780542861Z"
}
```
```

--------------------------------

### Check MoneroPay Health (curl)

Source: https://moneropay.eu/print

This snippet demonstrates how to check the health status of MoneroPay and its dependencies (walletrpc, postgresql) using a cURL command against the /health endpoint.

```bash
curl -s -X GET "${endpoint}/health"
```

--------------------------------

### Transfer funds to recipients using cURL

Source: https://moneropay.eu/api/transfer

Initiates a transfer of Monero to one or more specified destinations. This operation can be used for single or multiple recipients and supports splitting transfers if necessary. The request specifies the destination address and the amount in atomic units (piconero).

```shell
curl -s -X POST "${endpoint}/transfer" \
    -H 'Content-Type: application/json' \
    -d '{"destinations": [{"amount": 1337000000, "address": "47stn..."}]}'
```

--------------------------------

### POST /receive

Source: https://moneropay.eu/api/callback

MoneroPay monitors for new incoming transactions and sends a POST request to the specified 'callback_url' with transaction details. This is the primary method for receiving real-time payment notifications.

```APIDOC
## POST /receive

### Description
This endpoint is used by MoneroPay to notify external services about new incoming Monero transactions. A POST request is sent to a predefined 'callback_url' with a JSON payload containing transaction details when a new transaction is detected.

### Method
POST

### Endpoint
/receive

### Parameters
#### Request Body
- **callback_url** (string) - Required - The URL to which MoneroPay will send transaction notifications.

### Request Example
```json
{
  "callback_url": "https://example.com/monero-callback"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating that the callback URL has been registered.

#### Response Example
```json
{
  "message": "Callback URL registered successfully."
}
```

### Callback Payload Example
```json
{
  "amount": {
    "expected": 0,
    "covered": {
      "total": 200000000,
      "unlocked": 200000000
    }
  },
  "complete": true,
  "description": "Donation to Kernal",
  "created_at": "2022-07-11T19:04:24.574583Z",
  "transaction": {
    "amount": 200000000,
    "confirmations": 10,
    "double_spend_seen": false,
    "fee": 9200000,
    "height": 2402648,
    "timestamp": "2022-07-11T19:19:05Z",
    "tx_hash": "0c9a7b40b15596fa9a06ba32463a19d781c075120bb59ab5e4ed2a97ab3b7f33",
    "unlock_time": 0,
    "locked": false
  }
}
```
```

--------------------------------

### POST /transfer

Source: https://moneropay.eu/api/transfer

Transfers Monero to one or more recipients. The transfer can be split into multiple transactions if needed.

```APIDOC
## POST /transfer

### Description
Transfer Monero to a single or multiple recipients. If necessary, split the transfer into multiple transactions.

### Method
POST

### Endpoint
/transfer

### Parameters
#### Request Body
- **destinations** (array) - Required - A list of destination objects, each containing an amount and an address.
  - **amount** (integer) - Required - The amount to transfer in atomic units (e.g., 1000000000 for 1 XMR).
  - **address** (string) - Required - The recipient's Monero address.

### Request Example
```json
{
  "destinations": [
    {
      "amount": 1337000000,
      "address": "47stn..."
    }
  ]
}
```

### Response
#### Success Response (200)
- **amount** (integer) - The total amount transferred.
- **fee** (integer) - The transaction fee.
- **tx_hash_list** (array) - A list of transaction hashes.
- **destinations** (array) - The list of destinations for the transfer.

#### Response Example
```json
{
  "amount": 1337000000,
  "fee": 87438594,
  "tx_hash": "5ca34...",
  "tx_hash_list": [
    "5ca34...",
    "cf448..."
  ],
  "destinations": [
    {
      "amount": 1337000000,
      "address": "47stn..."
    }
  ]
}
```

**Note:** The `tx_hash` field is deprecated and will be removed in version 3.0.0. Use `tx_hash_list` instead.
```

--------------------------------

### Create Monero Subaddress with cURL

Source: https://moneropay.eu/api/receive

This snippet shows how to create a new Monero subaddress using the MoneroPay API via a cURL request. It allows specifying an amount, an optional description, and a callback URL for notifications. The callback URL will receive a POST request when the unlocked amount meets or exceeds the specified amount.

```shell
curl -s -X POST "${endpoint}/receive" \
  -H 'Content-Type: application/json' \
  -d '{"amount": 123000000, "description": "Server expenses", "callback_url": "http://merchant/callback/moneropay_tio2foogaaLo9olaew4o"}'
```

--------------------------------

### Monero Transfer Details Response

Source: https://moneropay.eu/api/receive

This JSON object represents the response from the MoneroPay API when viewing incoming transfers for a subaddress. It details the expected amount, the covered amount (total and unlocked), transaction history, completion status, and associated descriptions.

```json
{
  "amount": {
    "expected": 200000000,
    "covered": {
      "total": 200000000,
      "unlocked": 200000000
    }
  },
  "complete": true,
  "description": "Donation to Kernal",
  "created_at": "2022-07-11T19:04:24.574583Z",
  "transactions": [
    {
      "amount": 200000000,
      "confirmations": 10,
      "double_spend_seen": false,
      "fee": 9200000,
      "height": 2402648,
      "timestamp": "2022-07-11T19:19:05Z",
      "tx_hash": "0c9a7b40b15596fa9a06ba32463a19d781c075120bb59ab5e4ed2a97ab3b7f33",
      "unlock_time": 0,
      "locked": false
    }
  ]
}
```

--------------------------------

### Health Check

Source: https://moneropay.eu/print

Checks if the required MoneroPay services (monero-wallet-rpc and PostgreSQL) are operational.

```APIDOC
## GET /health

### Description
Check if required services are up.

### Method
GET

### Endpoint
/health

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code indicating success.
- **services** (object) - An object detailing the status of each service.
  - **walletrpc** (boolean) - Status of the monero-wallet-rpc service.
  - **postgresql** (boolean) - Status of the PostgreSQL service.

#### Response Example
```json
{
  "status": 200,
  "services": {
    "walletrpc": true,
    "postgresql": true
  }
}
```

#### Error Response (503)
- **status** (integer) - HTTP status code indicating a service is down.
- **services** (object) - An object detailing the status of each service.
  - **walletrpc** (boolean) - Status of the monero-wallet-rpc service.
  - **postgresql** (boolean) - Status of the PostgreSQL service.

#### Response Example
```json
{
  "status": 503,
  "services": {
    "walletrpc": false,
    "postgresql": true
  }
}
```
```

--------------------------------

### MoneroPay Transfer Response Structure

Source: https://moneropay.eu/api/transfer

Illustrates the JSON response received after initiating a Monero transfer. It includes details such as the total amount transferred, transaction fee, transaction hash, and a list of destinations with their respective amounts and addresses. Note: The `tx_hash` field is deprecated and `tx_hash_list` should be used instead.

```json
{
  "amount": 1337000000,
  "fee": 87438594,
  "tx_hash": "5ca34...",
  "tx_hash_list": ["5ca34...", "cf448..."],
  "destinations": [
    {
      "amount": 1337000000,
      "address": "47stn..."
    }
  ]
}
```

--------------------------------

### View Monero Transfers with cURL

Source: https://moneropay.eu/api/receive

This snippet demonstrates how to retrieve incoming Monero transfer details for a specific subaddress using the MoneroPay API via cURL. It supports optional filtering by minimum and maximum block height to narrow down the transaction results.

```shell
curl -s -X GET "${endpoint}/receive/${address}?min=${min_height}&max=${max_height}"
```

--------------------------------

### Retrieve transaction details by hash using cURL

Source: https://moneropay.eu/api/transfer

Fetches detailed information about a specific Monero transaction using its unique transaction hash. This is useful for verifying transaction status, amounts, and other relevant metadata.

```shell
curl -s -X GET "${endpoint}/transfer/${tx_hash}"
```

--------------------------------

### MoneroPay Transaction Information Response

Source: https://moneropay.eu/api/transfer

Provides a comprehensive JSON structure containing details of a Monero transaction, retrieved via its hash. This includes the transaction amount, fee, state (e.g., 'completed'), confirmation count, height, timestamp, and a list of transfers made.

```json
{
  "amount": 79990000,
  "fee": 9110000,
  "state": "completed",
  "transfer": [
    {
      "amount": 79990000,
      "address": "453biCQpM6oSSr7jgTwmtC9YfiXUWZY1wEfSZJD4r6rf7mPqPj8NZpp7WYpAHVq7p69SYa1B1zMN6SeRc8exYi1WEenqu2c"
    }
  ],
  "confirmations": 15,
  "double_spend_seen": false,
  "height": 2407445,
  "timestamp": "2022-07-18T11:37:50Z",
  "unlock_time": 10,
  "tx_hash": "cf448effb86f24f81476c0012a6636700488e13accd91f8f43302ae90fed25ce"
}
```

--------------------------------

### MoneroPay Incoming Transaction Notification (JSON)

Source: https://moneropay.eu/api/callback

This JSON payload represents the data structure sent by MoneroPay to a callback URL when a new incoming transaction is detected. It includes payment details, transaction specifics, and completion status.

```json
{
  "amount": {
    "expected": 0,
    "covered": {
      "total": 200000000,
      "unlocked": 200000000
    }
  },
  "complete": true,
  "description": "Donation to Kernal",
  "created_at": "2022-07-11T19:04:24.574583Z",
  "transaction": {
    "amount": 200000000,
    "confirmations": 10,
    "double_spend_seen": false,
    "fee": 9200000,
    "height": 2402648,
    "timestamp": "2022-07-11T19:19:05Z",
    "tx_hash": "0c9a7b40b15596fa9a06ba32463a19d781c075120bb59ab5e4ed2a97ab3b7f33",
    "unlock_time": 0,
    "locked": false
  }
}
```
Tokens:
Raw