---
title: "Record a cash advance repayment"
method: POST
path: "/protect/cash_advance/repayment/create"
tags: ["plaid"]
---

# Record a cash advance repayment

`POST /protect/cash_advance/repayment/create`

Use this endpoint to record a cash-advance repayment as feedback. A repayment is a record paying back all or some of a previously-taken cash-advance.

## Request body

- ProtectCashAdvanceRepaymentCreateRequest — Request object for `/protect/cash_advance/repayment/create`.
  - `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.
  - `user` ProtectUser, required — Represents an end user for `/protect/compute` requests.
    - `user_id` string — The Plaid User ID returned from a previous call to `/user/create`. This or `client_user_id` can be provided, not both.
    - `client_user_id` string — A unique ID representing the end user, previously passed to `/user/create`. Maximum of 128 characters. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`.
  - `client_advance_id` string, required — The client's unique identifier for the cash-advance.
  - `status` 'REPAID' | 'DELIVERED' | 'UNPAID', required — The repayment status of a cash-advance. `REPAID` - The cash-advance has been fully repaid. `DELIVERED` - The cash-advance has been disbursed to the user and is still outstanding, but its due date has not yet passed. `UNPAID` - The cash-advance is past its due date and has not been repaid; the user is delinquent.
  - `repayment_time` string, date-time, nullable — The time the repayment occurred, in ISO 8601 / RFC 3339 format (`YYYY-MM-DDTHH:mm:ssZ`).
  - `repayment` CashAdvanceRepayment, required — The repayment details for a cash-advance.
    - `amount_paid` Amount, required — A monetary amount and its currency.
      - `iso_currency_code` string — The ISO-4217 currency code of the amount. Defaults to USD if not specified.
      - `value` number, double, required — The amount value.
    - `amount_due` Amount, required — A monetary amount and its currency.
      - `iso_currency_code` string — The ISO-4217 currency code of the amount. Defaults to USD if not specified.
      - `value` number, double, required — The amount value.
    - `due_date` string, date, required — The date the cash-advance is due, in ISO 8601 format (`YYYY-MM-DD`).

## Response `200`

OK

- ProtectCashAdvanceRepaymentCreateResponse — Response object for `/protect/cash_advance/repayment/create`.
  - `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.

---

[API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/revisions/e536704a333f/schema)