Docs

Billpay · API reference

Get Payee Details

GET /api/v1/payees/{id}
Try it ▸

Base URL not set in the spec · operationId getPayee

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.

Authorization

BearerAuth Bearer token

Path parameters

id string (uuid) required

Unique payee identifier (UUID).

Example a1b2c3d4-e5f6-7890-abcd-ef1234567890

Responses

200 Payee details retrieved successfully. application/json
payee_id string (uuid) required

Unique payee identifier.

name string required

Display name of the payee.

category string required

Industry or category label for the payee.

type string required

Payee category for integration behavior (e.g. Bill, Topup).

reference_config object required

Optional hints for validating the payer reference or account number format.

regex reference_config.regex string | null required

Regular expression pattern used to validate references, when available.

financial_rules object

Payment amount constraints and billing rules. Typically present when type is Bill; may be omitted for other payee types.

minimum_amount financial_rules.minimum_amount string required

Minimum payment amount (decimal string in currency units).

maximum_amount financial_rules.maximum_amount string required

Maximum payment amount (decimal string in currency units).

payment_type financial_rules.payment_type string required

Supported payment mode for this payee.

totals partials
accepts_expired financial_rules.accepts_expired boolean required

Whether payments are accepted when the bill is expired.

capabilities object

Operational capabilities. Typically present when type is Bill; may be omitted for other payee types.

has_balance capabilities.has_balance boolean required

Whether a balance inquiry can be performed for this payee.

connection_mode capabilities.connection_mode string required

How the payee integration is executed.

online batch
currency string | null

Currency for the payee. Typically present when category is Giftcard.

images object | null

Product images. Typically present when category is Giftcard.

small images.small object
id images.small.id string
url images.small.url string
large images.large object
id images.large.id string
url images.large.url string
redemption_info string | null

Instructions or info for redeeming the gift card. Typically present when type is EGift.

price string | null

Fixed price of the gift card. Typically present when type is EGift.

bundles array of (string | number) | null

Predefined top-up amounts. Typically present when type is Topup. Values follow the format returned by the API (string or numeric).

401 Unauthorized application/json
errors array of string required
404 Payee not found application/json
error string required

Message describing why the payee could not be found.

This request is in the Monato · Billpay Postman collection.Download collection

Request

curl -X GET "$BASE_URL/api/v1/payees/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "payee_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "AVON",
  "category": "Beauty",
  "type": "Bill",
  "reference_config": {
    "regex": "^[0-9]{20}$"
  },
  "financial_rules": {
    "minimum_amount": "0",
    "maximum_amount": "8000",
    "payment_type": "totals",
    "accepts_expired": true
  },
  "capabilities": {
    "has_balance": false,
    "connection_mode": "online"
  }
}