canonical: https://jentic.com/apis/sandbox.echelonpay.com/sandbox-echelonpay

# Sandbox Echelonpay Public API

Echelon solutions simplify your payment process, and offer a wide range of features & services to help your business run smoothly. With our cutting edge technology, global coverage, our alternative solutions - we will connect your business with over 1 billion consumers across Asia. Echelon offers you an All-In-One API integration, giving your clients access to their preferred local payment method . The API exposes 16 endpoints secured with bearer authentication.

## For AI agents

Programmatically available payment options., available payment options.. Covers 16 operations with bearer authentication.

## Scope

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

## Capabilities

- Available payment options.
- Create payment.
- Incoming payment detail.
- Outgoing payment detail.
- Set external reference for the payment.

## Use cases

### Payments Operations

Use the Public API to perform payments operations programmatically. The API provides 16 endpoints covering core functionality including available payment options., available payment options., create payment..

Example prompt: Call POST /payins/!availablePaymentOptions to available payment options.

### Automated Payments Management

Automate payments operations by combining multiple Public API endpoints. Agents can available payment options. and then create payment. in a single workflow.

Example prompt: Call POST /payouts/!availablePaymentOptions to available payment options., then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Public 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 bearer tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/payins/!availablePaymentOptions` | Available payment options. |
| POST | `/payouts/!availablePaymentOptions` | Available payment options. |
| POST | `/payins/{idPayin}` | Create payment. |
| GET | `/payins/{idPayin}` | Incoming payment detail. |
| POST | `/payouts/{idPayout}` | Create outgoing payment. |
| GET | `/payouts/{idPayout}` | Outgoing payment detail. |
| POST | `/payins/{idPayin}/!setExternalReference` | Set external reference for the payment. |
| GET | `/balances` | Account balance. |

## Key resources

- **Payments** — Common methods that can be used for payin and payouts.
- **Incoming payments** — Incoming payment (payin) is an operation where money is sent from the customer account to the mercha
- **Outgoing payments** — Outgoing payment (payout) is an operation where money is sent from the merchant account to another a
- **Auth** — Authentication and authorization.
- **Accounts** — Accounts.

## 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:** 56 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 64 / 100
  - Developer Experience & Jentic Compatibility: 71 / 100
  - AI-Readiness & Agent Experience: 32 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/sandbox.echelonpay.com/sandbox-echelonpay/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 Echelon Pay Public API by hand means learning its bearer auth, choosing the sandbox or production echelonpay.com host, and handling payin and payout retries yourself. Through Jentic you install once, import the Public API from the API Directory, store the bearer token once, and your agent calls it.
- **Permission scoping:** Echelon Pay puts the payin and payout ids in the URL path (`/payins/{idPayin}`, `/payouts/{idPayout}`), so a rule can pin your agent to specific transactions: it can read the ones you allow and nothing else. You choose the operations it may call, so writes like creating payouts are not included unless you add them.
- **Credential handling:** Your Echelon Pay bearer token 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 options' or 'get a payin', and Jentic returns the matching Public 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 Public API use?

The Public API uses a Bearer token 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 available payment options. with the Public API?

Yes. Use the POST /payins/!availablePaymentOptions endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Public 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 available payment options. through Jentic?

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

### How many endpoints does the Public API have?

The Public API exposes 16 endpoints covering payments, incoming payments, outgoing payments operations.

### Can I limit what my agent is allowed to do with the Echelon Pay Public API?

Yes. Jentic One runs on infrastructure you host, and your own rules decide which Echelon Pay operations and credentials the agent may use. Because Echelon Pay puts the payin and payout ids directly in the URL path (`/payins/{idPayin}`, `/payouts/{idPayout}`), you can pin the agent to specific transactions and grant read-only calls like GET `/payins/{idPayin}`, GET `/payouts/{idPayout}`, or GET /balances while excluding writes such as POST `/payins/{idPayin}` that create payments. Only the operations you explicitly allow are exposed to the agent.