Payment agreement simulation

Create payment agreement simulation

Create a payment agreement simulation.

If successful, this endpoint generates a Payment agreement simulation processed event. If it fails, it generates a Payment agreement simulation not processed event.

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

Path parameters

accountIdinteger required

Example:101

Account ID

Request body

plan_idsstring[]

List of plan IDs used in the payment agreement simulation

down_paymentnumber 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 endpoint and the Credit card refinancing guide.

payment_datestring date

Date of first payment. Format = YYYY-MM-DD.

overridden_amount_duenumber 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.

Example request

{
  "plan_ids": [
    "id1",
    "id2",
    "id3"
  ],
  "down_payment": 500.99,
  "type": "STATEMENT_AGREEMENT",
  "payment_date": "2025-06-20",
  "overridden_amount_due": 2000
}

Response

OK - Indicates that the simulation was successfully created.

created_atstring date-time

Timestamp when the payment agreement simulation was created. Format = YYYY-MM-DDThh:mm:ss.ssssssZ.

plan_idsstring[]

List of plan IDs used in the payment agreement simulation

down_paymentnumber double

Down payment amount

overridden_amount_duenumber 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_datestring 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 endpoint and the Credit card refinancing guide.

status'PENDING' | 'PROCESSED' | 'ERROR'

Status of payment agreement simulation

cidstring uuid

Correlation ID for tracking the simulation request

org_idstring

Organization ID

Example response

{
  "created_at": "2025-06-17T15:22:51.978005295",
  "plan_ids": [
    "id1",
    "id2",
    "id3"
  ],
  "down_payment": 500.99,
  "overridden_amount_due": 2000,
  "payment_date": "2025-06-20",
  "type": "STATEMENT_AGREEMENT",
  "status": "PENDING",
  "cid": "1144f6a7-ed73-4fd2-ba45-80d3b881cad6",
  "org_id": "TN-e7091464-cd1e-4c20-8c68-1e4c5774d972"
}

Changes

No recorded changes to this operation across all 1 revision of this API.