Get a conversation
GET /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. GET /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 GET \ --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: 'GET', 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='GET', 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::Get.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 => 'GET', 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 The conversation corresponding to the provided `conversationId`. { "200": { "description": "The conversation corresponding to the provided `conversationId`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/ConversationId" }, "phone": { "$ref": "#/components/schemas/ConversationCustomerPhone" }, "date": { "$ref": "#/components/schemas/ConversationCreationDate" }, "status": { "$ref": "#/components/schemas/ConversationStatus" }, "firstName": { "$ref": "#/components/schemas/ConversationCustomerFirstName" }, "lastName": { "$ref": "#/components/schemas/ConversationCustomerLastName" }, "recordId": { "$ref": "#/components/schemas/NmiRecordId" }, "expiration": { "$ref": "#/components/schemas/ConversationExpirationDate" }, "amount": { "$ref": "#/components/schemas/ConversationAmount" }, "topic": { "$ref": "#/components/schemas/ConversationTopic" }, "instructions": { "$ref": "#/components/schemas/ConversationInstructions" } } } } } } } true
Response fields · 200 · application/json
Field Type Required Description Constraints id string no 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}$" phone string no The conversation customer's ten-digit phone number. US and CA numbers only. pattern: "^\\d{10}$" date string no The creation date for the conversation. format: "date-time" status string no The conversation status. enum: ["in progress", "expired", "completed"] firstName string no The conversation customer's first name. lastName string no The conversation customer's last name. recordId string no The NMI marketplace 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}$" expiration string no The expiration date for the conversation. format: "date-time" amount string no The conversation amount in USD. pattern: "^\\d+\\.\\d{2}$" topic string no The resolution this conversation is trying to reach. instructions string no A short intro or message to send along with the payment request to help provide more context. maxLength: 50
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" }, "ConversationTopic": { "type": "string", "description": "The resolution this conversation is trying to reach.", "example": "Weasleys' Wizard Wheezes - Extendable Ear" }, "ConversationInstructions": { "type": "string", "description": "A short intro or message to send along with the payment request to help provide more context.", "maxLength": 50, "example": "Thank you for your purchase! Please click the link below to make your payment." }, "ConversationCreationDate": { "type": "string", "description": "The creation date for the conversation.", "format": "date-time", "example": "2023-11-16T20:28:51.990Z" }, "ConversationExpirationDate": { "type": "string", "description": "The expiration date for the conversation.", "format": "date-time", "example": "2023-11-23T20:28:51.990Z" }, "ConversationStatus": { "type": "string", "description": "The conversation status.", "enum": [ "in progress", "expired", "completed" ], "example": "in progress" }, "ConversationAmount": { "type": "string", "description": "The conversation amount in USD.", "pattern": "^\\d+\\.\\d{2}$", "example": "59.94" }, "ConversationCustomerPhone": { "type": "string", "description": "The conversation customer's ten-digit phone number. US and CA numbers only.", "pattern": "^\\d{10}$", "example": "1234567890" }, "ConversationCustomerFirstName": { "type": "string", "description": "The conversation customer's first name.", "example": "Aberforth" }, "ConversationCustomerLastName": { "type": "string", "description": "The conversation customer's last name.", "example": "Dumbledore" }, "NmiMerchantId": { "type": "string", "description": "The merchant ID from NMI. This is only required for partners; for merchants it is ignored.", "format": "int32", "example": "1" }, "NmiRecordId": { "type": "string", "description": "The NMI marketplace 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": "4eed6bef-7fd3-4780-9563-c0d2afa88c76" } }, "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.