PIpismo
Simulation

Create simulation

Create a simulation.

Prior to calling this endpoint to create a simulation, you must create a simulation configuration via the Create simulation config endpoint.

Refer to the Simulation service guide for additional information.

post/v1/simulations

Request

  • Base URL
    https://sandbox.pismolabs.io/payment-methods-admin
  • URL
    https://sandbox.pismolabs.io/payment-methods-admin/v1/simulations
  • Auth
    none declared

Request body

amountnumber required

Total simulation amount

authorization_mode'CREDIT' | 'DEBIT' required

Requested simulation authorization mode. Credit cards can operate only in CREDIT mode. Debit cards from savings or checking accounts can operate only in DEBIT mode. Combo and multi-application cards can operate in both modes. REQUIRED for simulation requests, where message type indicator (MTI) is 0100 or 0120.

custom_filtersstring[]

Custom filters to be used in the simulation

document_numberstring

Document number related to the account to be used as the owner of this request. Provide this field for simulations based on a client document number.

merchantsstring[]

Merchant IDs used to filter the simulation

plan_idsstring[]

Plan IDs used to filter the simulation. REQUIRED when neither card.pan nor document_number is provided.

processing_codesstring[]

Procesing codes used to filter the simulation

Example request

{
  "amount": 100,
  "card": {
    "pan": "5555550000000001"
  },
  "custom_filters": [
    "custom filter1",
    "custom filter2",
    "custom filter3"
  ],
  "document_number": "39947739977",
  "merchants": [
    "MERCH01",
    "MERCH02",
    "MERCH03"
  ],
  "payment_agreement": {
    "original_principal_amount": 80,
    "applied_interest_amount": 80,
    "down_payment": 50
  },
  "plan_ids": [
    "000700",
    "000800",
    "000900"
  ],
  "processing_codes": [
    "000700",
    "000800",
    "000900"
  ]
}

Response

OK

account_idinteger

Pismo ID of the account assigned as the owner of this request. Omitted for prospect simulations.

program_idnumber

Program ID linked to the user account. Omitted for prospect simulations.

amountnumber

Total simulation amount

simulationobject

Any valid JSON that contains useful simulation information

Example response

{
  "account_id": 123,
  "program_id": 1,
  "amount": 100
}

Changes

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