v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB

Authvia TXT2PAY

Create a new conversation

post/v4/authvia/conversations

Request body

merchantIdstring int32

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

phonestring required

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

firstNamestring required

The conversation customer's first name.

lastNamestring required

The conversation customer's last name.

expirationstring required

The time to wait for the payment to be completed before it is marked failed. A short time duration value is acceptable such as 30m, 1d, or 7d. If no unit is provided, seconds are used.

instructionsstring required

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

topicstring required

The resolution this conversation is trying to reach.

Example request

{
  "merchantId": "1",
  "phone": "1234567890",
  "amount": "59.94",
  "firstName": "Aberforth",
  "lastName": "Dumbledore",
  "expiration": "7d",
  "instructions": "Thank you for your purchase! Please click the link below to make your payment.",
  "topic": "Weasleys' Wizard Wheezes - Extendable Ear"
}

Response

The conversation was created successfully.

idstring required

The Authvia v4 UUID for the conversation.

phonestring required

The conversation customer's phone number separated with dashes.

datestring date-time required

The creation date for the conversation.

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

The conversation status.

firstNamestring required

The conversation customer's first name.

lastNamestring required

The conversation customer's last name.

recordIdstring required

The NMI marketplace v4 UUID for the conversation.

expirationstring date-time required

The expiration date for the conversation.

amountstring required

The conversation amount in USD.

topicstring required

The resolution this conversation is trying to reach.

instructionsstring required

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": "123-456-7890",
  "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."
}