v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB

Authvia TXT2PAY

Get a conversation

get/v4/authvia/conversations/{conversationId}

Response

The conversation corresponding to the provided conversationId.

idstring

The Authvia v4 UUID for the conversation.

phonestring

The conversation customer's ten-digit phone number. US and CA numbers only.

datestring date-time

The creation date for the conversation.

status'in progress' | 'expired' | 'completed'

The conversation status.

firstNamestring

The conversation customer's first name.

lastNamestring

The conversation customer's last name.

recordIdstring

The NMI marketplace v4 UUID for the conversation.

expirationstring date-time

The expiration date for the conversation.

amountstring

The conversation amount in USD.

topicstring

The resolution this conversation is trying to reach.

instructionsstring

A short intro or message to send along with the payment request to help provide more context.

Example response

{
  "id": "7baf2306-4804-4aef-a55e-8cbfcb201ad1",
  "phone": "1234567890",
  "date": "2023-11-16T20:28:51.990Z",
  "status": "in progress",
  "firstName": "Aberforth",
  "lastName": "Dumbledore",
  "recordId": "4eed6bef-7fd3-4780-9563-c0d2afa88c76",
  "expiration": "2023-11-23T20:28:51.990Z",
  "amount": "59.94",
  "topic": "Weasleys' Wizard Wheezes - Extendable Ear",
  "instructions": "Thank you for your purchase! Please click the link below to make your payment."
}