NMnmi
Gateway Features
Settlement Time

Updating Settlement Time

<details> <summary>Usage</summary> This can be done when creating the merchant’s processor in the first place (<a href="../reference/addprocessorservice" title="Add Processors">Add Processors</a>) but you can also update it whenever you’d like using the request below. Please note this is a PATCH request. Attempting a POST will result in an error. The date must be a valid ISO 8601 time string (Example: 13:14:15). Since this is an update to an existing merchant’s processor, we return the processor object, and you can confirm your change was successful by looking at the settlementTime value in this response. </details>
patch/v4/processors/{id}

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v4/processors/{id}
  • Auth
    none required

Path parameters

idstring required

The ID that the request should operate on.

Headers

Content-Typestring required

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

Authorizationstring required

Your v4 API key that was generated in the Partner portal.

Request body

settlementTimestring required

Required. Specifies the time at which the settlement process will be executed following a successful update. This value determines when the settlement operations will occur.

Response

Success

objectTypestring

The type of object that was returned as a result of the request.

idnumber

The ID of the request.

processorTypestring

The type of payment processor.

processorIdstring

The ID of the processor.

processorNamestring

The name of the processor.

serviceIdstring

The ID of the processor platform.

merchantIdnumber

The ID of the merchant.

mccstring

The Merchant Category Code.

accountClassificationstring

The processor account classification.

maxTicketAmountstring

The maximum amount for a single transaction run through the added processor.

maxMonthlyVolumestring

The maximum total amount that can be run through the processor in a single month.

applyToAllCardTypeboolean

Whether the maxMonthlyVolume and maxTicketAmount apply to all payment methods through the added processor or not.

enableDuplicateCheckingboolean

Whether duplicate checking is enabled or not.

allowMerchantOverrideboolean

Whether the merchant is allowed to ignore the duplicate check on a per-transaction basis or not.

duplicateTimestring

The amount of time in seconds to look back to check if a transaction is a duplicate.

status'active' | 'pending'

The status of the added processor or service, depending on the processor/billing authorization status.

condition'offered' | 'notOffered' | 'mandatory'

The condition of the added processor or service.

extraDetailsobject

Any extra details about the added processor.

freeTrialEndDatestring

End date of free trial.

freeTrialDaysLeftstring

Days left of free trial.

hasBeenActiveboolean

Whether the processor has been active before or not.

createdstring

The date and time of when the processor or service was added.

updatedstring

The date and time of when the processor or service was last updated.

supportsReroutedRefundsboolean

Whether the added processor supports rerouted refunds or not.

shouldDisableFieldsboolean

Whether the added processor should disable fields or not.

disabledboolean

Whether the processor is disabled or not.

refundProcessorstring

The specified processor to reroute future refunds to, if this processor is disabled.

billingTypestring

The billing type of the added processor or service.

avsCvvPreCheckstring

The AVS/CVV precheck method for the added processor.

skipAvsCvvboolean

Whether skipping AVS/CVV is enabled for the added processor or not.

processorFieldsobject

The processor-dependent fields for the added processor.

paymentTypesstring[]

The allowed payment types for the added processor.

currenciesstring[]

The allowed currencies for the added processor.

faceConfigurationobject

The FACe configuration for the added processor.

settlementTimestring

Specifies the time at which the settlement process will be executed following a successful update. This value determines when the settlement operations will occur.

Changes

No recorded changes to this operation across all 1 revision of this API.