{
  "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_status": "pending",
  "reversal_id": null,
  "fee": null,
  "error": null,
  "metadata": null,
  "created_at": "2024-03-14T16:15:26.074Z",
  "updated_at": "2024-03-14T16:15:26.074Z"
}

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.

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 fundspulled from the source Account will be completed.

source_status
enum

The status of the pulling of funds 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_settlement_date
string | null

An estimated date, in ISO 8601 format (YYYY-MM-DD), on which the fundssent from the destination Account will be completed.

destination_status
enum

The status of the push of funds to the destination Account.

reversal_id
string | null

The ID of an active Reversal.

fee
object | null

Payment fee information. If provided, the Payment will incur a fee whichwill be deducted from the total amount received by the destination Account.

fund_status
enum

A status indicating the flow of funds throughout the lifecycle of the Payment.

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_status": "pending",
  "reversal_id": null,
  "fee": null,
  "error": null,
  "metadata": null,
  "created_at": "2024-03-14T16:15:26.074Z",
  "updated_at": "2024-03-14T16:15:26.074Z"
}
Withdraw an Account's ConsentCreate a Payment