Skip to main content
A Payment is the transfer of funds from a source checking or savings bank account to a destination credit card, auto loan, mortgage, student loan, and more. All Payments are processed electronically between the source and destination, and take 2-3 business days depending on the receiving financial institution.

​
Cutoff Times

Payments are processed on business days (Monday - Friday), excluding US Banking Holidays.
  • Source processing windows: 10:30 AM, 1:30 PM, and 4:30 PM CST
  • Destination processing windows: 1:30 PM CST

​
Payment Objects

​
id
string
Unique identifier for the Payment.
​
source
string
The ID of an Account from which the Payment funds will be retrieved.
​
destination
string
The ID of an Account where the Payment funds will be sent to.
​
amount
number
The amount, in cents, of the Payment. (e.g. $1.00 = 100)
​
description
string
The Payment's description (maximum of 10 characters).
​
status
enum
Status of the Payment.
pending
Initial status after the Payment is created. Payment will stay in this state until it is processed. Payment can be deleted in this state.canceled
The Payment was canceled and was never processed.processing
The Payment is being processed. At this point, the Payment can no longer be deleted.failed
An error occurred while either pulling funds from the source Account orpushing funds to the destination Account.sent
The Payment has been executed and sent to the banking networks.posted
The Payment has been posted to the destination Account.reversal_processing
The active reversal corresponding to this Payment has been approved and is being processed.reversed
The active reversal has successfully been completed and the funds have been returned to the source Account.
​
estimated_completion_date
string | null
An estimated date, in ISO 8601 format (YYYY-MM-DD), on which the Payment should be completed.
​
source_trace_id
string | null
The underlying ID for the bank transaction on the source Account relating to this Payment.
​
source_settlement_date
string | null
An estimated date, in ISO 8601 format (YYYY-MM-DD), on which the funds pulled from the source Account will be completed.
​
source_status
enum
The status of the pulling of funds from the source Account.
pending
The funds are scheduled to be pulled on the next cutoff window.canceled
An error occurred while requesting to pull funds from the source Account.returned
Failed to pull funds from the source Account.sent
The funds were successfully pulled from the source Account.
​
destination_trace_id
string | null
The underlying ID for the bank transaction on the destination Account relating to this Payment.
​
destination_payment_method
enum
The payment method used to process the Payment.
electronic
Electronic payment.paper
Paper check payment.
​
destination_settlement_date
string | null
An estimated date, in ISO 8601 format (YYYY-MM-DD), on which the funds sent to the destination Account will be completed.
​
destination_status
enum
The status of the push of funds to the destination Account.
pending
The funds are scheduled to be pushed on the next cutoff window.processing
A request to push the funds to the destination Account has been initiated.failed
An error occurred while requesting to push funds to the destination Account.sent
The funds were successfully pushed to the destination Account.posted
The funds have been posted to the destination Account.returned
The funds have been returned from the destination Account.
​
reversal_id
string | null
The ID of an active Reversal.
​
fund_status
enum
A status indicating the flow of funds throughout the lifecycle of the Payment.
pending
Initial fund status after the Payment is created.requested
The Payment funds have been requested from the source Account.clearing
The Payment funds from the source Account have been received.failed
The clearing of funds for a Payment have failed.sent
The Payment funds have been sent to the destination Account.posted
The Payment funds have been posted to the destination Account.
​
error
object | null
An object representing an error that occurred while processing this Payment. See Payment errors.
​
metadata
object | null
Additional data provided during creation. See metadata
​
created_at
string
Timestamp of when the Payment was created.
​
updated_at
string
Timestamp of when the Payment was last updated.
{
  "id": "pmt_VeCfmkwGKb",
  "source": "acc_hmap9mbgfLcf9",
  "destination": "acc_YXDrjADGjC76U",
  "amount": 5000,
  "description": "Loan Pmt",
  "status": "pending",
  "estimated_completion_date": "2024-03-21",
  "source_trace_id": null,
  "source_settlement_date": "2024-03-15",
  "source_status": "pending",
  "destination_trace_id": null,
  "destination_settlement_date": "2024-03-21",
  "destination_payment_method": "paper",
  "destination_status": "pending",
  "reversal_id": null,
  "error": null,
  "metadata": null,
  "created_at": "2024-03-14T16:15:26.074Z",
  "updated_at": "2024-03-14T16:15:26.074Z"
}