Payments
Use the Payments API to list and inquire on the status of payments that have been generated as a result of invoices being created. In addition, for payments disbursed via a check, it is possible to retrieve the check image via the Payments API.
The Payments API supports listing of all payments created in the platform or retrieving a specific payment by its unique identifier.
A sample payment response when inquiring about a specific payment would look like this:
{
"id": "cHZSorvdZJdPTXraGLTVAZgzNbpqjrBnccDookQeIkzuCpSsdDWVLcDWZNyLzDuI",
"created": "2021-12-21T23:27:31.992826",
"updated": "2021-12-21T23:27:31.992831",
"amount_cents": 101,
"originating_counterparty_id": "7ca98cab-c6e0-42e4-a975-3e35f6457742",
"receiving_counterparty_id": "ae351343-8f87-421f-b9d8-ff0a9d2d8868",
"payment_method": "PrintedCheck",
"status": "complete",
"status_detail": {
"message": "Check payment cleared",
"trace_number": "007791"
},
"status_history": [
{
"datetime": "2021-12-21 23:27:42.186145",
"status_detail": "ACH Debit transaction sent"
},
{
"datetime": "2021-12-21 23:30:15.181284",
"status_detail": "ACH Debit (funding) received"
},
{
"datetime": "2021-12-21 23:33:06.273645",
"status_detail": "Check"
},
{
"datetime": "2021-12-21 23:39:11.638923",
"status_detail": "Check payment cleared"
}
],
"tracking_id": "RC164012925186900",
}