Sign in

v1

latestOpenAPI 3.0.02026-08-067074272.5 KB
Payments

Cancels the specified payment.

Cancels the specified payment, texting the user that the payment has been cancelled. Payments cannot be editted, so cancelling and issuing a new payment is the best way to correct a payment.

post/dashboards/{dashboard_id}/payments/{payment_id}/cancel

Path parameters

dashboard_idinteger required
Example:121

Id of dashboard

payment_idinteger required
Example:2510

Id of payment

Response

The payment was cancelled. Returns the payment, now with the cancelled status.

payment_idinteger

The payment identifier. This will be used to update payments in the api.

request_datestring date-time

Timestamp of when initial payment message was queued to be sent.

recipientstring

Name of the payment recipient. May be null if the contact does not have a name associated with their phone number.

descriptionstring

Description of the payment. Description is not shown to the contact and is only used by internal users for context about payments.

customer_phonestring

The contact's phone number.

amount_requestednumber float

The amount in dollars requested by this payment.

is_past_dueboolean

If this payment is past the request date

reminder_was_sentboolean

If a text reminder has already been sent for this payment

transaction_status'Unknown' | 'Approved' | 'Declined' | 'NotAuthorized' | 'Error' | 'Processing' | 'Failed' | 'Authorized' | 'PaymentInProgress'

Status of the transaction in authvia. Starts as Unknown.

textrequest_payment_status'Unknown' | 'Sent' | 'Paid' | 'Cancelled' | 'Failed' | 'PastDue' | 'MarkedAsPaid'

Status of the transaction in Text Request. Represents that status shown in the payments page on the Text Request app. Starts as Sent.

reference_numberstring

User-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can have the same reference.

Example response

{
  "payment_id": 2510,
  "recipient": "John Doe",
  "description": "Housecall for plumbing services",
  "amount_requested": 220.5,
  "transaction_status": "Unknown",
  "textrequest_payment_status": "Sent",
  "reference_number": "receipt-chicago"
}