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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create simulation

Request. Provide card.pan, document_number, or plan_ids. When only plan_ids is provided, the simulation runs as a prospect flow without account or program lookup.

number
required

Total simulation amount

string
enum
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.

Allowed:
card
object

Information related to the card used to perform this simulation.

custom_filters
array of strings

Custom filters to be used in the simulation

custom_filters
string

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.

merchants
array of strings

Merchant IDs used to filter the simulation

merchants
payment_agreement
object

Payment agreement information

plan_ids
array of strings

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

plan_ids
processing_codes
array of strings

Procesing codes used to filter the simulation

processing_codes
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json