---
title: "Trigger the creation of a repayment"
method: POST
path: "/sandbox/transfer/repayment/simulate"
tags: ["plaid"]
---

# Trigger the creation of a repayment

`POST /sandbox/transfer/repayment/simulate`

Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.

## Request body

- SandboxTransferRepaymentSimulateRequest — Defines the request schema for `/sandbox/transfer/repayment/simulate`
  - `client_id` string — Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
  - `secret` string — Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

## Response `200`

OK

- SandboxTransferRepaymentSimulateResponse — Defines the response schema for `/sandbox/transfer/repayment/simulate`
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

## Other responses

- `default` — Error response

## Changes

- **2024-02-21** `5de70cc1e6ca` — 3 warning, 11 info
  - removed the optional property `error_code_reason` from the response with the `default` status
  - removed the optional property `provided_account_subtypes` from the response with the `default` status
  - removed the optional property `required_account_subtypes` from the response with the `default` status
  - removed the `BASE_REPORT_ERROR` enum value from the `error_type` response property for the response status `default`
  - …10 more

[Change history](https://skmtc.dev/plaid/apis/the-plaid-api/changes/sandbox/transfer/repayment/simulate/post.md)

---

[API](https://skmtc.dev/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.dev/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc.dev/plaid/apis/the-plaid-api/revisions/a5b45bccb4e8?raw)