API Reference
Explore SandboxPartner PortalMerchant Portal

Create Authorization Transaction

post
https://sandbox.nmi.com/api/v5/payments/auth

Process an authorization transaction. This endpoint authorizes the payment but does not capture it. Use the capture endpoint to capture an authorized transaction.

Body Params
number
required

Total amount to be charged. Format: x.xx

number
≥ 0

Surcharge amount. Format: x.xx

number
≥ 0

Convenience fee amount. Format: x.xx

number
≥ 0

Miscellaneous fee amount. Format: x.xx

string
length ≤ 50

Custom miscellaneous fee name. Default: Miscellaneous Fee

number
≥ 0

The final tip amount, included in the transaction. Format: x.xx

string
length between 3 and 3

The transaction currency. Format: ISO 4217

string
length ≤ 50

If using Multiple MIDs, route to this processor (processor_id is obtained under Settings > Transaction Routing in the Control Panel)

integer
0 to 7862400

Sets the time in seconds for duplicate transaction checking on supported processors. Set to 0 to disable duplicate checking

string
length between 32 and 32

A single use session ID used by Kount to link the transaction and Data Collector information together

boolean

If set to true, when the customer is charged, they will be sent a transaction receipt

boolean

Set to true if you have Pinless Debit Conversion enabled but want to opt out for this transaction

string
enum

Industry type for the transaction

Allowed:
string

Base64 encoded signature image

boolean

Enable network tokenization

string
enum

settle_partial: Settles any amount of tender collected at cut off. payment_in_full: Required that any split tendered transaction is collected in-full before settlement gets initiated

Allowed:
string
length ≤ 50

A numeric identifier which is used when submitting subsequent transactions for partial payments

payment_details
object
required

Payment method details for credit card, ACH, or tokenized payments

billing_address
object

Billing address information for REST API payment transactions

shipping_address
object

Shipping address information for REST API payment transactions

order_details
object

Order details and line items for REST API payment transactions

payment_facilitator
object

Payment facilitator information for submerchant transactions

payment_descriptor
object

Payment descriptor information for transaction statements

cardholder_auth
object

3D Secure cardholder authentication information

merchant_defined_fields
object

Custom fields that can be set up in merchant control panel under Settings->Merchant Defined Fields

customer_vault
object

Customer vault information for storing payment methods

cit_mit
object

Customer Initiated Transaction / Merchant Initiated Transaction information

Responses

401

Unauthorized

Updated about 2 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago