POST
/
payments
curl https://production.methodfi.com/payments \
  -X POST \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 5000,
    "source": "acc_hmap9mbgfLcf9",
    "destination": "acc_YXDrjADGjC76U",
    "description": "Loan Pmt"
  }'

{
  "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"
}

Creates a new Payment object.

Payments are transmitted electronically by pulling funds from a source Account, and sending those funds to a destination Account. Payments are posted to the destination Account (settled) in 1-3 business days but may vary per FI (Financial Institution).

​
Body

​
amount
number
required

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

​
source
string
required

The ID of an Account from which the Payment funds will be retrieved.

Ensure that the following checks have been done on an Account before it is used as a Payment source:

  • Both the status of the Account and its holder (Entity) is active
  • Both the Account and its holder have the payments value in their products property.

​
destination
string
required

The ID of an Account where the Payment funds will be sent to. In the Method ecosystem, these can be either ach or liability typed accounts.

Ensure that the following checks have been done on an Account before it is used as a Payment destination:

  • Both the status of the Account and its holder (Entity) is active
  • Both the Account and its holder have the payments value in their products property.

​
description
string
required

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

​
fee
object

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

​
dry_run
boolean

A boolean flag. If provided and set to true, it simulates the creation of a payment without initiating a live payment flow.

​
Returns

Returns a Payment object. The Payment will be sent based on the cutoff times. The status of the Payment will be updated when the Payment is sent to our banking networks. For a dry run payment, no actual payment will be sent.

curl https://production.methodfi.com/payments \
  -X POST \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 5000,
    "source": "acc_hmap9mbgfLcf9",
    "destination": "acc_YXDrjADGjC76U",
    "description": "Loan Pmt"
  }'

{
  "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"
}