NMI · Schema
Response
PaymentsPayment GatewayPayment ProcessingTokenizationRecurring BillingCustomer VaultFintechEmbedded PaymentsPayment Facilitation
Properties
| Name | Type | Description |
|---|---|---|
| objectType | string | The type of object that was created as a result of the request. |
| id | string | The gateway ID of the merchant that was created. |
| type | string | The type of merchant account being created. |
| created | string | The date and time that the merchant was created. |
| updated | string | The date and time of the last update to the merchant. |
| firstName | string | The first name of the merchant's company contact. |
| lastName | string | The last name of the merchant's company contact. |
| company | string | The merchant's company name. |
| string | The email of the merchant's company contact. | |
| phone | string | The phone number of the merchant's company contact. |
| fax | string | The fax number of the merchant's company contact. |
| url | string | The merchant's website URL. |
| address1 | string | The first line of the merchant's address. |
| address2 | string | The second line of the merchant's address. |
| city | string | The city associated with the merchant's address. |
| state | string | The state associated with the merchant's address. |
| zip | string | The postal code associated with the merchant's address. |
| country | string | The country associated with the merchant's address. |
| timezone | string | The merchant's timezone. |
| costPlan | string | The cost plan assigned to the merchant. |
| status | string | The status of the merchant. |
| externalIdentifier | string | A description to further describe or identify the merchant. |
| lastTransactionDate | string | The date of the last transaction on the merchant. |
| parentAffiliateId | string | The ID of the affiliate directly above the merchant. |
| accountInfo | object | Banking information for merchant billing. |
| features | object | A collection of various merchant feature flags. |
| needsPendingServicesActivated | string | Merchant needs pending services activated. |
| payFacBillingPeriod | string | Payment Facilitator Billing Period. |
| rejectedCertificates | string | Number of rejected certificates. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/nmi/main/json-schema/nmi-create-merchant-response-schema.json",
"title": "Response",
"x-generated": "2026-10-14",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/nmi-payments-api-openapi.yml#/components/schemas/CreateMerchantResponse",
"type": "object",
"properties": {
"objectType": {
"type": "string",
"enum": [
"merchant"
],
"description": "The type of object that was created as a result of the request."
},
"id": {
"type": "string",
"description": "The gateway ID of the merchant that was created."
},
"type": {
"type": "string",
"description": "The type of merchant account being created."
},
"created": {
"type": "string",
"description": "The date and time that the merchant was created."
},
"updated": {
"type": "string",
"description": "The date and time of the last update to the merchant."
},
"firstName": {
"type": "string",
"description": "The first name of the merchant's company contact."
},
"lastName": {
"type": "string",
"description": "The last name of the merchant's company contact."
},
"company": {
"type": "string",
"description": "The merchant's company name."
},
"email": {
"type": "string",
"description": "The email of the merchant's company contact."
},
"phone": {
"type": "string",
"description": "The phone number of the merchant's company contact."
},
"fax": {
"type": "string",
"description": "The fax number of the merchant's company contact."
},
"url": {
"type": "string",
"description": "The merchant's website URL."
},
"address1": {
"type": "string",
"description": "The first line of the merchant's address."
},
"address2": {
"type": "string",
"description": "The second line of the merchant's address."
},
"city": {
"type": "string",
"description": "The city associated with the merchant's address."
},
"state": {
"type": "string",
"description": "The state associated with the merchant's address."
},
"zip": {
"type": "string",
"description": "The postal code associated with the merchant's address."
},
"country": {
"type": "string",
"description": "The country associated with the merchant's address."
},
"timezone": {
"type": "string",
"description": "The merchant's timezone."
},
"costPlan": {
"type": "string",
"description": "The cost plan assigned to the merchant."
},
"status": {
"type": "string",
"description": "The status of the merchant."
},
"externalIdentifier": {
"type": "string",
"description": "A description to further describe or identify the merchant."
},
"lastTransactionDate": {
"type": "string",
"description": "The date of the last transaction on the merchant."
},
"parentAffiliateId": {
"type": "string",
"description": "The ID of the affiliate directly above the merchant."
},
"accountInfo": {
"type": "object",
"description": "Banking information for merchant billing.",
"properties": {
"checkAba": {
"type": "string",
"description": "The routing/ABA number used to bill the merchant."
},
"checkAccount": {
"type": "string",
"description": "The account number used to bill the merchant."
},
"accountType": {
"type": "string",
"description": "The type of bank account being used."
},
"accountHolderType": {
"type": "string",
"description": "The type of holder for the bank account being used."
}
}
},
"features": {
"type": "object",
"description": "A collection of various merchant feature flags.",
"properties": {
"forceTos": {
"type": "boolean",
"description": "Whether or not the merchant is forced to accept the Terms of Service."
},
"forceBillingAuth": {
"type": "boolean",
"description": "Whether or not the merchant is forced to accept the Billing Auth."
},
"allowBlindCredits": {
"type": "boolean",
"description": "Whether or not the merchant is allowed to issue blind credits for Credit Cards."
},
"allowBlindCheckCredits": {
"type": "boolean",
"description": "Whether or not the merchant is allowed to issue blind credits for Checks."
},
"advancedTransactionRouting": {
"type": "boolean",
"description": "Whether or not the merchant has advanced transaction routing enabled."
},
"sendBillingEmail": {
"type": "boolean",
"description": "Whether or not the merchant receives an email for their billing."
},
"braspag": {
"type": "object",
"description": "Feature flags specifically related to the braspag processor.",
"properties": {
"advancedTransactionRouting": {
"type": "boolean",
"description": "Whether or not the braspag processor has advanced transaction routing enabled."
}
}
},
"verifi": {
"type": "object",
"description": "Feature flags specifically related to the verifi service.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not the verifi service is enabled for the merchant."
}
}
},
"viewBillingStatement": {
"type": "boolean",
"description": "Whether or not the merchant can view their billing statement."
},
"litle": {
"type": "object",
"description": "Feature flags specifically related to the litle processor.",
"properties": {
"reportGroup": {
"type": "string",
"description": "The merchant's litle report group. Returns false if not configured."
},
"prePaidIndicator": {
"type": "string",
"description": "The merchant's litle prepaid indicator. Returns false if not configured."
},
"affluentIndicator": {
"type": "string",
"description": "The merchant's litle affluent indicator. Returns false if not configured."
},
"recycleAdvice": {
"type": "string",
"description": "The merchant's litle recycle advice. Returns false if not configured."
},
"campaign": {
"type": "string",
"description": "The merchant's litle campaign. Returns false if not configured."
},
"affiliate": {
"type": "string",
"description": "The merchant's litle affiliate. Returns false if not configured."
},
"merchantGroupId": {
"type": "string",
"description": "The merchant's litle group ID. Returns false if not configured."
}
}
},
"allowEmptyCcExp": {
"type": "boolean",
"description": "Whether or not the merchant is allowed to pass empty Credit Card Expiration Dates."
},
"pastDue": {
"type": "boolean",
"description": "Whether or not the merchant's bill is past due."
},
"apiReceipt": {
"type": "boolean",
"description": "Whether or not the merchant's API transactions send receipts."
},
"batchReceipt": {
"type": "boolean",
"description": "Whether or not the merchant can batch receipts."
},
"delinquent": {
"type": "boolean",
"description": "Whether or not the merchant is in a delinquent state."
},
"commercialCardIndicator": {
"type": "string",
"description": "The merchant's commercial card indicator. Returns false if not configured."
},
"customDescription": {
"type": "string",
"description": "The merchant's custom description. Returns false if not configured."
},
"apiAllowOnlyUsername": {
"type": "boolean",
"description": "Whether or not the merchant can authenticate with the APIs using only a username."
},
"orderIdDuplicateCheck": {
"type": "boolean",
"description": "Whether or not the merchant has duplicate checking for the Order ID field."
},
"cardLevelResult": {
"type": "string",
"description": "The merchant's card level result. Returns false if not configured."
},
"pmsalem": {
"type": "object",
"description": "Feature flags specifically related to the pmsalem processor.",
"properties": {
"ignoreAmexCvv": {
"type": "boolean",
"description": "Whether or not the merchant's pmsalem processor ignores the Amex CVV field."
},
"allowNovusVerify": {
"type": "boolean",
"description": "Whether or not the merchant's pmsalem processor can verify Novus cards schemes."
},
"idInMdf11": {
"type": "boolean",
"description": "Whether or not the merchant's pmsalem processor can pass the ID in MDF11."
}
}
},
"credorax": {
"type": "object",
"description": "Feature flags specifically related to the credorax processor.",
"properties": {
"bankNet": {
"type": "string",
"description": "The merchant's bank net value for credorax. Returns false if not configured."
},
"z5Risk": {
"type": "string",
"description": "The merchant's z5 risk value for credorax. Returns false if not configured."
}
}
},
"vantiv": {
"type": "object",
"description": "Feature flags specifically related to the vantiv processor.",
"properties": {
"remainingBalance": {
"type": "string",
"description": "The merchant's remaining balance for vantiv. Returns false if not configured."
}
}
},
"prosa": {
"type": "object",
"description": "Feature flags specifically related to the prosa processor.",
"properties": {
"deferredPayment": {
"type": "boolean",
"description": "Whether or not the merchant has deferred payments enabled for the prosa processor."
}
}
},
"cronopay": {
"type": "object",
"description": "Feature flags specifically related to the cronopay processor.",
"properties": {
"customerId": {
"type": "string",
"description": "The merchant's cronopay customer ID. Returns false if not configured."
}
}
},
"captureHigher": {
"type": "boolean",
"description": "Whether or not the merchant is allowed to capture higher than the preceding auth."
},
"moneris": {
"type": "object",
"description": "Feature flags related specifically to the moneris processor.",
"properties": {
"orderId": {
"type": "string",
"description": "The merchant's order ID for moneris transactions. Returns false if not configured."
}
}
},
"extendedFileBatchResponse": {
"type": "boolean",
"description": "Whether or not the merchant receives and extended file batch response."
},
"credov3": {
"type": "object",
"description": "Feature flags related specifically to the credov3 processor.",
"properties": {
"ignoreAmexCvv": {
"type": "boolean",
"description": "Whether or not the merchant's credov3 processor ignores the Amex CVV field."
}
}
},
"enforceRequiredFieldsForSwiped": {
"type": "boolean",
"description": "Whether or not the merchant must continue to pass required fields when using Swipe."
},
"preventDuplicateCvRecords": {
"type": "boolean",
"description": "Whether or not the merchant is prevented from making duplicate Customer Vault records."
},
"preventConfiguringSurcharge": {
"type": "boolean",
"description": "Whether or not the merchant is prevented from configuring settings for surcharge."
},
"tsys": {
"type": "object",
"description": "Feature flags related specifically to the tsys processor.",
"properties": {
"paymentFacilitatorFields": {
"type": "string",
"description": "The merchant's tsys payment facilitator fields. Returns false if not configured."
},
"allowCustomReport": {
"type": "boolean",
"description": "Whether or not the merchant is allowed to do a custom report with tsys."
},
"alternativePostData": {}
}
},
"requireProcessorFieldOnVt": {
"type": "string",
"description": "Require a processor be specified on all transactions in the Virtual Terminal."
},
"isCardTesting": {
"type": "string",
"description": "Is merchant's card testing."
},
"allowTipOnVtKeyedTransactions": {
"type": "string",
"description": "Allow merchant to enter tips in the virtual terminal on keyed transactions."
},
"transitForceAcceptance": {
"type": "string",
"description": "Merchant is approved for Force Acceptance."
},
"level3": {
"type": "object",
"description": "Merchant's level III template data.",
"properties": {
"autoLoadTemplate": {
"type": "boolean",
"description": "Automatically add my Level III template data to the merchant's credit card transactions."
}
}
},
"emvPartialApprovals": {
"type": "string",
"description": "Allow Merchant to accept Partial Approvals for EMV transactions."
},
"allowOfflineAuths": {
"type": "string",
"description": "Allow merchant to issue Offline/Voice Authorizations."
},
"supportsGooglePay": {
"type": "string",
"description": "Merchant supports Google Pay."
},
"supportsApplePay": {
"type": "string",
"description": "Merchant supports Apple Pay."
},
"isApplePayEnabled": {
"type": "string",
"description": "Is Apple Pay enabled."
},
"useDeviceRecognition": {
"type": "string",
"description": "Enable device recognition for all merchant users when logging into the control panel (users with two-factor enabled are exempt)."
}
}
},
"needsPendingServicesActivated": {
"type": "string",
"description": "Merchant needs pending services activated."
},
"payFacBillingPeriod": {
"type": "string",
"description": "Payment Facilitator Billing Period."
},
"rejectedCertificates": {
"type": "string",
"description": "Number of rejected certificates."
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/nmi-create-merchant-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
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.