Create payment agreement simulation

post

https://sandbox.pismolabs.io/statement-refinancing/v1/accounts/{accountId}/payment-agreement-simulations

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

int64

required

Account ID

Body Params

plan_ids

array of strings

List of plan IDs used in the payment agreement simulation

plan_ids

down_payment

double

Down payment amount

type

string

enum

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.

Allowed:

payment_date

date

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

overridden_amount_due

double

Overridden amount due. If provided, it overrides the total amount due for the account in the payment agreement simulation.

Responses

Pismo is here to help