canonical: https://jentic.com/apis/riverty.com/riverty

# Riverty BNPL Order Management API

Riverty Buy Now, Pay Later (BNPL) API for payment authorization, capture, refund, void, and order management. Supports multiple payment types including invoices, installments, and direct debit across European markets. The API exposes 6 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get available payment methods, authorize a payment. Covers 6 operations with apiKey authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Get available payment methods
- Authorize a payment
- Capture a payment
- Refund a payment
- Void an authorization
- Update an order

## Use cases

### Payments Operations

Use the Riverty BNPL Order Management API to perform payments operations programmatically. The API provides 6 endpoints covering core functionality including get available payment methods, authorize a payment, capture a payment.

Example prompt: Call POST `/api/v3/checkout/payment-methods` to get available payment methods

### Automated Checkout Management

Automate checkout operations by combining multiple Riverty BNPL Order Management API endpoints. Agents can authorize a payment and then capture a payment in a single workflow.

Example prompt: Call POST `/api/v3/checkout/authorize` to authorize a payment, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Riverty BNPL Order Management API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'get available payment methods', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v3/checkout/payment-methods` | Get available payment methods |
| POST | `/api/v3/checkout/authorize` | Authorize a payment |
| POST | `/api/v3/orders/{orderNumber}/captures` | Capture a payment |
| POST | `/api/v3/orders/{orderNumber}/refunds` | Refund a payment |
| POST | `/api/v3/orders/{orderNumber}/voids` | Void an authorization |
| POST | `/api/v3/orders/{orderNumber}/updateOrder` | Update an order |

## Key resources

- **Checkout** — Operations for checkout
- **Orders** — Operations for orders

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 67 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 69 / 100
  - AI-Readiness & Agent Experience: 51 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 69 / 100
- **View full report:** https://jentic.com/apis/riverty.com/riverty/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Riverty BNPL Order Management API by hand means setting your Riverty apiKey in the Authorization header, choosing between the production and sandbox hosts, and posting captures, refunds, and voids against each order yourself. Through Jentic you install once, import the Riverty BNPL Order Management API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Riverty puts the order number in the URL path (`/api/v3/orders/{orderNumber}/captures`), so a rule can pin your agent to one order: it can capture or update that order and nothing else. You choose the operations it may call, so money-moving ones like refunds or voids are not included unless you add them.
- **Credential handling:** Your Riverty API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get available payment methods' or 'capture an order', and Jentic returns the matching Riverty BNPL Order Management API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Riverty BNPL Order Management API use?

The Riverty BNPL Order Management API uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get available payment methods with the Riverty BNPL Order Management API?

Yes. Use the POST `/api/v3/checkout/payment-methods` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Riverty BNPL Order Management API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get available payment methods through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get available payment methods'. Jentic returns the matching Riverty BNPL Order Management API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Riverty BNPL Order Management API have?

The Riverty BNPL Order Management API exposes 6 endpoints covering checkout, orders operations.

### Can I limit what my agent is allowed to do with the Riverty BNPL Order Management API?

Yes. Riverty puts the order number in the URL path, such as `/api/v3/orders/{orderNumber}/captures`, so a rule you set in your self-hosted Jentic One instance can pin the agent to a single order and let it capture or update only that order. You also choose which of the six operations the agent may call, so money-moving actions like refunds and voids stay out of reach unless you explicitly grant them. Because Jentic One runs under your control, your own rules decide which operations and stored credentials the agent uses at execution time.