Simulations (Dev)
Update a Payment's Status
API Reference
Entities
- The entity endpoint
- POSTCreate an Individual
- POSTCreate a Corporation
- PUTUpdate an Entity
- GETRetrieve an Entity
- GETList all Entities
- Connect
- Verification Sessions
- Credit Scores
- Attributes
- Vehicles
- Identities
- Products
- Subscriptions
- Consent
Accounts
- The account endpoint
- POSTCreate an Account
- GETRetrieve an Account
- GETList all Accounts
- Updates
- Transactions
- Card Brand
- Attributes
- Payoffs
- Balances
- Sensitive
- Products
- Subscriptions
- Verification Sessions
- Consent
Payments
Supporting Endpoints
- Merchants
- Webhooks
- Reports
- Simulations (Dev)
- Health Check
Simulations (Dev)
Update a Payment's Status
POST
/
simulate
/
payments
/
:pmt_id
curl https://dev.methodfi.com/simulate/payments/pmt_rPrDPEwyCVUcm \
-X POST \
-H "Method-Version: 2024-04-04" \
-H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
-H "Content-Type: application/json" \
-d '{
"status": "processing"
}'
{
"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": "processing",
"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"
}
Updates a Payment’s status.
Path Parameters
ID of the Payment
Body
The next status to which the Payment should transition. See Payment Statuses.
The desired Payment error code to simulate. Required when status is failed
, or reversal_processing
.
10001
Insufficient funds error.
10002
Unauthorized Payment error.
10003
Invalid Account error.
10005
Unauthorized Source error.
10006
Unauthorized Destination error.
10007
Invalid Source error.
10008
Invalid Destination error.
10009
Rejected By Destination error.
10010
Invalid Amount error.
Returns
Returns a Payment object with the updated status.
curl https://dev.methodfi.com/simulate/payments/pmt_rPrDPEwyCVUcm \
-X POST \
-H "Method-Version: 2024-04-04" \
-H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
-H "Content-Type: application/json" \
-d '{
"status": "processing"
}'
{
"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": "processing",
"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"
}
curl https://dev.methodfi.com/simulate/payments/pmt_rPrDPEwyCVUcm \
-X POST \
-H "Method-Version: 2024-04-04" \
-H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
-H "Content-Type: application/json" \
-d '{
"status": "processing"
}'
{
"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": "processing",
"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"
}