Skip to main content

Submit Simulator Clearing

POST 
/api/simulator/clear

This endpoint can be used to test clearing a transaction on a simulated card network

Request​

Body

required

    oneOf

    transactionType stringrequired

    Possible values: [purchase, refund]

    Transaction type.

    transactionAmount stringrequired

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

    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.

    fxAmount

    object

    fxAmount can be specified to process the transaction in a currency other than USD

    amount stringrequired

    Transaction amount as an integer in the smallest denomination for the given currency. Convert the transactionAmount from USD to the desired currency.

    currencyCode stringrequired

    ISO 4217 currency code

    authorizationRequestMsg string

    requestMsg of previous authorization returned by this endpoint.

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