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 Unique identifier for the Payment.
The ID of an Account from which the Payment funds will be retrieved.
The ID of an Account where the Payment funds will be sent to.
The amount, in cents, of the Payment. (e.g. $1.00 = 100)
The Payment's description (maximum of 10 characters).
Status of the Payment.
pendingInitial status after the Payment is created. Payment will stay in this state until it is processed. Payment can be deleted in this state.
canceledThe Payment was canceled and was never processed.
processingThe Payment is being processed. At this point, the Payment can no longer be deleted.
failedAn error occurred while either pulling funds from the source Account orpushing funds to the destination Account.
sentThe Payment has been executed and sent to the banking networks.
postedThe Payment has been posted to the destination Account.
reversal_processingThe active reversal corresponding to this Payment has been approved and is being processed.
reversedThe active reversal has successfully been completed and the funds have been returned to the source Account.
estimated_completion_date
An estimated date, in ISO 8601 format (YYYY-MM-DD), on which the Payment should be completed.
The underlying ID for the bank transaction on the source Account relating to this Payment.
An estimated date, in ISO 8601 format (YYYY-MM-DD), on which the funds pulled from the source Account will be completed.
The status of the pulling of funds from the source Account.
pendingThe funds are scheduled to be pulled on the next cutoff window.
canceledAn error occurred while requesting to pull funds from the source Account.
returnedFailed to pull funds from the source Account.
sentThe funds were successfully pulled from the source Account.
The underlying ID for the bank transaction on the destination Account relating to this Payment.
destination_payment_method
The payment method used to process the Payment.
electronicElectronic payment.
paperPaper check payment.
destination_settlement_date
An estimated date, in ISO 8601 format (YYYY-MM-DD), on which the funds sent to the destination Account will be completed.
The status of the push of funds to the destination Account.
pendingThe funds are scheduled to be pushed on the next cutoff window.
processingA request to push the funds to the destination Account has been initiated.
failedAn error occurred while requesting to push funds to the destination Account.
sentThe funds were successfully pushed to the destination Account.
postedThe funds have been posted to the destination Account.
The ID of an active Reversal.
Payment fee information. If provided, the Payment will incur a fee whichwill be deducted from the total amount received by the destination Account.
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
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
The amount (in cents) of the fee.
A status indicating the flow of funds throughout the lifecycle of the Payment.
pendingInitial fund status after the Payment is created.
requestedThe Payment funds have been requested from the source Account.
clearingThe Payment funds from the source Account have been received.
failedThe clearing of funds for a Payment have failed.
sentThe Payment funds have been sent to the destination Account.
postedThe Payment funds have been posted to the destination Account.
An object representing an error that occurred while processing this Payment. See Payment errors .
Additional data provided during creation. See metadata
Timestamp of when the Payment was created.
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 ,
"fee" : null ,
"error" : null ,
"metadata" : null ,
"created_at" : "2024-03-14T16:15:26.074Z" ,
"updated_at" : "2024-03-14T16:15:26.074Z"
} 
