openapi: 3.2.0 info: version: 1.0.0 title: Payments Merchants API description: Our payments platform exposes two generations of API. x-logo: url: https://www.nmi.com/app/themes/nmi/images/NMI_Logo_Primary.webp servers: - url: https://sandbox.nmi.com/api security: [] tags: - name: Merchants paths: /v4/merchants: post: tags: - Merchants operationId: createMerchant security: [] summary: Create Merchant description: 'Usage This step simply creates the merchant account, getting their basic information into the gateway. After this step, you can add processors and value-added services before sending the welcome email to the merchant. Note - you can board merchants under an existing sub-affiliate by providing a `parentAffiliateId` in the create request. This will add the merchant under the specified affiliate instead of the account making the request.' parameters: - $ref: '#/components/parameters/ContentType' - $ref: '#/components/parameters/Authorization' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMerchantRequest' examples: Create Standard Merchant: $ref: '#/components/examples/CreateStandardMerchantRequest' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateMerchantResponse' examples: Create Standard Merchant: $ref: '#/components/examples/CreateStandardMerchantResponse' /v4/merchants/reports: post: tags: - Merchants operationId: getMerchantList security: [] summary: Get Merchant List description: 'Usage This is a query to get all merchant accounts under your partner account.' parameters: - $ref: '#/components/parameters/ContentType' - $ref: '#/components/parameters/Authorization' requestBody: content: application/json: schema: $ref: '#/components/schemas/GetMerchantListRequest' examples: Create Standard Merchant: $ref: '#/components/examples/GetMerchantListExampleRequest' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMerchantListResponse' examples: Create Standard Merchant: $ref: '#/components/examples/GetMerchantListExampleResponse' /v4/merchants/{gateway_id}: patch: summary: Assign Fee Schedule to Merchant / Complete and Send Welcome Email / Agree to… operationId: patch_v4-merchants-gateway-id tags: - Merchants security: [] description: 'Assign a Fee Schedule to the Merchant This can be done when creating the merchant in the first place (1. Create a Merchant) but you can also add it whenever you’d like using the request below. ### Assign Fee Schedule Request Please note this is a `PATCH` request. Attempting a `POST` will result in an error. As noted above, the `costPlan` value can be passed in the initial merchant boarding step if you know what it will be at that point. Complete & Send the Welcome Email This request will complete the merchant creation and send the welcome email to the merchant. `activatePendingServices` is optional, and is the equivalent of checking the “activate pending services immediately” box in the partner portal. ### Complete and Send Welcome Email Request This is a `PATCH` request, not a `POST`. `activatePendingServices` is optional and defaults to false. Note - `agreementTextId` is based on the agreement that is needed to be agreed to. You can pull the correct agreement language with a `/merchants/{id}/agreement_text` request. This will return the id and language that you are agreeing to. Agree to TOS and Fees for Merchant Request ### Agree to TOS and Fees for Merchant Request This is a `PATCH` request, not a `POST`. This request will activate any and all pending service on a merchant account. This is the equivalent of checking the “Activate pending services immediately” box in the partner portal. `agreementTextId` is based on the agreement that is needed to be agreed to. You can pull the correct agreement language with a `/merchants/{id}/agreement_text` request. This will return the id and language that you are agreeing to.' parameters: - $ref: '#/components/parameters/ContentType' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/GatewayId' requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/AssignFeeScheduleToMerchantRequest' - $ref: '#/components/schemas/CompleteAndSendWelcomeEmailRequest' - $ref: '#/components/schemas/AgreeTosAndFeesForMerchantRequest' examples: Add Standard Processor: $ref: '#/components/examples/AssignFeeScheduleToMerchant' Complete and Send Welcome Email: $ref: '#/components/examples/CompleteAndSendWelcomeEmail' Agree to TOS and Fees for a Merchant: $ref: '#/components/examples/AgreeTosAndFeesForMerchantExampleRequest' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssignFeeScheduleToMerchantResponse' examples: Add Standard Processor: $ref: '#/components/examples/AssignFeeScheduleToMerchantExampleResponse' Complete and Send Welcome Email: $ref: '#/components/examples/CompleteAndSendWelcomeEmailExampleResponse' Agree to TOS and Fees for a Merchant: $ref: '#/components/examples/AgreeTosAndFeesForMerchantExampleResponse' get: tags: - Merchants operationId: getSpecificMerchantInformation security: [] summary: Get a Specific Merchant's Information description: 'Usage This request will return all the details of a specific merchant account. If you need to get multiple merchants'' info at once, use the Get Merchant List request.' parameters: - $ref: '#/components/parameters/ContentType' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/GatewayId' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSpecificMerchantInformationResponse' examples: Get a Specific Merchant's Information: $ref: '#/components/examples/GetSpecificMerchantInformationExampleResponse' /v4/merchants/{gateway_id}/security_keys: post: tags: - Merchants operationId: createMerchantKey security: [] summary: Create Merchant API Keys description: 'Usage This request will create a new API key for a user on a merchant account. The request includes all key types, including those for the Payment API, Query API, Collect.js, and Collect Checkout. Sending User ID The `userId` is optional, and will default to the primary user on the account if it is not provided. A full list of user IDs on merchant accounts can be queried via Get Merchant or Partner User Info.' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/GatewayId' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMerchantKeysRequest' examples: Create API Key: $ref: '#/components/examples/CreateAPIKey' Create Collect Checkout Key: $ref: '#/components/examples/CreateCheckoutKey' Create Collect.js Key: $ref: '#/components/examples/CreateCollectJsKey' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateMerchantKeysResponse' examples: Create API Key: $ref: '#/components/examples/CreateAPIKeyResponse' Create Collect Checkout Key: $ref: '#/components/examples/CreateCheckoutKeyResponse' Create Collect.js Key: $ref: '#/components/examples/CreateCollectJsKeyResponse' components: schemas: AssignFeeScheduleToMerchantRequest: title: Assign Fee Schedule to Merchant allOf: - type: object required: - costPlan properties: costPlan: type: string description: Id of the fee schedule. CreateMerchantKeysRequest: title: Create Merchant API Keys allOf: - type: object required: - description - permissions properties: userId: type: string description: The merchant user for whom to generate the API key. Optional and will default to primary user on the account if it is not provided. description: type: string description: Description associated with the new key. permissions: type: array items: type: string enum: - transaction - cart - tokenization - collectCheckout description: '' GetSpecificMerchantInformationResponse: type: object title: Response properties: objectType: type: string enum: - serviceConfig description: The type of object that was returned as a result of the request. id: type: string description: The ID for the transaction. created: type: string format: date-time description: The timestamp indicating when the transaction was created. updated: type: string format: date-time description: The timestamp indicating when the transaction was last updated. 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. 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: type: boolean description: Whether or not the merchant is allowed to add alternative post data with tsys. 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. 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. GetMerchantListRequest: title: Get Merchant List allOf: - type: object required: - maxResults properties: maxResults: type: string description: Required. Value must be between 1-1000. ids: type: array description: An array of merchant ids. items: type: string parentAffiliateId: type: string description: '"parentAffiliateId": "1" // An affiliate id. Only merchants under this affiliate will be returned, rather than the full tree.' type: type: string description: '"type": "gateway" // Only available options are gateway, test, splitFunding, mobile.' search: type: string description: '"search": "Asdf" Performs a search on this text as a case-insensitive search on any of the following: email, company name, first and last name, phone number, external id, or username' offset: type: string description: '"offset": 0 // Like all reports and search endpoints, you can specify the offset, which is the start point for the responses' GetMerchantListResponse: type: object title: Response properties: objectType: type: string enum: - serviceConfig description: The type of object that was returned as a result of the request. reportId: type: number description: The ID of the report. offset: type: number description: The first N skipped results. maxResults: type: number description: The max number results. totalResults: type: number description: The total number of results. hasMore: type: boolean description: If are there more results for the search. links: type: array description: Links for querying results. items: type: object properties: first: type: string description: First page of query results. last: type: string description: Last page of query results. next: type: string description: Next page of current query results. previous: type: string description: Previous page of current query results. results: type: array description: Results for the search. items: type: object properties: objectType: type: string description: Type of the returned response object id: type: string description: The ID for the transaction. created: type: string format: date-time description: The timestamp indicating when the transaction was created. updated: type: string format: date-time description: The timestamp indicating when the transaction was last updated. 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 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: type: boolean description: Whether or not the merchant is allowed to add alternative post data with tsys. 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. 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. CreateMerchantRequest: title: Create a Merchant allOf: - type: object required: - type - company - country - address1 - city - state - zip - timezone - firstName - lastName - email - phone - language - username - accountInfo properties: type: type: string description: The type of merchant account being created. company: type: string description: The merchant's company name. externalIdentifier: type: string description: A description to further describe or identify the merchant country: type: string description: The country associated with the merchant's address 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 url: type: string description: The merchant's website URL timezone: type: string description: The merchant's timezone 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 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 language: type: string description: The merchant's language username: type: string description: The username to be assigned to the primary user account on the merchant accountInfo: type: object description: Banking information for merchant billing required: - checkAccount - checkAba - accountHolderType - accountType properties: checkAccount: type: string description: The account number used to bill the merchant checkAba: type: string description: The routing/ABA number used to bill the merchant accountHolderType: type: string description: The type of holder for the bank account being used accountType: type: string description: The type of bank account being used AssignFeeScheduleToMerchantResponse: type: object title: Response properties: objectType: type: string enum: - merchant description: The type of object that was returned as a result of the request. id: type: integer description: The unique identifier of the processor or service instance added. type: type: string description: The type of the merchant account which the fee scheduled was added to. 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: type: boolean description: Whether or not the merchant is allowed to add alternative post data with tsys. 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. AgreeTosAndFeesForMerchantRequest: title: Agree to the TOS and Fees for a Merchant Request allOf: - type: object required: - activatePendingServices - agreementTextId properties: activatePendingServices: type: boolean description: Boolean representing if the pending services should be activated. agreementTextId: type: string description: String representing the ID of agreement that is needed to be agreeded to. CreateMerchantKeysResponse: type: object title: Response properties: objectType: type: string enum: - securityKey description: The type of object that was created as a result of the request. id: type: string description: The ID of the merchant key that was created. keyText: type: string description: The value of the key to be sent in with API requests or passed into Collect.js. This can be accessed later in the Security Keys section of the Merchant's Settings. userId: type: string description: The merchant user ID associated with the key that was created. description: type: string description: The description assigned to the key. Matches that passed in the request. permissions: type: array items: type: string enum: - transaction - cart - tokenization - collectCheckout description: The permissions assigned to the key. Matches those passed in the request except that `tokenization` will be added to `collectCheckout` keys automatically. CreateMerchantResponse: type: object title: Response 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. CompleteAndSendWelcomeEmailRequest: title: Complete & Send the Welcome Email allOf: - type: object required: - status - agreementTextId properties: status: type: string description: Status of the merchant activatePendingServices: type: boolean description: Whether to activate the pending services or not. agreementTextId: type: string description: Id of the agreement text. examples: CreateStandardMerchantResponse: summary: Create Standard Merchant Response description: Creates a merchant value: objectType: merchant id: '1587' type: gateway created: '2022-09-26T13:20:03+00:00' updated: '2022-09-26T13:20:03+00:00' firstName: Jane lastName: Doe company: ACME, Inc. email: someone@example.com phone: 555-555-5555 fax: 123-456-7890 url: '' address1: 123 Fake St. address2: Unit 101 city: Chicago state: IL zip: '60601' country: US timezone: America/Chicago costPlan: null status: pending externalIdentifier: A Company That Makes Everything lastTransactionDate: null parentAffiliateId: '1' accountInfo: checkAba: '123123123' checkAccount: '*****3123' accountType: checking accountHolderType: business features: forceTos: true forceBillingAuth: true allowBlindCredits: false allowBlindCheckCredits: false advancedTransactionRouting: false sendBillingEmail: false braspag: advancedTransactionRouting: false verifi: enabled: false viewBillingStatement: false litle: reportGroup: false prePaidIndicator: false affluentIndicator: false recycleAdvice: false campaign: false affiliate: false merchantGroupId: false allowEmptyCcExp: false pastDue: false apiReceipt: false batchReceipt: false delinquent: false commercialCardIndicator: false customDescriptor: false apiAllowOnlyUsername: false orderIdDuplicateCheck: false cardLevelResult: false pmsalem: ignoreAmexCvv: false allowNovusVerify: false idInMdf11: false credorax: bankNet: false z5Risk: false vantiv: remainingBalance: false prosa: deferredPayment: false cronopay: customerId: false captureHigher: false moneris: orderId: false extendedFileBatchResponse: false credov3: ignoreAmexCvv: false enforceRequiredFieldsForSwiped: false preventDuplicateCvRecords: false preventConfiguringSurcharge: false tsys: paymentFacilitatorFields: false allowCustomReport: false alternativePosData: false requireProcessorFieldOnVt: false isCardTesting: false allowTipOnVtKeyedTransactions: false transitForceAcceptance: false level3: autoLoadTemplate: false emvPartialApprovals: false allowOfflineAuths: false supportsGooglePay: false supportsApplePay: false isApplePayEnabled: false useDeviceRecognition: false needsPendingServicesActivated: true payFacBillingPeriod: monthly rejectedCertificates: '0' GetSpecificMerchantInformationExampleResponse: summary: Get a Specific Merchant's Information Response description: Gets a specific merchant's information value: objectType: merchant id: '3465345' type: gateway created: '2011-02-04T12:17:17+00:00' updated: '2012-04-23T15:36:59+00:00' firstName: John lastName: Doe company: ACME, Inc. email: someone@example.com phone: 555-555-5555 fax: '' url: https://acme.com address1: 123 Main St address2: '' city: Chicago state: IL zip: '60601' country: US timezone: America/Chicago costPlan: '4' status: active externalIdentifier: '' lastTransactionDate: null parentAffiliateId: '2' accountInfo: checkAba: '490000018' checkAccount: '*****6789' accountType: checking accountHolderType: personal features: forceTos: false forceBillingAuth: false allowBlindCredits: false allowBlindCheckCredits: false advancedTransactionRouting: false sendBillingEmail: true braspag: advancedTransactionRouting: false verifi: enabled: false viewBillingStatement: true litle: reportGroup: false prePaidIndicator: false affluentIndicator: false recycleAdvice: false campaign: false affiliate: false merchantGroupId: false allowEmptyCcExp: false pastDue: false apiReceipt: false batchReceipt: false delinquent: false commercialCardIndicator: false customDescriptor: false apiAllowOnlyUsername: false orderIdDuplicateCheck: false cardLevelResult: false pmsalem: ignoreAmexCvv: false allowNovusVerify: false idInMdf11: false credorax: bankNet: false z5Risk: false vantiv: remainingBalance: false prosa: deferredPayment: false cronopay: customerId: false captureHigher: false moneris: orderId: false extendedFileBatchResponse: false credov3: ignoreAmexCvv: false enforceRequiredFieldsForSwiped: false preventDuplicateCvRecords: false preventConfiguringSurcharge: false tsys: paymentFacilitatorFields: false allowCustomReport: false alternativePosData: false requireProcessorFieldOnVt: false isCardTesting: false allowTipOnVtKeyedTransactions: false transitForceAcceptance: false level3: autoLoadTemplate: false emvPartialApprovals: false supportsGooglePay: false supportsApplePay: false isApplePayEnabled: false useDeviceRecognition: false needsPendingServicesActivated: true payFacBillingPeriod: monthly rejectedCertificates: '0' AgreeTosAndFeesForMerchantExampleResponse: summary: Agree to TOS and Fees for a Merchant description: Agree to TOS and Fees for a Merchant. value: objectType: merchant id: '5' type: gateway created: '2007-03-20T21:19:48+00:00' updated: '2007-03-20T21:21:23+00:00' firstName: Essy lastName: Smith company: ACME, Inc. email: someone@acme.com phone: 555-555-5555 fax: 555-555-5556 url: '' address1: 123 Main St address2: '' city: Beverly Hills state: CA zip: '90210' country: US timezone: America/New_York costPlan: '2' status: active externalIdentifier: '' lastTransactionDate: null parentAffiliateId: '1' accountInfo: checkAba: '123123123' checkAccount: '*****9999' accountType: checking accountHolderType: personal features: forceTos: false forceBillingAuth: false allowBlindCredits: false allowBlindCheckCredits: false advancedTransactionRouting: false sendBillingEmail: false braspag: advancedTransactionRouting: false verifi: enabled: false viewBillingStatement: false litle: reportGroup: false prePaidIndicator: false affluentIndicator: false recycleAdvice: false campaign: false affiliate: false merchantGroupId: false allowEmptyCcExp: false pastDue: false apiReceipt: false batchReceipt: false delinquent: false commercialCardIndicator: false customDescriptor: false apiAllowOnlyUsername: false orderIdDuplicateCheck: false cardLevelResult: false pmsalem: ignoreAmexCvv: false allowNovusVerify: false idInMdf11: false credorax: bankNet: false z5Risk: false vantiv: remainingBalance: false prosa: deferredPayment: false cronopay: customerId: false captureHigher: false moneris: orderId: false extendedFileBatchResponse: false credov3: ignoreAmexCvv: false enforceRequiredFieldsForSwiped: false preventDuplicateCvRecords: false preventConfiguringSurcharge: false tsys: paymentFacilitatorFields: false allowCustomReport: false alternativePosData: false requireProcessorFieldOnVt: false isCardTesting: false allowTipOnVtKeyedTransactions: false transitForceAcceptance: false level3: autoLoadTemplate: false emvPartialApprovals: false allowOfflineAuths: false supportsGooglePay: false supportsApplePay: false isApplePayEnabled: false useDeviceRecognition: false canViewCheckoutThemingImages: false needsPendingServicesActivated: false payFacBillingPeriod: monthly rejectedCertificates: '0' CreateAPIKey: summary: Create API Key description: Creates a merchant key for use with various APIs value: userId: '123456' description: Key for API Access permissions: - transaction GetMerchantListExampleResponse: summary: Get Merchant List Response description: Gets merchant list value: objectType: report reportId: 34567345 offset: null maxResults: 100 totalResults: 43 hasMore: false links: first: https://sandbox.nmi.com/api/v4/merchants/reports/34567345?maxResults=100 last: https://sandbox.nmi.com/api/v4/merchants/reports/34567345?offset=0&maxResults=100 next: https://sandbox.nmi.com/api/v4/merchants/reports/34567345?offset=100&maxResults=100 previous: https://sandbox.nmi.com/api/v4/merchants/reports/34567345?offset=0&maxResults=100 results: - objectType: merchant id: '3465345' type: gateway created: '2011-02-04T12:17:17+00:00' updated: '2012-04-23T15:36:59+00:00' firstName: John lastName: Doe company: ACME, Inc. email: someone@example.com phone: 555-555-5555 fax: '' url: https://acme.com address1: 123 Main St address2: '' city: Chicago state: IL zip: '60601' country: US timezone: America/Chicago costPlan: '4' status: active externalIdentifier: '' lastTransactionDate: null parentAffiliateId: '2' accountInfo: checkAba: '490000018' checkAccount: '*****6789' accountType: checking accountHolderType: personal features: forceTos: false forceBillingAuth: false allowBlindCredits: false allowBlindCheckCredits: false advancedTransactionRouting: false sendBillingEmail: true braspag: advancedTransactionRouting: false verifi: enabled: false viewBillingStatement: true litle: reportGroup: false prePaidIndicator: false affluentIndicator: false recycleAdvice: false campaign: false affiliate: false merchantGroupId: false allowEmptyCcExp: false pastDue: false apiReceipt: false batchReceipt: false delinquent: false commercialCardIndicator: false customDescriptor: false apiAllowOnlyUsername: false orderIdDuplicateCheck: false cardLevelResult: false pmsalem: ignoreAmexCvv: false allowNovusVerify: false idInMdf11: false credorax: bankNet: false z5Risk: false vantiv: remainingBalance: false prosa: deferredPayment: false cronopay: customerId: false captureHigher: false moneris: orderId: false extendedFileBatchResponse: false credov3: ignoreAmexCvv: false enforceRequiredFieldsForSwiped: false preventDuplicateCvRecords: false preventConfiguringSurcharge: false tsys: paymentFacilitatorFields: false allowCustomReport: false alternativePosData: false requireProcessorFieldOnVt: false isCardTesting: false allowTipOnVtKeyedTransactions: false transitForceAcceptance: false level3: autoLoadTemplate: false emvPartialApprovals: false supportsGooglePay: false supportsApplePay: false isApplePayEnabled: false useDeviceRecognition: false needsPendingServicesActivated: true payFacBillingPeriod: monthly rejectedCertificates: '0' CreateCheckoutKeyResponse: summary: Create Collect Checkout Key description: Creates a merchant key for use with Collect Checkout (includes Collect.js permissions automatically). value: objectType: securityKey id: '9999' keyText: 4b147dfe38654d02809475c9fd53a609 userId: '123456' description: Key for Collect Checkout Access permissions: - collectCheckout - tokenization CreateCheckoutKey: summary: Create Collect Checkout Key description: Creates a merchant key for use with Collect Checkout (includes Collect.js permissions automatically). value: userId: '123456' description: Key for Collect Checkout Access permissions: - collectCheckout CreateStandardMerchantRequest: summary: Create Gateway Merchant description: Creates a standard gateway account for a new merchant value: type: gateway company: ACME, Inc. externalIdentifier: A Company That Makes Everything country: US address1: 123 Fake St. address2: Unit 101 city: Chicago state: IL zip: '60601' url: '' timezone: America/Chicago firstName: Jane lastName: Doe email: someone@example.com phone: 555-555-5555 fax: 123-456-7890 language: en_US username: '{{your_username}}' accountInfo: checkAccount: '123123123' checkAba: '123123123' accountHolderType: business accountType: checking AssignFeeScheduleToMerchantExampleResponse: summary: Assign Fee Schedule to Merchant description: Since this is an update to an existing merchant, we return the `merchant` object, and you can confirm your change was successful by looking at the `costPlan` value in this response. value: objectType: merchant id: '1586' type: gateway created: '2022-09-27T15:50:44+00:00' updated: '2022-09-27T16:38:09+00:00' firstName: Jane lastName: Doe company: ACME Inc email: someone@example.com phone: 5655-555-555 fax: '' url: '' address1: 123 Fake St address2: '' city: Chicago state: IL zip: '60601' country: US timezone: America/Chicago costPlan: '2' status: pending externalIdentifier: '' lastTransactionDate: null parentAffiliateId: '1' accountInfo: checkAba: '123123123' checkAccount: '*****3123' accountType: checking accountHolderType: business features: forceTos: true forceBillingAuth: true allowBlindCredits: false allowBlindCheckCredits: false advancedTransactionRouting: false sendBillingEmail: false braspag: advancedTransactionRouting: false verifi: enabled: false viewBillingStatement: false litle: reportGroup: false prePaidIndicator: false affluentIndicator: false recycleAdvice: false campaign: false affiliate: false merchantGroupId: false allowEmptyCcExp: false pastDue: false apiReceipt: false batchReceipt: false delinquent: false commercialCardIndicator: false customDescriptor: false apiAllowOnlyUsername: false orderIdDuplicateCheck: false cardLevelResult: false pmsalem: ignoreAmexCvv: false allowNovusVerify: false idInMdf11: false credorax: bankNet: false z5Risk: false vantiv: remainingBalance: false prosa: deferredPayment: false cronopay: customerId: false captureHigher: false moneris: orderId: false extendedFileBatchResponse: false credov3: ignoreAmexCvv: false enforceRequiredFieldsForSwiped: false preventDuplicateCvRecords: false preventConfiguringSurcharge: false tsys: paymentFacilitatorFields: false allowCustomReport: false alternativePosData: false requireProcessorFieldOnVt: false isCardTesting: false allowTipOnVtKeyedTransactions: false transitForceAcceptance: false level3: autoLoadTemplate: false emvPartialApprovals: false allowOfflineAuths: false supportsGooglePay: false supportsApplePay: false isApplePayEnabled: false useDeviceRecognition: false needsPendingServicesActivated: true payFacBillingPeriod: monthly rejectedCertificates: '0' CreateCollectJsKeyResponse: summary: Create Collect.js Key description: Creates a merchant key for use with Collect.js only. value: objectType: securityKey id: '9999' keyText: 4b147dfe38654d02809475c9fd53a609 userId: '123456' description: Key for Collect.js Access permissions: - tokenization AgreeTosAndFeesForMerchantExampleRequest: summary: Agree to TOS and Fees for a Merchant description: '`agreementTextId` is based on the agreement that is needed to be agreed to. You can pull the correct agreement language with a `/merchants/{id}/agreement_text` request. This will return the id and language that you are agreeing to.' value: activatePendingServices: true agreementTextId: '11' CompleteAndSendWelcomeEmail: summary: Complete & Send the Welcome Email description: Completes the merchant creation and send the welcome email to the merchant. value: status: active activatePendingServices: true agreementTextId: '11' AssignFeeScheduleToMerchant: summary: Assign Fee Schedule description: Assigns a Fee Schedule to a Merchant. value: costPlan: 25730 GetMerchantListExampleRequest: summary: Get Merchant List description: Get list of merchants value: maxResults: 1000 CompleteAndSendWelcomeEmailExampleResponse: summary: Complete & Send the Welcome Email description: Since this is an update to an existing merchant, we return the merchant object. value: objectType: merchant id: '1586' type: gateway created: '2022-09-27T15:50:44+00:00' updated: '2022-09-27T16:38:09+00:00' firstName: Jane lastName: Doe company: ACME Inc email: someone@example.com phone: 5655-555-555 fax: '' url: '' address1: 123 Fake St address2: '' city: Chicago state: IL zip: '60601' country: US timezone: America/Chicago costPlan: '2' status: pending externalIdentifier: '' lastTransactionDate: null parentAffiliateId: '1' accountInfo: checkAba: '123123123' checkAccount: '*****3123' accountType: checking accountHolderType: business features: forceTos: true forceBillingAuth: true allowBlindCredits: false allowBlindCheckCredits: false advancedTransactionRouting: false sendBillingEmail: false braspag: advancedTransactionRouting: false verifi: enabled: false viewBillingStatement: false litle: reportGroup: false prePaidIndicator: false affluentIndicator: false recycleAdvice: false campaign: false affiliate: false merchantGroupId: false allowEmptyCcExp: false pastDue: false apiReceipt: false batchReceipt: false delinquent: false commercialCardIndicator: false customDescriptor: false apiAllowOnlyUsername: false orderIdDuplicateCheck: false cardLevelResult: false pmsalem: ignoreAmexCvv: false allowNovusVerify: false idInMdf11: false credorax: bankNet: false z5Risk: false vantiv: remainingBalance: false prosa: deferredPayment: false cronopay: customerId: false captureHigher: false moneris: orderId: false extendedFileBatchResponse: false credov3: ignoreAmexCvv: false enforceRequiredFieldsForSwiped: false preventDuplicateCvRecords: false preventConfiguringSurcharge: false tsys: paymentFacilitatorFields: false allowCustomReport: false alternativePosData: false requireProcessorFieldOnVt: false isCardTesting: false allowTipOnVtKeyedTransactions: false transitForceAcceptance: false level3: autoLoadTemplate: false emvPartialApprovals: false allowOfflineAuths: false supportsGooglePay: false supportsApplePay: false isApplePayEnabled: false useDeviceRecognition: false needsPendingServicesActivated: true payFacBillingPeriod: monthly rejectedCertificates: '0' CreateAPIKeyResponse: summary: Create API Key description: Creates a merchant key for use with various APIs value: objectType: securityKey id: '9999' keyText: 4b147dfe38654d02809475c9fd53a609 userId: '123456' description: Key for API Access permissions: - transaction CreateCollectJsKey: summary: Create Collect.js Key description: Creates a merchant key for use with Collect.js only. value: userId: '123456' description: Key for Collect.js Access permissions: - tokenization parameters: GatewayId: name: gateway_id in: path required: true schema: type: string description: The merchant ID that the request should operate on. ContentType: name: Content-Type in: header required: true schema: type: string description: The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending). example: application/json Authorization: name: Authorization in: header required: true schema: type: string description: Your v4 API key that was generated in the Partner portal. securitySchemes: merchantApiKey: type: apiKey in: header name: Authorization description: Merchant API key for RESTful API authentication. This key is used for merchant-specific API access and can be generated from the merchant portal. externalDocs: url: https://www.postman.com/nmi-integration-support/workspace/nmi-public-documentation/request/5480015-f4b0ec7b-bd84-4094-98c2-67c0b6508a7f description: Public Documentation (Postman) x-tagGroups: - name: REST API (recommended) tags: - Payments - Plans - Subscriptions - Products - Invoicing - Customers - Devices - name: Classic API tags: - Payment Processing - Data and Transaction Reporting - Webhook Events - Gateway Features - Processors and Services - Apple Pay x-provenance: method: searched source: https://docs.nmi.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://docs.nmi.com/reference/add-billing-address-v5.md - https://docs.nmi.com/reference/add-processor-service.md - https://docs.nmi.com/reference/add-shipping-address-v5.md - https://docs.nmi.com/reference/adding-apple-pay.md - https://docs.nmi.com/reference/cancel-device-display-v5.md - https://docs.nmi.com/reference/cancel-device-payment-request-v5.md - https://docs.nmi.com/reference/capture-payment-v5.md - https://docs.nmi.com/reference/card-type.md - https://docs.nmi.com/reference/check-services.md - https://docs.nmi.com/reference/check-username-availability.md - https://docs.nmi.com/reference/close-invoice-v5.md - https://docs.nmi.com/reference/create-auth-v5.md - https://docs.nmi.com/reference/create-credit-v5.md - https://docs.nmi.com/reference/create-customer-v5.md - https://docs.nmi.com/reference/create-device-payment-request-auth-v5.md - https://docs.nmi.com/reference/create-device-payment-request-credit-v5.md - https://docs.nmi.com/reference/create-device-payment-request-sale-v5.md - https://docs.nmi.com/reference/create-device-payment-request-validate-v5.md - https://docs.nmi.com/reference/create-invoice-v5.md - https://docs.nmi.com/reference/create-merchant-key.md - https://docs.nmi.com/reference/create-merchant.md - https://docs.nmi.com/reference/create-plan-v5.md - https://docs.nmi.com/reference/create-product-v5.md - https://docs.nmi.com/reference/create-sale-v5.md - https://docs.nmi.com/reference/create-subscription-v5.md - https://docs.nmi.com/reference/delete-billing-address-v5.md - https://docs.nmi.com/reference/delete-customer-v5.md - https://docs.nmi.com/reference/delete-plan-v5.md - https://docs.nmi.com/reference/delete-product-v5.md - https://docs.nmi.com/reference/delete-shipping-address-v5.md - https://docs.nmi.com/reference/delete-subscription-v5.md - https://docs.nmi.com/reference/deregister-device-v5.md - https://docs.nmi.com/reference/display-device-qr-code-v5.md - https://docs.nmi.com/reference/get-billing-address-v5.md - https://docs.nmi.com/reference/get-customer-v5.md - https://docs.nmi.com/reference/get-device-payment-request-status-v5.md - https://docs.nmi.com/reference/get-device-prompt-menu-status-v5.md - https://docs.nmi.com/reference/get-device-prompt-sign-status-v5.md - https://docs.nmi.com/reference/get-device-prompt-yes-no-status-v5.md - https://docs.nmi.com/reference/get-device-v5.md - https://docs.nmi.com/reference/get-fees-in-schedule.md - https://docs.nmi.com/reference/get-invoice-v5.md - https://docs.nmi.com/reference/get-merchant-list.md - https://docs.nmi.com/reference/get-merchant-partner-user-info.md - https://docs.nmi.com/reference/get-merchant-processors-value-added-services.md - https://docs.nmi.com/reference/get-payment-v5.md - https://docs.nmi.com/reference/get-plan-v5.md - https://docs.nmi.com/reference/get-processor-config.md - https://docs.nmi.com/reference/get-product-v5.md - https://docs.nmi.com/reference/get-settlement-time.md - https://docs.nmi.com/reference/get-shipping-address-v5.md - https://docs.nmi.com/reference/get-specific-merchant-information.md - https://docs.nmi.com/reference/get-sub-affiliate-list.md - https://docs.nmi.com/reference/get-subscription-v5.md - https://docs.nmi.com/reference/get-transaction-data.md - https://docs.nmi.com/reference/list-customers-v5.md - https://docs.nmi.com/reference/list-devices-v5.md - https://docs.nmi.com/reference/list-invoices-v5.md - https://docs.nmi.com/reference/list-plans-v5.md - https://docs.nmi.com/reference/list-products-v5.md - https://docs.nmi.com/reference/list-subscriptions-v5.md - https://docs.nmi.com/reference/patch_v4-merchants-gateway-id-1.md - https://docs.nmi.com/reference/prompt-device-menu-v5.md - https://docs.nmi.com/reference/prompt-device-sign-v5.md - https://docs.nmi.com/reference/prompt-device-yes-no-v5.md - https://docs.nmi.com/reference/pull-all-fee-schedules.md - https://docs.nmi.com/reference/query.md - https://docs.nmi.com/reference/querying-merchants-apple-pay-status.md - https://docs.nmi.com/reference/refund-payment-v5.md - https://docs.nmi.com/reference/register-device-v5.md - https://docs.nmi.com/reference/see-merchant-billing.md - https://docs.nmi.com/reference/see-your-commission.md - https://docs.nmi.com/reference/send-invoice-v5.md - https://docs.nmi.com/reference/update-billing-address-v5.md - https://docs.nmi.com/reference/update-customer-v5.md - https://docs.nmi.com/reference/update-device-v5.md - https://docs.nmi.com/reference/update-invoice-v5.md - https://docs.nmi.com/reference/update-plan-v5.md - https://docs.nmi.com/reference/update-product-v5.md - https://docs.nmi.com/reference/update-shipping-address-v5.md - https://docs.nmi.com/reference/update-subscription-v5.md - https://docs.nmi.com/reference/updating-settlement-time.md - https://docs.nmi.com/reference/validate-payment-v5.md - https://docs.nmi.com/reference/void-payment-v5.md merge: pages: 84 deduped: 4356 conflicts_kept_first: 0