# Echelon Public API API

> Echelon Public API API on Apizie: 16 endpoints (Available payment options., Available payment options., Incoming payment detail., Create payment., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/payments:echelon/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:echelon`
- Category: Payments
- Status: byok
- Source: https://www.echelonpro.io
- Page: https://www.apizie.tech/api/payments/echelon
- OpenAPI: https://www.apizie.tech/api/payments/echelon/openapi.json

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…

## Endpoints

### Available payment options.
`POST https://www.apizie.tech/v1/payments:echelon/incoming-payments-get-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |
| Id-Customer | string | no | TODO: Add description of Id-Customer header |
| body | object | yes | JSON request body |

### Available payment options.
`POST https://www.apizie.tech/v1/payments:echelon/outgoing-payments-get-available-payment-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |
| Id-Customer | string | no | TODO: Add description of Id-Customer header |
| body | object | yes | JSON request body |

### Incoming payment detail.
`GET https://www.apizie.tech/v1/payments:echelon/incoming-payments-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |
| idPayin | string | yes | Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids). |

### Create payment.
`POST https://www.apizie.tech/v1/payments:echelon/incoming-payments-create-payment-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |
| Id-Customer | string | no | TODO: Add description of Id-Customer header |
| idPayin | string | yes | Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids). |
| body | object | yes | JSON request body |

### Outgoing payment detail.
`GET https://www.apizie.tech/v1/payments:echelon/outgoing-payments-get-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |
| idPayout | string | yes | Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids). |

### Create outgoing payment.
`POST https://www.apizie.tech/v1/payments:echelon/outgoing-payments-create-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |
| Id-Customer | string | no | TODO: Add description of Id-Customer header |
| idPayout | string | yes | Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids). |
| body | object | yes | JSON request body |

### Set external reference for the payment.
`POST https://www.apizie.tech/v1/payments:echelon/payin-set-external-reference` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |
| idPayin | string | yes | Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids). |
| body | object | yes | JSON request body |

### Account balance.
`GET https://www.apizie.tech/v1/payments:echelon/accounts-get-balances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |
| currencyCodes | string | no | List of requested currencies. How to send multiple values please refer to [Query for multiple… |

### Incoming payment accounts details.
`GET https://www.apizie.tech/v1/payments:echelon/payin-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |
| idPayin | string | yes | Unique Merchant Order ID provided by merchant. See [Request IDs](general.html#request-ids). |

### Merchant information.
`GET https://www.apizie.tech/v1/payments:echelon/merchant-info-get-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |

### Currencies.
`GET https://www.apizie.tech/v1/payments:echelon/payments-get-currencies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |

### Segments.
`GET https://www.apizie.tech/v1/payments:echelon/payments-list-segments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |

### Payment operators.
`GET https://www.apizie.tech/v1/payments:echelon/payments-get-operators-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |

### Payment methods.
`GET https://www.apizie.tech/v1/payments:echelon/payments-list-payment-methods` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |

### Payment options.
`GET https://www.apizie.tech/v1/payments:echelon/payments-get-payment-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |
| paymentTypeCode | string | no | Payment direction from the merchant's point of view. |
| paymentMethodCodes | string | no | Comma separated list of requested payment method codes. See request body for `paymentMethodCode` description and [Query for multiple… |
| currencyCodes | string | no | List of requested currencies. How to send multiple values please refer to [Query for multiple… |
| segmentCodes | string | no | Comma separated list of requested segment codes. See [`GET /segments`](https://developers.echelonpay.com) API and [Query for multiple… |
| paymentOperatorCodes | string | no | Comma separated list of payment operator codes. See request body for `paymentOperators` description and [Query for multiple… |

### Authorization token.
`POST https://www.apizie.tech/v1/payments:echelon/auth-issue-jwt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-API-Version | integer | yes | Required API version. See [Versioning](general.html#versioning) |
| body | object | yes | JSON request body |

## Example
```
curl "https://www.apizie.tech/v1/payments:echelon/incoming-payments-get-options" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Echelon Public API API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/payments:echelon/incoming-payments-get-options with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Echelon Public API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Echelon Public API itself also needs your own key from api.echelonpay.com.

### Can AI agents use the Echelon Public API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:echelon.

### What is the status of the Echelon Public API API?
Needs your own provider key (bring your own key)