# Edge API API

> Edge API API on Apizie: 41 endpoints (Show, List of Charges, Create, Show, …) 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:edge/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Edge Payment Technologies offers payment solutions for merchants in diverse legal industries. To learn more about Edge's proposition see our [about](https://tryedge.io/about) page. Before starting with the API, you…

## Endpoints

### Show
`GET https://www.apizie.tech/v1/payments:edge/attachments-show-individual-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[records] | array | no |  |
| include | array | no |  |

### List of Charges
`GET https://www.apizie.tech/v1/payments:edge/charges-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[events] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[customers] | array | no |  |
| fields[payment_methods] | array | no |  |
| fields[billing_addresses] | array | no |  |
| fields[subscriptions] | array | no |  |
| fields[shipping_addresses] | array | no |  |
| include | array | no |  |
| filter[amount_cents] | string | no |  |
| filter[captured] | string | no |  |
| filter[currency] | string | no |  |
| filter[description] | string | no |  |
| filter[fee_cents] | string | no |  |
| filter[gateway_fee_cents] | string | no |  |
| filter[net_cents] | string | no |  |
| filter[processor_state] | string | no |  |
| filter[refund_amount_cents] | string | no |  |

### Create
`POST https://www.apizie.tech/v1/payments:edge/charges-create-new-charge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[events] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[customers] | array | no |  |
| fields[payment_methods] | array | no |  |
| fields[billing_addresses] | array | no |  |
| fields[subscriptions] | array | no |  |
| fields[shipping_addresses] | array | no |  |
| include | array | no |  |
| body | object | no | JSON request body |

### Show
`GET https://www.apizie.tech/v1/payments:edge/charges-show-individual-charge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[events] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[customers] | array | no |  |
| fields[payment_methods] | array | no |  |
| fields[billing_addresses] | array | no |  |
| fields[subscriptions] | array | no |  |
| fields[shipping_addresses] | array | no |  |
| include | array | no |  |

### List of Consumer Addresses
`GET https://www.apizie.tech/v1/payments:edge/consumer-addresses-list-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |
| filter[city] | string | no |  |
| filter[country] | string | no |  |
| filter[line_1] | string | no |  |
| filter[line_2] | string | no |  |
| filter[state] | string | no |  |
| filter[zip] | string | no |  |

### Create
`POST https://www.apizie.tech/v1/payments:edge/consumer-addresses-create-new-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |
| body | object | no | JSON request body |

### Show
`GET https://www.apizie.tech/v1/payments:edge/consumer-addresses-show-individual-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |

### List of Customers
`GET https://www.apizie.tech/v1/payments:edge/customers-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[events] | array | no |  |
| fields[charges] | array | no |  |
| fields[payment_methods] | array | no |  |
| fields[subscriptions] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[addresses] | array | no |  |
| include | array | no |  |
| filter[description] | string | no |  |
| filter[email] | string | no |  |
| filter[name] | string | no |  |
| filter[phone_number] | string | no |  |

### Create
`POST https://www.apizie.tech/v1/payments:edge/customers-create-new-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[events] | array | no |  |
| fields[charges] | array | no |  |
| fields[payment_methods] | array | no |  |
| fields[subscriptions] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[addresses] | array | no |  |
| include | array | no |  |
| body | object | no | JSON request body |

### Show
`GET https://www.apizie.tech/v1/payments:edge/customers-show-individual-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[events] | array | no |  |
| fields[charges] | array | no |  |
| fields[payment_methods] | array | no |  |
| fields[subscriptions] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[addresses] | array | no |  |
| include | array | no |  |

### Update
`POST https://www.apizie.tech/v1/payments:edge/customers-update-existing-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[events] | array | no |  |
| fields[charges] | array | no |  |
| fields[payment_methods] | array | no |  |
| fields[subscriptions] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[addresses] | array | no |  |
| include | array | no |  |
| body | object | no | JSON request body |

### List of Events
`GET https://www.apizie.tech/v1/payments:edge/events-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[merchant_accounts] | array | no |  |
| fields[resources] | array | no |  |
| include | array | no |  |
| filter[code] | string | no |  |

### Show
`GET https://www.apizie.tech/v1/payments:edge/events-show-individual-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[merchant_accounts] | array | no |  |
| fields[resources] | array | no |  |
| include | array | no |  |

### List of Legal Addresses
`GET https://www.apizie.tech/v1/payments:edge/legal-addresses-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| include | array | no |  |
| filter[city] | string | no |  |
| filter[country] | string | no |  |
| filter[line_1] | string | no |  |
| filter[line_2] | string | no |  |
| filter[state] | string | no |  |
| filter[zip] | string | no |  |

### Create
`POST https://www.apizie.tech/v1/payments:edge/legal-addresses-create-new` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| include | array | no |  |
| body | object | no | JSON request body |

### Show
`GET https://www.apizie.tech/v1/payments:edge/legal-addresses-show-individual` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| include | array | no |  |

### Update
`POST https://www.apizie.tech/v1/payments:edge/legal-addresses-update-existing-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| include | array | no |  |
| body | object | no | JSON request body |

### List of Merchant Accounts
`GET https://www.apizie.tech/v1/payments:edge/merchant-accounts-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[consumer_addresses] | array | no |  |
| fields[customers] | array | no |  |
| fields[events] | array | no |  |
| fields[payouts] | array | no |  |
| fields[payment_methods] | array | no |  |
| fields[charges] | array | no |  |
| fields[subscriptions] | array | no |  |
| fields[webhook_subscriptions] | array | no |  |
| fields[payout_methods] | array | no |  |
| include | array | no |  |
| filter[average_monthly_transaction_volume_cents] | string | no |  |
| filter[average_transaction_size_cents] | string | no |  |
| filter[business_address] | string | no |  |
| filter[business_address_line_2] | string | no |  |
| filter[business_city_name] | string | no |  |
| filter[business_country] | string | no |  |
| filter[business_description] | string | no |  |
| filter[business_name] | string | no |  |
| filter[business_privacy_url] | string | no |  |
| filter[business_state] | string | no |  |
| filter[business_support_email] | string | no |  |
| filter[business_support_url] | string | no |  |
| filter[business_terms_url] | string | no |  |
| filter[business_timezone] | string | no |  |
| filter[business_website] | string | no |  |
| filter[business_zip_code] | string | no |  |
| filter[max_transaction_size_cents] | string | no |  |
| filter[phone_number] | string | no |  |
| filter[public_business_name] | string | no |  |
| filter[shortened_descriptor] | string | no |  |
| filter[statement_descriptor] | string | no |  |

### Show
`GET https://www.apizie.tech/v1/payments:edge/merchant-accounts-show-individual` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[consumer_addresses] | array | no |  |
| fields[customers] | array | no |  |
| fields[events] | array | no |  |
| fields[payouts] | array | no |  |
| fields[payment_methods] | array | no |  |
| fields[charges] | array | no |  |
| fields[subscriptions] | array | no |  |
| fields[webhook_subscriptions] | array | no |  |
| fields[payout_methods] | array | no |  |
| include | array | no |  |

### Update
`POST https://www.apizie.tech/v1/payments:edge/merchant-accounts-update-existing-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[consumer_addresses] | array | no |  |
| fields[customers] | array | no |  |
| fields[events] | array | no |  |
| fields[payouts] | array | no |  |
| fields[payment_methods] | array | no |  |
| fields[charges] | array | no |  |
| fields[subscriptions] | array | no |  |
| fields[webhook_subscriptions] | array | no |  |
| fields[payout_methods] | array | no |  |
| include | array | no |  |
| body | object | no | JSON request body |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[charges] | array | no |  |
| fields[customers] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[addresses] | array | no |  |
| include | array | no |  |
| filter[card_bin] | string | no |  |
| filter[card_cvv_token] | string | no |  |
| filter[card_last_four] | string | no |  |
| filter[card_pan_token] | string | no |  |
| filter[description] | string | no |  |
| filter[external_state] | string | no |  |
| filter[kind] | string | no |  |
| filter[name] | string | no |  |

### Create
`POST https://www.apizie.tech/v1/payments:edge/payment-methods-create-new-method` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[charges] | array | no |  |
| fields[customers] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[addresses] | array | no |  |
| include | array | no |  |
| body | object | no | JSON request body |

### Show
`GET https://www.apizie.tech/v1/payments:edge/payment-methods-show-individual` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[charges] | array | no |  |
| fields[customers] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[addresses] | array | no |  |
| include | array | no |  |

### List of Payout Methods
`GET https://www.apizie.tech/v1/payments:edge/payout-methods-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[payouts] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |
| filter[account_number] | string | no |  |
| filter[account_type] | string | no |  |
| filter[institution_name] | string | no |  |
| filter[payout_method_type] | string | no |  |
| filter[routing_number] | string | no |  |

### Create
`POST https://www.apizie.tech/v1/payments:edge/payout-methods-create-new` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[payouts] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |
| body | object | no | JSON request body |

### Show
`GET https://www.apizie.tech/v1/payments:edge/payout-methods-show-individual` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[payouts] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |

### List of Payouts
`GET https://www.apizie.tech/v1/payments:edge/payouts-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[payout_methods] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |
| filter[amount_cents] | string | no |  |
| filter[amount_currency] | string | no |  |
| filter[fee_cents] | string | no |  |
| filter[fee_currency] | string | no |  |
| filter[net_amount_cents] | string | no |  |
| filter[net_amount_currency] | string | no |  |
| filter[processor_state] | string | no |  |
| filter[transfer_credit_type] | string | no |  |

### Create
`POST https://www.apizie.tech/v1/payments:edge/payouts-create-new-payout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[payout_methods] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |
| body | object | no | JSON request body |

### Show
`GET https://www.apizie.tech/v1/payments:edge/payouts-get-individual-payout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[payout_methods] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |

### List of Subscriptions
`GET https://www.apizie.tech/v1/payments:edge/subscriptions-list-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[events] | array | no |  |
| fields[charges] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[customers] | array | no |  |
| fields[payment_methods] | array | no |  |
| include | array | no |  |
| filter[amount_cents] | string | no |  |
| filter[amount_currency] | string | no |  |
| filter[billing_period] | string | no |  |
| filter[description] | string | no |  |
| filter[next_billing_day] | string | no |  |
| filter[status] | string | no |  |

### Create
`POST https://www.apizie.tech/v1/payments:edge/subscriptions-create-new` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[events] | array | no |  |
| fields[charges] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[customers] | array | no |  |
| fields[payment_methods] | array | no |  |
| include | array | no |  |
| body | object | no | JSON request body |

### Show
`GET https://www.apizie.tech/v1/payments:edge/subscriptions-show-individual` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[events] | array | no |  |
| fields[charges] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[customers] | array | no |  |
| fields[payment_methods] | array | no |  |
| include | array | no |  |

### Update
`POST https://www.apizie.tech/v1/payments:edge/subscriptions-update-existing-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[events] | array | no |  |
| fields[charges] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| fields[customers] | array | no |  |
| fields[payment_methods] | array | no |  |
| include | array | no |  |
| body | object | no | JSON request body |

### List of Users
`GET https://www.apizie.tech/v1/payments:edge/users-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |
| filter[account_status] | string | no |  |
| filter[email] | string | no |  |
| filter[first_name] | string | no |  |
| filter[job_title] | string | no |  |
| filter[last_name] | string | no |  |
| filter[phone_number] | string | no |  |

### Show
`GET https://www.apizie.tech/v1/payments:edge/users-show-individual-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |

### Update
`POST https://www.apizie.tech/v1/payments:edge/users-update-user-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |
| body | object | no | JSON request body |

### List of Webhook Subscriptions
`GET https://www.apizie.tech/v1/payments:edge/webhook-subscriptions-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[events] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |
| filter[active] | string | no |  |
| filter[concurrency_limit] | string | no |  |
| filter[description] | string | no |  |
| filter[url] | string | no |  |

### Create
`POST https://www.apizie.tech/v1/payments:edge/webhook-subscriptions-create-new-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields[events] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |
| body | object | no | JSON request body |

### Show
`GET https://www.apizie.tech/v1/payments:edge/webhook-subscriptions-show-individual` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[events] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |

### Update
`POST https://www.apizie.tech/v1/payments:edge/webhook-subscriptions-update-existing-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[events] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |
| body | object | no | JSON request body |

### Destroy
`POST https://www.apizie.tech/v1/payments:edge/webhook-subscriptions-destroy-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A UUID that identifies an object |
| fields[events] | array | no |  |
| fields[merchant_accounts] | array | no |  |
| include | array | no |  |

## Example
```
curl "https://www.apizie.tech/v1/payments:edge/attachments-show-individual-attachment" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Edge API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/payments:edge/attachments-show-individual-attachment with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Edge API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Edge API itself also needs your own key from {apiHost}.

### Can AI agents use the Edge 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:edge.

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