Skip to main content

List all payments

Returns all the payments associated with your team, or an empty list if none have been created.

Parameters

type

enum
The type of payments to retrieve.
Possible enum values

standard

clearing

Optional

status

enum
The status of payments to retrieve. See payment statuses.

Optional

source

string
The id of the Account that is a payment's source.

Optional

destination

string
The id of the Account that is a payment's destination.

Optional

acc_id

string
The id of the Account that is either a payment's source or destination

Optional

reversal_id

string
The id of the Reversal corresponding to a payment.

Optional

source_holder_id

string
The id of the Entity who holds the source account in a payment.

Optional

destination_holder_id

string
The id of the Entity who holds the destination account in a payment.

Optional

Returns

Returns a list of payment objects.

GET /payments
curl https://production.methodfi.com/payments \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
RESPONSE
{
  "data": [
    {
      "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"
    }
  ]
}