---
title: "Creates a new payment"
method: POST
path: "/dashboards/{dashboard_id}/payments"
tags: ["Payments"]
---

# Creates a new payment

`POST /dashboards/{dashboard_id}/payments`

Creates a new payment with the provided message to the provided contact.

## Path parameters

- `dashboard_id` integer, required

## Request body

- PostPaymentRequest
  - `message` string — Message text to send to contact along with authvia payment link.
  - `description` string, required — Description of the payment. Description is not shown to the contact and is only used by internal users for context about payments.
  - `customer_phone` string, required — The contact's phone number.
  - `amount_requested` number, float, required — The amount in dollars requested by this payment.
  - `reference_number` string — 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.

## Response `200`

The new payment.

- Payment
  - `payment_id` integer — The payment identifier. This will be used to update payments in the api.
  - `request_date` string, date-time — Timestamp of when initial payment message was queued to be sent.
  - `recipient` string — Name of the payment recipient. May be null if the contact does not have a name associated with their phone number.
  - `description` string — Description of the payment. Description is not shown to the contact and is only used by internal users for context about payments.
  - `customer_phone` string — The contact's phone number.
  - `amount_requested` number, float — The amount in dollars requested by this payment.
  - `is_past_due` boolean — If this payment is past the request date
  - `reminder_was_sent` boolean — 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_number` string — 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.

## Other responses

- `400` — Bad Request. Request info is invalid or missing, or payments haven't been set up in this dashboard yet.
- `401` — Unauthorized. Sent if the API key is omitted or invalid.

---

[API](https://skmtc.net/textrequest/apis/text-request-api-v3.md) · [All operations](https://skmtc.net/textrequest/apis/text-request-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/textrequest/text-request-api-v3/revisions/e4e42efcd650/schema)