The payment object

Payments allow you to easily move money between two accounts. Using payments you can move money between two ach accounts (e.g. Checking & Savings) or move money (pay) a liability (e.g. Student Loans, Credit Cards, etc.) All payments are processed electronically between the source and destination, and take 2-3 business days depending on the receiving institution.

Cutoff Time

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:
- ACH: 10:30 AM, 1:30 PM, and 4:30 PM CST
- Liability: 1:30 PM CST

Attributes

`id`

string

Unique identifier for the payment.

`reversal_id`

string,null

The id of an active reversal.

`source_trace_id`

string,null

The underlying id for the bank transaction on the source account relating to this payment.

`destination_trace_id`

string,null

The underlying id for the bank transaction on the destination account relating to this payment.

`source`

string

The id of an ach account from which the payment amount will be retrieved.

`destination`

string

The id of an ach or liability account to which the payment amount will be sent.

`amount`

number

The amount of the payment to be created in cents. (e.g. $1.00 = 100)

`description`

string

The payment's description (maximum of 10 characters).

`status`

enum

Status of the payment

Possible enum values

`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.

`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 or pushing 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 with 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.

`fund_status`

enum

Fund status of the payment. This property is available only when individual payments are retrieved.

Possible enum values

`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.

`unknown`

The status of the payment's funds is unknown.

`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.

`estimated_completion_date`

string,null

An estimated date, in ISO 8601 format (YYYY-MM-DD), on which the payment should be completed.

`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.

`destination_settlement_date`

string,null

An estimated date, in ISO 8601 format (YYYY-MM-DD), on which the funds pushed to the destination account will be completed.

`fee`

object,null

Payment fee information. If provided, the payment will incur a fee which will be deducted from the total amount received by the destination account.

`fee.amount`

number

The fee amount applied to the payment.

`fee.type`

enum

The type of fee applied to the payment.

A payment's fee type determines how much of the payment's amount will be deducted from the amount received by the destination account.

Possible enum values

`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 - Example Method per-payment fee
$7.00                   = $10.00  - $2.00      - $1.00

`created_at`

string

Timestamp of when the payment was created.

`updated_at`

string

Timestamp of when the payment was last updated.

THE PAYMENT OBJECT
{
  "id": "pmt_rPrDPEwyCVUcm",
  "reversal_id": null,
  "source_trace_id": null,
  "destination_trace_id": null,
  "source": "acc_JMJZT6r7iHi8e",
  "destination": "acc_AXthnzpBnxxWP",
  "amount": 5000,
  "description": "Loan Pmt",
  "status": "pending",
  "error": null,
  "metadata": null,
  "estimated_completion_date": "2020-12-11",
  "source_settlement_date": "2020-12-09",
  "destination_settlement_date": "2020-12-11",
  "fee": null,
  "created_at": "2020-12-09T00:42:31.209Z",
  "updated_at": "2020-12-09T00:43:30.996Z"
}