---
title: "Create payment agreement simulation"
method: POST
path: "/v1/accounts/{accountId}/payment-agreement-simulations"
tags: ["Payment agreement simulation"]
---

# Create payment agreement simulation

`POST /v1/accounts/{accountId}/payment-agreement-simulations`

## Request

- Base URL: `https://sandbox.pismolabs.io/statement-refinancing`
- URL: `https://sandbox.pismolabs.io/statement-refinancing/v1/accounts/{accountId}/payment-agreement-simulations`
- Auth: HTTP bearer

Create a payment agreement simulation.

If successful, this endpoint generates a [Payment agreement simulation processed](https://developers.pismo.io/events/docs/balance-installment-payment-processed-1) event.
If it fails, it generates a [Payment agreement simulation not processed](https://developers.pismo.io/events/docs/statement-refinancing-payment-agreement-simulation-not-processed-1) event.

## Path parameters

- `accountId` integer, required

## Request body

- PaymentAgreementSimulationRequest
  - `plan_ids` string[]: List of plan IDs used in the payment agreement simulation
  - `down_payment` number, double: Down payment amount
  - `type` 'STATEMENT_INSTALLMENT' | 'STATEMENT_INSTALLMENT_COMPULSORY' | 'STATEMENT_AGREEMENT': Payment agreement type. Possible values: - `STATEMENT_INSTALLMENT`: Customer makes an agreement with their credit card issuer stating that they aren't able to pay off their debt within the current month, so they intend to settle the amount over the next few bills. - `STATEMENT_INSTALLMENT_COMPULSORY`: Issuer-imposed installment agreement renegotiated without customer input. - `STATEMENT_AGREEMENT`: Customer renegotiates all pending debt for all their statements. For more information, refer to the [Create payment agreement](ref:installmentpaymentsv4) endpoint and the [Credit card refinancing](doc:negotiating-credit-card-debt) guide.
  - `payment_date` string, date: Date of first payment. Format = YYYY-MM-DD.
  - `overridden_amount_due` number, double: Overridden amount due. If provided, it overrides the total amount due for the account in the payment agreement simulation. Must be greater than zero and less than or equal to the current amount due.

## Response `200`

OK - Indicates that the simulation was successfully created.

- PaymentAgreementSimulationResponse
  - `created_at` string, date-time: Timestamp when the payment agreement simulation was created. Format = YYYY-MM-DDThh:mm:ss.ssssssZ.
  - `plan_ids` string[]: List of plan IDs used in the payment agreement simulation
  - `down_payment` number, double: Down payment amount
  - `overridden_amount_due` number, double: Overridden amount due. If provided, it overrides the total amount due for the account in the payment agreement simulation. Must be greater than zero and less than or equal to the current amount due.
  - `payment_date` string, date: Date of first payment. Format = YYYY-MM-DD.
  - `type` 'STATEMENT_INSTALLMENT' | 'STATEMENT_INSTALLMENT_COMPULSORY' | 'STATEMENT_AGREEMENT': Payment agreement type. Possible values: - `STATEMENT_INSTALLMENT`: Customer makes an agreement with their credit card issuer stating that they aren't able to pay off their debt within the current month, so they intend to settle the amount over the next few bills. - `STATEMENT_INSTALLMENT_COMPULSORY`: Issuer-imposed installment agreement renegotiated without customer input. - `STATEMENT_AGREEMENT`: Customer renegotiates all pending debt for all their statements. For more information, refer to the [Create payment agreement](ref:installmentpaymentsv4) endpoint and the [Credit card refinancing](doc:negotiating-credit-card-debt) guide.
  - `status` 'PENDING' | 'PROCESSED' | 'ERROR': Status of payment agreement simulation
  - `cid` string, uuid: Correlation ID for tracking the simulation request
  - `org_id` string: Organization ID

## Other responses

- `400`: Bad Request
- `423`: Locked
- `500`: Internal Server Error

---

[API](https://skmtc.dev/pismo/apis/revolving-credit-statement-refinancing.md) - [All operations](https://skmtc.dev/pismo/apis/revolving-credit-statement-refinancing/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/revolving-credit-statement-refinancing/revisions/e03c7d007290?raw)