DELETE
/
payments
/
{pmt_id}
curl https://production.methodfi.com/payments/pmt_VeCfmkwGKb \
  -X DELETE \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
{
  "id": "pmt_VeCfmkwGKb",
  "source": "acc_hmap9mbgfLcf9",
  "destination": "acc_YXDrjADGjC76U",
  "amount": 5000,
  "description": "Loan Pmt",
  "status": "canceled",
  "estimated_completion_date": "2024-03-21",
  "source_trace_id": null,
  "source_settlement_date": "2024-03-15",
  "source_status": "canceled",
  "destination_trace_id": null,
  "destination_settlement_date": "2024-03-21",
  "destination_status": "canceled",
  "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"
}

Deleting a Payment means canceling it before any funds have been moved.

Payments can be deleted only if its status is in pending

Path Parameters

pmt_id
string
required

ID of the Payment

Returns

Returns the successfully deleted Payment with its status set to canceled.

curl https://production.methodfi.com/payments/pmt_VeCfmkwGKb \
  -X DELETE \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
{
  "id": "pmt_VeCfmkwGKb",
  "source": "acc_hmap9mbgfLcf9",
  "destination": "acc_YXDrjADGjC76U",
  "amount": 5000,
  "description": "Loan Pmt",
  "status": "canceled",
  "estimated_completion_date": "2024-03-21",
  "source_trace_id": null,
  "source_settlement_date": "2024-03-15",
  "source_status": "canceled",
  "destination_trace_id": null,
  "destination_settlement_date": "2024-03-21",
  "destination_status": "canceled",
  "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"
}