Skip to main content

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

required

    oneOf

    authorizationRequestMsg stringrequired

    requestMsg returned by the Simulator Authorization endpoint

    authorizationResponseMsg stringrequired

    responseMsg returned by the Simulator Authorization endpoint

    transactionType stringrequired

    Possible values: [purchase, refund]

    Transaction type.

    transactionAmount stringrequired

    Transaction amount as an integer in the smallest denomination of the currency.

    currencyCode string

    Default value: USD

    ISO 4217 currency code.

    cardPan stringrequired

    Possible values: Value must match regular expression ^[0-9]{16}$

    Card number.

    cardExpiry stringrequired

    Possible values: Value must match regular expression ^[0-9]{6}$

    Card expiry in YYYYMM format.

    cardCvv stringrequired

    Possible values: Value must match regular expression ^[0-9]{3}$

    Card CVV.

    clearingMode string

    Possible values: [final, multi-final, multi-non-final]

Responses​

Schema

    requestMsg string

    XML formatted ISO 8583 message sent to the simulated card scheme

    responseMsg string

    XML formatted ISO 8583 message returned from the simulated card scheme

    transactionId number

    ID of the transaction

Loading...