NMnmi
Payments

Refund

Refund a payment. Only a previously settled transaction can be refunded back to the customer's payment method.

post/v5/payments/{payment_id}/refund

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v5/payments/{payment_id}/refund
  • Auth
    API key in header Authorization

Path parameters

payment_idstring required

The payment ID to refund

Request body

amountnumber

Total amount to be refunded. This amount may be equal to or less than the settled amount. Setting the amount to 0.00 will refund the entire amount. Format: x.xx

payment'check' | 'creditcard'

The type of payment. Default - creditcard. Required for ACH

Response

Success

object'transaction' required

Resource type identifier

idstring required

Payment ID

typestring

Customer's payment type (e.g., 'cc', 'ck', 'cs')

amountstring

Payment amount. Format: x.xx

currencystring

Payment currency (ISO 4217)

auth_codestring

Authorization code

avs_responsestring

Address Verification Service response code

cvv_responsestring

Card Verification Value response

customer_vault_idstring

Customer vault ID associated with the payment

statusstring

Payment status

response'1' | '2' | '3'

Response code: 1 = approved, 2 = declined, 3 = error

response_textstring

Textual description of the operation's result

response_codestring

Processor response code

processor_idstring

Processor ID used for the payment

created_datestring date-time

Payment creation date in UTC ISO 8601 format

updated_datestring date-time

Payment last update date in UTC ISO 8601 format

signature_imagestring

Base64 encoded cardholder signature image. Omitted when no signature was captured. Returned on get and list when the payment was loaded with signature data.

Changes

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