Close a conversation
DELETE /v4/authvia/conversations/{conversationId}
Environment and operation
Use this endpoint contract with the account and environment assigned to your integration. Values in angle brackets are placeholders. This reference does not execute requests. Documented server https://sandbox.nmi.com/api Schema reference: field definitions do not include every behavioral rule. Follow the workflow guidance and account prerequisites for this operation before submitting requests.
Request route
Select the documented server above and use this method and path. Path identifiers must belong to the authorized account. DELETE /v4/authvia/conversations/{conversationId} Security scheme Type Credential location Scopes v4ApiKey apiKey header Authorization No scopes declared on this operation
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. Node requires a runtime with fetch; PHP requires cURL. Generated source-based examples have not been executed against provider accounts. curl --request DELETE \ --url 'https://sandbox.nmi.com/api/v4/authvia/conversations/{conversationId}' \ --header 'Authorization: <v4ApiKey>' const response = await fetch("https://sandbox.nmi.com/api/v4/authvia/conversations/{conversationId}", { method: 'DELETE', headers: { "Authorization": "<v4ApiKey>" } }); console.log(response.status, await response.text()); from urllib.request import Request, urlopen from urllib.error import HTTPError request = Request('https://sandbox.nmi.com/api/v4/authvia/conversations/{conversationId}', method='DELETE', headers={'Authorization': '<v4ApiKey>'}) 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/v4/authvia/conversations/{conversationId}") request = Net::HTTP::Delete.new(uri) request["Authorization"] = "<v4ApiKey>" 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/v4/authvia/conversations/{conversationId}'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'DELETE', CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 30, CURLOPT_HTTPHEADER => ['Authorization: <v4ApiKey>'] ]); $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);
Path and query parameters
Required flags apply to the parameter itself. Additional limits and enum values appear in the contract below. Parameter Location Required Type Description conversationId path true See schema The Authvia v4 UUID for the conversation. merchantId query false See schema [ { "name": "conversationId", "description": "The Authvia v4 UUID for the conversation.", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ConversationId" } }, { "in": "query", "name": "merchantId", "schema": { "$ref": "#/components/schemas/NmiMerchantId" } } ] true
Responses
Match the HTTP status to its response schema below. For financial operations, also inspect the payment outcome before updating your order or retrying. HTTP status Media type Meaning 200 application/json A success message. { "200": { "description": "A success message.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "$ref": "#/components/schemas/Success" } } } } } } } true
Response fields · 200 · application/json
Field Type Required Description Constraints success boolean no Indicates the success of the request.
Referenced schema definitions
References beginning with #/components resolve to these definitions. These are field contracts, not example payment values. Use the applicable variant, required fields and constraints. { "schemas": { "ConversationId": { "type": "string", "description": "The Authvia v4 UUID for the conversation.", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "example": "7baf2306-4804-4aef-a55e-8cbfcb201ad1" }, "NmiMerchantId": { "type": "string", "description": "The merchant ID from NMI. This is only required for partners; for merchants it is ignored.", "format": "int32", "example": "1" }, "Success": { "type": "boolean", "description": "Indicates the success of the request." } }, "securitySchemes": { "v4ApiKey": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "API Security Key assigned to a partner or merchant account. New keys can be generated from Settings > Security Keys in the partner and merchant portals." } } } true
Integration checks
Validate the request against its selected schema before submission. Keep secrets outside browser code. Test permitted and denied account access, validation failures and interrupted responses in the sandbox. Account-management or messaging operations require the corresponding partner access and intended recipient context.