Immersve Docs
GithubX

Submit Simulator Clearing

post/api/simulator/clear

Test clearing a transaction on a simulated card network. A single clearing that references a prior authorization is the most common use case. The amount can be for the full or partial amount of the authorization.

Multiple Clearing

Multiple clearings can be submitted for a single authorization. Multiple clearings has e-commerce use cases where clearing happens as items are shipped. Clearing amounts are cumulative. Use the clearingMode field to simulate multiple clearings.

Clearing Mode:

Signals whether additional clearing messages are expected.

  • final: No further clearing message is expected.
  • multi-non-final: Additional clearing messages are expected.
  • multi-final: This is the final of multiple clearing messages.

Request

Body application/json

One of

  • authorizationRequestMsgstringrequired
  • authorizationResponseMsgstringrequired
  • transactionTypestringrequired
    Allowed values:purchaserefundwithdrawal

    Transaction type.

  • transactionAmountstringrequired

    Transaction amount as an integer in the smallest denomination of the currency. Maximum value of 100000 in card currency.

  • currencyCodestringdefault: "USD"

    ISO 4217 currency code.

  • cardPanstringrequiredpattern: ^[0-9]{16}$

    Card number.

  • cardExpirystringrequiredpattern: ^[0-9]{6}$

    Card expiry in YYYYMM format.

  • cardCvvstringrequiredpattern: ^[0-9]{3}$

    Card CVV.

  • clearingModestring
    Allowed values:finalmulti-finalmulti-non-final
  • providerstring

    Card network simulator provider that processes the request. If undefined, the provider is selected on a best match basis. If the card was not provisioned via the provider then the simulated payment will be rejected. Possible values:

    • apac-test: APAC cards.
    • eu-test: EU cards.
    • na-test: US cards.

Response

Successful operation.

Body application/json

  • requestMsgstring

    XML formatted ISO 8583 message sent to the simulated card scheme

  • responseMsgstring

    XML formatted ISO 8583 message returned from the simulated card scheme

  • transactionIdnumber

    ID of the transaction