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.
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 thisstate until it is processed. Payment can be deleted in this state.
processing
The Payment is being processed. At this point, the Payment can no longer be deleted.
sent
The Payment has been executed and sent to the banking networks.
failed
An error occurred while either pulling funds from the source Account orpushing funds to the destination Account.
canceled
The Payment was canceled and was never processed.
reversal_required
The Payment failed and requires a reversal. The Payment's reversal_id is set to the ID of the newly created Reversal. The reversal should then be approved.
reversal_processing
The active reversal corresponding to this Payment has been approved and is being processed.
reversed
The active reversal has successfully been completed.
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.
pending
The funds are scheduled to be pulled on the next cutoff window.
processing
A request to pull the funds from the source Account has been initiated.
sent
The funds were successfully pulled from the source Account.
failed
An error occurred while requesting to pull 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.
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.
sent
The funds were successfully pushed from the destination Account.
failed
An error occurred while requesting to push 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.
fee.type
enum
The type of fee applied to the Payment.
total
This fee type will deduct a flat fee from the amount received by the destination Account.
Example: If a $10.00 Payment is created with a total fee of $2.00, then the resulting amount received by the destination Account will be $8.00. This means that you make total of $2.00 from the Payment. However, the Method fee for this Payment will still be included in your monthly invoice.
Received by destination = Payment - Total fee $8.00 = $10.00 - $2.00
markup
This fee type will deduct a fee on top of Method's per-Payment fee from the amount received by the destination Account.
Example: If a $10.00 Payment is created with a markup fee of $2.00 and your Method fee is $1.00, then the resulting amount received by the destination Account will be $7.00 (Amount - Markup Fee - Method Fee). This means that you make $2.00 from the Payment. Additionally, the Method fee has already been covered by the source Account, and this completed Payment will not be included in your monthly invoice.
Received by destination = Payment - Markup fee - Method fee $7.00 = $10.00 - $2.00 - $1.00
fee.amount
number
The amount (in cents) of the fee.
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.
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
