# Monato's API

Version: 1.0.0

## Security

### BearerAuth

Type: http
Scheme: bearer
Bearer Format: Access Token

### ApiKeyAuth

Type: apiKey
In: header
Name: X-API-Key

## Download OpenAPI description

[Monato's API](https://docs.monato.com/_bundle/products/billpay/billpay-v1.yaml)

## Other

### Create a Payment

 - [POST /v1/payments](https://docs.monato.com/products/billpay/billpay-v1/other/createpayment.md): Endpoint to create a Payment in Monato Billpay.

### Retrieve Payment

 - [GET /v1/payments/{id}](https://docs.monato.com/products/billpay/billpay-v1/other/retrievepayment.md): Endpoint to retrieve a Payment by Id.

### Create a Balance

 - [POST /v1/balances](https://docs.monato.com/products/billpay/billpay-v1/other/createbalance.md): Endpoint to create a Balance in Monato Billpay.

### Retrieve Balance

 - [GET /v1/balances/{id}](https://docs.monato.com/products/billpay/billpay-v1/other/retrievebalance.md): Endpoint to retrieve a Balance in Monato Billpay.

### Retrieve Account

 - [GET /v1/client/account/{id}](https://docs.monato.com/products/billpay/billpay-v1/other/retrieveaccount.md): Endpoint to retrieve an Account in Monato Billpay

### Create Topup

 - [POST /v1/topups](https://docs.monato.com/products/billpay/billpay-v1/other/createtopup.md): Endpoint to create Topups in Monato Billpay

### Verify Payment

 - [POST /v1/verify-payment](https://docs.monato.com/products/billpay/billpay-v1/other/verifypayment.md): Endpoint to verify Payments in Monato Billpay

### List Payees

 - [GET /api/v1/payees](https://docs.monato.com/products/billpay/billpay-v1/other/listpayees.md): Returns a paginated list of payees in alphabetical order by display name.

Optional query parameters filter the result set. When multiple filters are supplied,
all of them apply together (logical AND).

Filters

- name — Case-insensitive match anywhere in the payee display name (not prefix-only).
- category — Exact match on the payee industry/category.
- connection_mode — How the service is connected (online or batch).
- has_balance — Whether balance inquiry is supported for that payee.
- accepts_expired — Whether payments on expired bills are allowed for that payee.

### Get Payee Details

 - [GET /api/v1/payees/{id}](https://docs.monato.com/products/billpay/billpay-v1/other/getpayee.md): Returns a single payee by identifier. The payload uses the same shape as items in the
list endpoint: Bill payees usually include financial_rules and capabilities;
Topup payees usually include bundles.