Sale

post

https://sandbox.nmi.com/api/v5/payments/sale

Process a sale. This request authorizes and captures the payment in a single step.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

number

required

Total amount to be charged. Format: x.xx

surcharge

number

≥ 0

Surcharge amount. Format: x.xx

convenience_fee

number

≥ 0

Convenience fee amount. Format: x.xx

misc_fee

number

≥ 0

Miscellaneous fee amount. Format: x.xx

misc_fee_name

string

length ≤ 50

Custom miscellaneous fee name. Default: Miscellaneous Fee

tip

number

≥ 0

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

currency

string

length between 3 and 3

The ISO 4217 currency code. Example: USD

processor_id

string

length ≤ 50

If using multiple processors, route to the specified processor ID. Omit for default processor or when using a single processor.

dup_seconds

integer

0 to 7862400

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

transaction_session_id

string

length between 32 and 32

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

customer_receipt

boolean

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

pinless_debit_override

boolean

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

industry

string

enum

Industry type for the payment

Allowed:

signature_image

string

Base64 encoded signature image

network_tokenize

boolean

Enable network tokenization

partial_payments

string

enum

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

Allowed:

partial_payment_id

string

length ≤ 50

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

payment_details

required

Payment method details. Exactly one variant: raw card data, ACH (check) data, payment_token, Apple Pay encrypted payload, or Google Pay encrypted payload. Do not combine fields from different variants.

billing_address

object

Billing address and information

shipping_address

object

Shipping address and information

order_details

object

Order details and line items

payment_facilitator

object

Payment facilitator information for submerchant transactions

payment_descriptor

object

Payment descriptor information for transaction statements

cardholder_auth

Cardholder authentication data. Use the 3-D Secure variant for EMV authentication results. Use the Decrypted wallet variant for merchant-decrypted Apple Pay or Google Pay, which relays the cryptogram and ECI to the 3-D Secure fields.

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

Credential on File information

Responses

401

Unauthorized

200Success

400Bad Request - Validation Error