GET
/
payments
curl "https://production.methodfi.com/payments?from_date=2024-03-13&to_date=2024-03-15&status=pending" \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"

{
  "data": [
    {
      "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",
      "destination_payment_method": "paper",
      "reversal_id": null,
      "error": null,
      "metadata": null,
      "created_at": "2024-03-14T16:15:26.074Z",
      "updated_at": "2024-03-14T16:15:26.074Z"
    }
  ]
}

Returns a list of Payment objects.

​
Query Parameters

​
source
string

The ID of the Payment's source.

​
destination
string

The ID of the Payment's destination.

​
acc_id
string

The ID of either the Payment's source or destination.

​
source_holder_id
string

The ID of the Payment's source holder (Entity).

​
destination_holder_id
string

The ID of the Payment's destination holder (Entity).

​
holder_id
string

The ID of either of the Payment's source or destination holder (Entity).

​
status
string

The Payment's status.

​
from_date
string

ISO 8601 formatted date (YYYY-MM-DD) to filter for Payments created on and after the date provided.

​
to_date
string

ISO 8601 formatted date (YYYY-MM-DD) to filter for Payments created on and before the date provided.

​
page
string

The number of the page to return.

​
page_cursor
string

The ID of a resource from which a page should start or end. Mutually exclusive with page.

​
page_limit
string

The number of Payments to return per page.

​
Returns

Returns a list of Payment objects.

curl "https://production.methodfi.com/payments?from_date=2024-03-13&to_date=2024-03-15&status=pending" \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"

{
  "data": [
    {
      "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",
      "destination_payment_method": "paper",
      "reversal_id": null,
      "error": null,
      "metadata": null,
      "created_at": "2024-03-14T16:15:26.074Z",
      "updated_at": "2024-03-14T16:15:26.074Z"
    }
  ]
}