Classic: Billing address management
POST /transact.php · Billing address management
Classic protocol
This family uses POST /transact.php under the documented sandbox base https://sandbox.nmi.com/api. Send application/x-www-form-urlencoded fields with the private security_key on your server. Do not substitute a REST JSON body or REST Authorization header. Each named variant below has its own action selector and required fields. For maintenance of a Classic integration. Source examples are fixtures, not live credentials; replace their security_key before any authorized test. This reference sends no requests.
Choose the operation variant
Variant Selector fields Required fields CreateBilling UpdateBilling DeleteBilling customer_vault=["delete_billing"] customer_vault, customer_vault_id, billing_id, security_key
Request language templates
Original transport templates derived from this endpoint’s documented method, server, authentication and media type. Replace path/query/credential placeholders with authorized sandbox values. These examples print the raw status and response; they do not infer business success or retry a request. Save properly URL-encoded name=value pairs for your selected operation as request.form, including its private security_key when required. JSON example objects below describe these form fields; they are not the wire encoding. Node requires a runtime with fetch; PHP requires cURL. Generated source-based examples have not been executed against provider accounts. curl --request POST \ --url 'https://sandbox.nmi.com/api/transact.php' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-binary '@request.form' import { readFile } from 'node:fs/promises'; const body = await readFile('request.form', 'utf8'); const response = await fetch("https://sandbox.nmi.com/api/transact.php", { method: 'POST', headers: { "Content-Type": "application/x-www-form-urlencoded" }, body }); console.log(response.status, await response.text()); from urllib.request import Request, urlopen from urllib.error import HTTPError from pathlib import Path request = Request('https://sandbox.nmi.com/api/transact.php', method='POST', headers={'Content-Type': 'application/x-www-form-urlencoded'}, data=Path('request.form').read_bytes()) try: with urlopen(request, timeout=30) as response: print(response.status, response.read().decode()) except HTTPError as error: print(error.code, error.read().decode()) require 'net/http' require 'uri' uri = URI("https://sandbox.nmi.com/api/transact.php") request = Net::HTTP::Post.new(uri) request["Content-Type"] = "application/x-www-form-urlencoded" request.body = File.binread('request.form') response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https', read_timeout: 30) { |http| http.request(request) } puts response.code puts response.body <?php $curl = curl_init('https://sandbox.nmi.com/api/transact.php'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 30, CURLOPT_HTTPHEADER => ['Content-Type: application/x-www-form-urlencoded'], CURLOPT_POSTFIELDS => file_get_contents('request.form') ]); $response = curl_exec($curl); if ($response === false) { throw new RuntimeException(curl_error($curl)); } echo curl_getinfo($curl, CURLINFO_HTTP_CODE), PHP_EOL, $response; curl_close($curl);
Request fields
Choose one schema variant. Descriptions retain conditional requirements that are not always included in required arrays. Do not merge all variants into one request. Field Type Required Description Constraints [oneOf 1].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 1].[allOf 1].customer_vault string yes Create a billing record for the given Customer Vault record. enum: ["add_billing"] [oneOf 1].[allOf 1].customer_vault_id string yes Specifies a Customer Vault id. [oneOf 1].[allOf 1].billing_id string no Specifies a billing id. [oneOf 1].[allOf 2].ccnumber string no Credit card number. <details> <summary>Allowed Card Numbers:</summary> | Card Type | Test Card Number | |:------------------|:---------------------| | Visa | 4111111111111111 | | MasterCard | 5431111111111111 | | Discover | 6011000991300009 | | American Express | 341111111111111 | | Diner's Club | 30205252489926 | | JCB | 3541963594572595 | | Maestro | 6799990100000000019 | </details> enum: ["4111111111111111", "5431111111111111", "6011000991300009", "341111111111111", "30205252489926", "3541963594572595", "6799990100000000019"] [oneOf 1].[allOf 2].ccexp string no Credit card expiration date. Format: `MMYY` [oneOf 1].[allOf 3].first_name string no Cardholder's first name. [oneOf 1].[allOf 3].last_name string no Cardholder's last name. [oneOf 1].[allOf 3].address1 string no Card billing address. [oneOf 1].[allOf 3].city string no Card billing city [oneOf 1].[allOf 3].state string no Card billing state. Format: `CC` [oneOf 1].[allOf 3].zip string no Card billing postal code. [oneOf 1].[allOf 3].country string no Card billing country code. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 1].[allOf 3].phone string no Billing phone number. [oneOf 1].[allOf 3].email string no Billing email address. [oneOf 1].[allOf 3].company string no Cardholder's company. [oneOf 1].[allOf 3].address2 string no Card billing address, line 2. [oneOf 1].[allOf 3].fax string no Billing fax number. [oneOf 2].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 2].[allOf 1].customer_vault string yes Update a billing record for the given Customer Vault record. enum: ["update_billing"] [oneOf 2].[allOf 1].customer_vault_id string yes Specifies a Customer Vault id. [oneOf 2].[allOf 1].billing_id string yes Specifies a billing id. If not set [oneOf 2].[allOf 2].ccnumber string no Credit card number. <details> <summary>Allowed Card Numbers:</summary> | Card Type | Test Card Number | |:------------------|:---------------------| | Visa | 4111111111111111 | | MasterCard | 5431111111111111 | | Discover | 6011000991300009 | | American Express | 341111111111111 | | Diner's Club | 30205252489926 | | JCB | 3541963594572595 | | Maestro | 6799990100000000019 | </details> enum: ["4111111111111111", "5431111111111111", "6011000991300009", "341111111111111", "30205252489926", "3541963594572595", "6799990100000000019"] [oneOf 2].[allOf 2].ccexp string no Credit card expiration date. Format: `MMYY` [oneOf 2].[allOf 3].first_name string no Cardholder's first name. [oneOf 2].[allOf 3].last_name string no Cardholder's last name. [oneOf 2].[allOf 3].address1 string no Card billing address. [oneOf 2].[allOf 3].city string no Card billing city [oneOf 2].[allOf 3].state string no Card billing state. Format: `CC` [oneOf 2].[allOf 3].zip string no Card billing postal code. [oneOf 2].[allOf 3].country string no Card billing country code. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 2].[allOf 3].phone string no Billing phone number. [oneOf 2].[allOf 3].email string no Billing email address. [oneOf 2].[allOf 3].company string no Cardholder's company. [oneOf 2].[allOf 3].address2 string no Card billing address, line 2. [oneOf 2].[allOf 3].fax string no Billing fax number. [oneOf 3].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 3].customer_vault string yes Delete a billing record for the given Customer Vault record. enum: ["delete_billing"] [oneOf 3].customer_vault_id string yes Specifies a Customer Vault id. [oneOf 3].billing_id string yes Specifies a billing id. { "content": { "application/x-www-form-urlencoded": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateBilling" }, { "$ref": "#/components/schemas/UpdateBilling" }, { "$ref": "#/components/schemas/DeleteBilling" } ] }, "examples": { "Create Billing": { "$ref": "#/components/examples/CreateBilling" }, "Update Billing": { "$ref": "#/components/examples/UpdateBilling" }, "Delete Billing": { "$ref": "#/components/examples/DeleteBilling" } } } } } true
Response contract
The Classic methodology describes ampersand-delimited name/value responses. Where this schema advertises JSON media, that declaration is retained below as a source inconsistency; do not assume REST response parsing. For payments, response 1/2/3 distinguishes approval, decline and error. A transport success alone does not prove a payment was approved. { "200": { "description": "Billing operation completed successfully", "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Response" }, "examples": { "Billing Created": { "$ref": "#/components/examples/BillingCreated" }, "Billing Updated": { "$ref": "#/components/examples/BillingUpdated" }, "Billing Deleted": { "$ref": "#/components/examples/BillingDeleted" }, "Declined Request": { "$ref": "#/components/examples/DeclinedResponse" } } } } } } true
Referenced schema definitions
All schemas and source example objects are preserved here, including descriptions, enums and references. Sample data may be historical. These JSON objects describe form parameters; they are not instructions to send JSON to Classic. { "schemas": { "SecurityKey": { "type": "string", "description": "API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys" }, "CreditCard": { "type": "object", "properties": { "ccnumber": { "type": "string", "enum": [ "4111111111111111", "5431111111111111", "6011000991300009", "341111111111111", "30205252489926", "3541963594572595", "6799990100000000019" ], "description": "Credit card number.\n\n<details>\n<summary>Allowed Card Numbers:</summary>\n\n| Card Type | Test Card Number |\n|:------------------|:---------------------|\n| Visa | 4111111111111111 |\n| MasterCard | 5431111111111111 |\n| Discover | 6011000991300009 |\n| American Express | 341111111111111 |\n| Diner's Club | 30205252489926 |\n| JCB | 3541963594572595 |\n| Maestro | 6799990100000000019 |\n</details>" }, "ccexp": { "type": "string", "description": "Credit card expiration date.\n \nFormat: `MMYY`" } } }, "BillingDetails": { "type": "object", "properties": { "first_name": { "type": "string", "description": "Cardholder's first name." }, "last_name": { "type": "string", "description": "Cardholder's last name." }, "address1": { "type": "string", "description": "Card billing address." }, "city": { "type": "string", "description": "Card billing city" }, "state": { "type": "string", "description": "Card billing state.\n \nFormat: `CC`" }, "zip": { "type": "string", "description": "Card billing postal code." }, "country": { "type": "string", "description": "Card billing country code. *Country codes are as shown in ISO 3166-1 alpha-2*.\n \nFormat: `CC`" }, "phone": { "type": "string", "description": "Billing phone number." }, "email": { "type": "string", "description": "Billing email address." }, "company": { "type": "string", "description": "Cardholder's company." }, "address2": { "type": "string", "description": "Card billing address, line 2." }, "fax": { "type": "string", "description": "Billing fax number." } } }, "CreateBilling": { "type": "object", "title": "Create Billing", "allOf": [ { "required": [ "customer_vault", "customer_vault_id", "ccnumber", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "customer_vault": { "type": "string", "enum": [ "add_billing" ], "description": "Create a billing record for the given Customer Vault record." }, "customer_vault_id": { "type": "string", "description": "Specifies a Customer Vault id." }, "billing_id": { "type": "string", "description": "Specifies a billing id." } } }, { "$ref": "#/components/schemas/CreditCard" }, { "$ref": "#/components/schemas/BillingDetails" } ] }, "UpdateBilling": { "type": "object", "title": "Update Billing", "allOf": [ { "required": [ "customer_vault", "customer_vault_id", "billing_id", "ccnumber", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "customer_vault": { "type": "string", "enum": [ "update_billing" ], "description": "Update a billing record for the given Customer Vault record." }, "customer_vault_id": { "type": "string", "description": "Specifies a Customer Vault id." }, "billing_id": { "type": "string", "description": "Specifies a billing id. If not set" } } }, { "$ref": "#/components/schemas/CreditCard" }, { "$ref": "#/components/schemas/BillingDetails" } ] }, "DeleteBilling": { "type": "object", "title": "Delete Billing", "required": [ "customer_vault", "customer_vault_id", "billing_id", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "customer_vault": { "type": "string", "enum": [ "delete_billing" ], "description": "Delete a billing record for the given Customer Vault record." }, "customer_vault_id": { "type": "string", "description": "Specifies a Customer Vault id." }, "billing_id": { "type": "string", "description": "Specifies a billing id." } } }, "Response": { "type": "object", "title": "Response", "properties": { "response": { "type": "string", "enum": [ "1", "2", "3" ], "description": "Status code for the operation. (1) - success, (2) - failed, (3) system error" }, "responsetext": { "type": "string", "description": "Textual description of the operation's result." }, "authcode": { "type": "string", "description": "Authorization code for the operation." }, "amount_authorized": { "type": "string", "description": "(Conditional) This will optionally come back when requesting partial payment. Authorization amount." }, "transactionid": { "type": "string", "description": "(Conditional - Payment) Payment gateway transaction id." }, "invoice_id": { "type": "string", "description": "(Conditional - Invoice) Identifier for the invoice." }, "avsresponse": { "type": "string", "description": "Address Verification Service response code." }, "cvvresponse": { "type": "string", "description": "Card Verification Value response." }, "orderid": { "type": "string", "description": "Identifier for an order related to this invoice." }, "type": { "type": "string", "enum": [ "sale", "auth", "validate", "credit", "offline", "capture", "void", "refund", "complete_partial_payment", "add_invoice", "update_invoice", "send_invoice", "close_invoice", "add_plan", "edit_plan", "add_subscription", "" ], "description": "Type of operation that this response is for." }, "partial_payment_id": { "type": "string", "description": "(Conditional) This will optionally come back when requesting partial payment. A numeric identifier which is used when submitting subsequent transactions." }, "partial_payment_balance": { "type": "string", "description": "(Conditional) This will optionally come back when requesting partial payment. The payment's remaining balance." }, "platform_id": { "type": "string", "description": "Platform ID associated with the transaction." }, "response_code": { "type": "string", "description": "Another status or result code for the operation. See [Response Code Table](#section/Appendixes/Payment-API-Response-Codes)" }, "subscription_id": { "type": "string", "description": "(Conditional - Subscription) The subscription ID that was created" }, "emv_auth_response_data": { "type": "string", "description": "(Conditional) This will optionally come back when any chip card data is provided on the authorization. This data needs to be sent back to the SDK after an authorization." }, "payment_terms": { "type": "string", "description": "(Conditional - Invoice) The terms of payment for the invoice." }, "customer_vault_id": { "type": "string", "description": "(Conditional - Customer Vault) The original customer_vault_id passed in the transaction request or the resulting customer_vault_id created on an approved transaction.\n\nNote: Only returned when the \"Customer Vault\" service is active." }, "kount_score": { "type": "string", "description": "The Kount \"Omniscore\" indicating the level of risk on a given transaction. The higher the score, the lower the risk.\n\nNote: Only returned when the \"Kount\" service is active." } } } }, "examples": { "CreateBilling": { "summary": "Create Billing", "description": "Create Billing", "value": { "customer_vault": "add_billing", "customer_vault_id": "1622014144", "billing_id": "BillingId1", "ccnumber": "4111111111111111", "ccexp": "1234", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "UpdateBilling": { "summary": "Update Billing", "description": "Update Billing", "value": { "customer_vault": "update_billing", "customer_vault_id": "1622014144", "billing_id": "BillingId1", "ccnumber": "4111111111111111", "ccexp": "1234", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "DeleteBilling": { "summary": "Delete Billing", "description": "Delete Billing", "value": { "customer_vault": "delete_billing", "customer_vault_id": "1622014144", "billing_id": "BillingId1", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "BillingCreated": { "summary": "Billing Information Created", "description": "Billing Information has been created", "value": { "response": "1", "responsetext": "Billing Information Added", "authcode": "", "transactionid": "", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "", "response_code": "100", "customer_vault_id": "1622014144" } }, "BillingUpdated": { "summary": "Billing Information Updated", "description": "Billing Information has been updated", "value": { "response": "1", "responsetext": "Billing Information Updated", "authcode": "", "transactionid": "", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "", "response_code": "100", "customer_vault_id": "1622014144" } }, "BillingDeleted": { "summary": "Billing Information Deleted", "description": "Billing Information has been deleted", "value": { "response": "1", "responsetext": "Billing Information Deleted", "authcode": "", "transactionid": "", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "", "response_code": "100", "customer_vault_id": "1622014144" } }, "DeclinedResponse": { "summary": "Failed to Create Plan", "description": "Failed to create a new plan", "value": { "response": "3", "responsetext": "There is already a plan using the SKU you have specified. REFID:1203610329", "authcode": "", "transactionid": "", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "", "response_code": "100" } } } } true
Published operation notes
Additional operation-specific source notes, including legacy outcome tables where published. Read alongside the family guidance above; source marketing claims are not compliance guarantees. <details> <summary>Methodology</summary> **Steps:** 1. The customer sends their payment information to the merchant's web site. 2. The merchant web site posts the payment data to the Payment Gateway. 3. The Payment Gateway responds immediately with the results of the transactions. 4. The merchant web site displays the appropriate message to the customer. The communication method used to send messages to the Payment Gateway's server is the standard HTTP protocol over an SSL connection. In the Payment API method, the communications with the cardholder (Steps 1 and 4) are developed completely by the merchant and therefore are not defined by the Payment Gateway. Step 1 should simply collect the payment data from the cardholder and Step 4 should display the appropriate transaction receipt or declined message. In Step 2, transaction details should be delivered to the Payment Gateway using the POST method with the appropriate variables defined below posted along with the request. In Step 3, the transaction responses are returned in the body of the HTTP response in a query string name/value format delimited by ampersands. For example: `variable1=value1&variable2=value2&variable3=value3` ### Customer Vault The Customer Vault was designed specifically for businesses of any size to address concerns about handling customer payment information. Visa and MasterCard have instituted the Payment Card Industry (PCI) Data Security to protect cardholder data, wherever it resides, ensuring that members, merchants, and service providers maintain the highest information security standards. These associations have also deemed that merchants will be held liable for any breach of cardholder data. This has become a major concern for merchants who handle credit card or electronic check payments. The Customer Vault is designed for these merchants who desire to avoid the tremendous costs and resources involved in becoming PCI compliant under these circumstances. The Customer Vault does this by allowing merchants to transmit their payment information through a Secure Sockets Layer (SSL) connection for storage in our Level 1 PCI certified data facility. Once the customer record has been securely transmitted to the Customer Vault, the merchant can then initiate transactions remotely without having to access cardholder information directly. This process is accomplished without the merchant storing the customer's payment information in their local database or payment application. </details> <details> <summary>Response Code Table</summary> | Code | Description | |:------|:-------------------------------------------------------------------| | 100 | Transaction was approved. | | 200 | Transaction was declined by processor. | | 201 | Do not honor. | | 202 | Insufficient funds. | | 203 | Over limit. | | 204 | Transaction not allowed. | | 220 | Incorrect payment information. | | 221 | No such card issuer. | | 222 | No card number on file with issuer. | | 223 | Expired card. | | 224 | Invalid expiration date. | | 225 | Invalid card security code. | | 226 | Invalid PIN. | | 240 | Call issuer for further information. | | 250 | Pick up card. | | 251 | Lost card. | | 252 | Stolen card. | | 253 | Fraudulent card. | | 260 | Declined with further instructions available. (See response text) | | 261 | Declined-Stop all recurring payments. | | 262 | Declined-Stop this recurring program. | | 263 | Declined-Update cardholder data available. | | 264 | Declined-Retry in a few days. | | 300 | Transaction was rejected by gateway. | | 400 | Transaction error returned by processor. | | 410 | Invalid merchant configuration. | | 411 | Merchant account is inactive. | | 420 | Communication error. | | 421 | Communication error with issuer. | | 430 | Duplicate transaction at processor. | | 440 | Processor format error. | | 441 | Invalid transaction information. | | 460 | Processor feature not available. | | 461 | Unsupported card type. | </details> true
Reconcile outcomes
Persist the returned transaction or object identifier and inspect the operation result before changing application state. Investigate interrupted financial responses before retrying. Saved methods, invoice delivery, schedules and refunds have different side effects; select the corresponding variant explicitly. Account and processor behavior have not been executed in this audit.