Credit card and ACH processing for ECI manufacturing products through the Paya payment gateway: payments, accounts, account vaults and contacts. Bearer tokens from the Integration Engine client-credentials flow. Not surfaced on the public documentation index (public: false in the portal manifest) but the contract is served anonymously.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/eci-solutions-payment"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{
"openapi": "3.0.1",
"info": {
"title": "ECI MFG Payment API",
"description": "# PaymentIntegration API User Guide\n\nThis guide explains how to use the PaymentIntegration API to process payments and manage customer data.\n\n## Introduction\n\nThe PaymentIntegration API allows you to integrate payment processing capabilities directly into your application. It provides a secure and straightforward way to handle online payments, manage saved customer payment methods, and maintain customer contact information through the Paya Payment Gateway.\n\n### Core Features\n- **Process Payments**: Charge credit cards and ACH accounts, issue refunds, and void transactions.\n- **Manage Saved Payment Methods**: Securely save, update, and delete customer payment methods in a \"vault\" for easy reuse.\n- **Manage Customer Contacts**: Create, update, and retrieve customer contact information associated with payments.\n- **Launch Secure Payment Forms**: Generate and launch Paya-hosted payment forms to securely capture customer payment information for one-time payments or for saving new payment methods to the vault. This helps with PCI compliance by ensuring sensitive payment data is entered directly into the payment gateway's secure environment.\n\n## Authentication\n\nTo use the API, you must include an access token with each request. The token should be provided in the `Authorization` header.\n\n**Example:**\n`Authorization: Bearer <your_access_token>`\n\nAll API requests must be made over HTTPS.\n\n## API Features and Endpoints\n\nThe API provides a set of endpoints to access its features. The main resources are Payments, Account Vaults, and Contacts.\n\n### Payments\n\nThe Payments functionality allows you to manage the full lifecycle of payment transactions. You can process new payments against saved payment methods, complete payments that were previously authorized, and perform follow-up actions such as refunds, voids, or partial reversals. The API also supports retrieving lists of transactions, which can be filtered by various criteria including contact, location, transaction ID, or status.\n\n### Account Vault (Saved Payment Methods)\n\nThe Account Vault is used to securely manage a customer's saved payment methods. It provides the capabilities to retrieve the details of a specific payment method, update its information (such as an expiration date), or remove it from the vault entirely.\n\n### Contacts\n\nThe Contacts functionality is used to manage customer contact information. You can create new contacts, update existing ones, and retrieve the details for a specific contact. The API also allows you to get a list of all saved payment methods for a contact and to find contacts that are associated with a specific account number.\n\n## Error Handling\n\nIf an API request fails, you will receive a response with an appropriate HTTP status code (e.g., `400` for a bad request, `401` for an authentication error) and a JSON body containing a `Message` field that explains the reason for the error.\n\n",
"contact": {
"name": "ECI Manufacturing Division Integration Team",
"url": "https://www.ecisolutions.com/support/"
},
"version": "2.9.29+ff43d60aad"
},
"paths": {
"/api/account/authenticate": {
"post": {
"tags": [
"Account"
],
"summary": "Authenticate user credentials.",
"description": "***This method is obsolete. Use the Integration Authentication API instead.***\r\n\r\nThis API authenticates the user credentials. After successful authentication, it returns token and refresh token",
"requestBody": {
"description": "This is an object which contains username and password and both are required",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthenticateUser"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AuthenticateUser"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AuthenticateUser"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AuthenticateUserResponseAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthenticateUserResponseAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AuthenticateUserResponseAPIResponse"
}
}
}
}
},
"deprecated": true
}
},
"/api/account/register": {
"post": {
"tags": [
"Account"
],
"summary": "Creates a new Payment API user account and possibly company.",
"description": "This API registers the user, and creates a company also. After successful registration, user will receive a verification mail which has to be confirmed before proceeding further. \r\n\r\n**application_type** - Valid values are: Deacom, JobBOSS, JobBOSS2, M1, Macola, and Max\r\n\r\n**company_name and customer_id** - Currently, Company name and customer id are not required, if one is being provided then other one will be required. \r\nUser can provide existing company name and customer id for creating company, otherwise this request will use [last_name, first_name, user_name] as company name and user_name as customer id for creating a company.\n\r\nIf the customer_id of an existing Company with the same matching application_type (Product) is provided, the API user will be added\r\nto the existing Company. Otherwise, a new Company will be created.\r\n\r\n**enable_password_reset** - Allows user to reset password in future.\r\n\r\n\n\r\n**allowed_origin_domains** - Optional. Space‑separated list of domains allowed to call the API, e.g. *.example.com.\r\n\r\nFor existing company: If not provided, the Company's existing value is used. If provided, the new domains are added to the existing list.\r\nSupplying the same domain multiple times has no effect on the final list.\r\n\n\r\n**merchant_country** - Optional. Valid values: [United States, Canada].\r\nIf the Company does not already support the specified country, the Company properties are updated to include it,\r\nand the user is associated with the provided country.\r\n\r\n\r\n**Note**: allowed_origin_domains and merchant_country properties has update effect for existing companies. A domain or country will never be removed from company,\r\nas these values could be associated to other users; only additions are made.",
"requestBody": {
"description": "This is an object which contains all required and optional fields to register user",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegistrationModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RegistrationModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RegistrationModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
}
}
}
}
}
},
"/api/account/verifypayamerchantaccount": {
"post": {
"tags": [
"Account"
],
"summary": "Verify paya merchant account",
"description": "This Api allows to verify the merchant account.",
"requestBody": {
"description": "This is an object which contains developer id and location id of merchant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MerchantAccountModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MerchantAccountModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/MerchantAccountModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
}
}
}
}
}
},
"/api/account/resendconfirmationemail": {
"post": {
"tags": [
"Account"
],
"summary": "Resend confirmation mail",
"description": "This Api resends the mail to confirm or verify the registration.",
"requestBody": {
"description": "This is an object which contains username",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResendConfirmEmailModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ResendConfirmEmailModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ResendConfirmEmailModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
}
}
}
}
}
},
"/api/account/verifymerchantaccountandauthenticateuser": {
"post": {
"tags": [
"Account"
],
"summary": "Verify paya merchant account with user credentials",
"description": "This Api allows to verify the merchant account.\r\nAdditionally, it validates the user credentials.",
"requestBody": {
"description": "This is an object which contains developer id and location id of merchant and user credential details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MerchantUserModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MerchantUserModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/MerchantUserModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
}
}
}
}
}
},
"/api/account/me": {
"get": {
"tags": [
"Account"
],
"summary": "Get details about the current user",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ApiUserSettingsAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiUserSettingsAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ApiUserSettingsAPIResponse"
}
}
}
}
}
}
},
"/api/accountvault": {
"get": {
"tags": [
"AccountVault"
],
"summary": "Gets account vault details.",
"description": "### Gets account vault details\r\nThis API retrieves information for account vault records that have already been associated with the account.",
"parameters": [
{
"name": "accountVaultId",
"in": "query",
"description": "This field contains the account vault ID.",
"schema": {
"type": "string"
}
},
{
"name": "developerId",
"in": "query",
"description": "This field contains the developer ID.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountVaultDetailResponseAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountVaultDetailResponseAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountVaultDetailResponseAPIResponse"
}
}
}
}
}
},
"put": {
"tags": [
"AccountVault"
],
"summary": "Updates account vault details.",
"description": "### Updates account vault details\r\nThis API updates information such as the expiry date and account holder name of account vault records.",
"requestBody": {
"description": "This is an object which contains the required fields to process this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountVaultUpdateModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountVaultUpdateModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AccountVaultUpdateModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"AccountVault"
],
"summary": "Deletes an account vault.",
"description": "### Deletes an account vault\r\nThis API deletes an associated account vault.",
"requestBody": {
"description": "This is an object which contains the required fields to process this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountVaultDetailRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountVaultDetailRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AccountVaultDetailRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
}
}
}
}
}
},
"/api/contact": {
"post": {
"tags": [
"Contact"
],
"summary": "Creates a Paya contact.",
"description": "### Creates a Paya Contact\r\n\r\nCreating a contact is the first step to enabling payment processing for a customer. A contact represents an individual or entity within the Paya system.\r\n\r\n#### Why create a contact?\r\n- **Store Payment Methods:** Once a contact is created, you can securely save their payment methods (credit cards, bank accounts) in a Paya \"Account Vault\".\r\n- **Process Transactions:** With a stored payment method, you can easily process future transactions like sales, refunds, or authorizations without requiring the customer to re-enter their details.\r\n- **Streamline Billing:** It is essential for recurring billing, subscriptions, and providing a quick checkout experience for returning customers.\r\n\r\nThis endpoint captures the necessary customer information to establish their record in the Paya gateway.",
"requestBody": {
"description": "An object containing the details of the contact to be created, such as name, email, and address.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contact"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Contact"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Contact"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
}
}
}
}
},
"get": {
"tags": [
"Contact"
],
"summary": "Gets contact details.",
"description": "### Gets contact details\r\nThis API shows all details of a desired contact.",
"parameters": [
{
"name": "contactId",
"in": "query",
"description": "This field contains the desired contact ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "developerId",
"in": "query",
"description": "This field contains the desired developer ID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ContactAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ContactAPIResponse"
}
}
}
}
}
}
},
"/api/contact/{id}": {
"patch": {
"tags": [
"Contact"
],
"summary": "Updates a contact.",
"description": "### Updates a contact\r\nThis API patches or updates only the desired records of a contact, which are provided in the request model.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "This field requires the contact ID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "This is an object which can contain only the desired fields to patch or update. (Developer ID is required).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContact"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContact"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateContact"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
}
}
}
}
}
},
"/api/contact/getaccountvaultsforcontact": {
"get": {
"tags": [
"Contact"
],
"summary": "Gets contact account vaults.",
"description": "### Gets contact account vaults\r\nThis API allows you to get all account vault details associated with the account, or you can filter by providing a contact ID.",
"parameters": [
{
"name": "contactId",
"in": "query",
"description": "This field contains the desired contact ID.",
"schema": {
"type": "string"
}
},
{
"name": "developerId",
"in": "query",
"description": "This field contains the developer ID, which is required.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountVaultListResponseAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountVaultListResponseAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountVaultListResponseAPIResponse"
}
}
}
}
}
}
},
"/api/contact/GetAccountNumberContacts": {
"get": {
"tags": [
"Contact"
],
"summary": "Gets contacts by account number.",
"description": "### Gets contacts by account number\r\nThis API allows you to get all contact details associated with the account, or you can filter by providing an account number and location ID.",
"parameters": [
{
"name": "accountNumber",
"in": "query",
"description": "This field contains the account number.",
"schema": {
"type": "string"
}
},
{
"name": "developerId",
"in": "query",
"description": "This field contains the developer ID, which is required.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locationId",
"in": "query",
"description": "This field contains the location ID.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountNumberContactsAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountNumberContactsAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountNumberContactsAPIResponse"
}
}
}
}
}
}
},
"/api/payment/accountVaultTransaction": {
"post": {
"tags": [
"Payment"
],
"summary": "Charges an account vault.",
"description": "### Charges an account vault\r\nThis API allows you to charge a customer through an associated account vault.\r\n\r\nThis endpoint supports the following actions:\r\n* `sale`: A standard transaction that charges the customer's card and marks it for settlement.\r\n* `authonly`: Authorizes an amount on the customer's card but does not charge it. The funds are held for a period of time.\r\n* `debit`: A transaction that debits a bank account (ACH).\r\n* `avsonly`: Performs an Address Verification System (AVS) check only, without charging the card.\r\n\r\nOther actions like `refund`, `void`, `credit`, etc., are supported via the `POST /api/payment/updatetransaction` endpoint.\r\nThe `edit` action is supported via the `PUT /api/payment/accountVaultTransaction` endpoint.",
"requestBody": {
"description": "This is an object which contains all required fields to process the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountVaultTransaction"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountVaultTransaction"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AccountVaultTransaction"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TransactionResponseAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionResponseAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TransactionResponseAPIResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Payment"
],
"summary": "Updates a transaction description.",
"description": "### Updates a transaction description\r\nThis API allows you to update a description for any transaction using the `edit` action.",
"requestBody": {
"description": "This is an object which contains all required fields to proceed further.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentTransaction"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PaymentTransaction"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PaymentTransaction"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
}
}
}
}
}
},
"/api/payment/updateauthonlytransaction": {
"put": {
"tags": [
"Payment"
],
"summary": "Completes auth-only transactions.",
"description": "### Completes auth-only transactions\r\nThis API allows you to perform a complete on auth-only transactions.",
"requestBody": {
"description": "This is a list object which contains all auth-only transaction IDs.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthOnlyTransactionDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AuthOnlyTransactionDetails"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AuthOnlyTransactionDetails"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
}
}
}
}
}
}
},
"/api/payment/updateauthonlytransactionbyid": {
"put": {
"tags": [
"Payment"
],
"s
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/eci-solutions/refs/heads/main/openapi/eci-solutions-payment-openapi.json