Sign in

v1

latestOpenAPI 3.0.02026-08-067074272.5 KB
Payments

Mark a payment as paid

Closes a payment as "paid". Use this endpoint for when the payment is paid through a means other than the payment request portal. This will close the payment and add its payment amount to your statistics. This endpoint is not required for payments paid through the payments-portal sent through Text Request; that will automatically mark a payment as paid.

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

Path parameters

dashboard_idinteger required
Example:121

Id of dashboard

payment_idinteger required
Example:2510

Id of payment

Response

The payment that was marked as paid.

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