Sign in

v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Authvia TXT2PAY

List and filter conversations

get/v4/authvia/conversations

Query parameters

merchantIdstring int32

The merchant ID from NMI. This is only required for partners; for merchants it is ignored.

Example:1
startDatestring date

The start date to filter.

Example:2023-11-01
endDatestring date

The end date to filter.

Example:2029-12-31
status[]ConversationStatus[]

The list of conversation statuses to filter.

[
  "in progress"
]
phonestring

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

Example:1234567890
firstNamestring

The conversation customer's first name.

Example:Aberforth
lastNamestring

The conversation customer's last name.

Example:Dumbledore
minAmountnumber float

The minimum conversation amount to include in the filter.

maxAmountnumber float

The maximum conversation amount to include in the filter.

Response

The list of conversations with optional filters applied.

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.

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"
  }
]