Submit Simulator Reversal

POST 
/api/simulator/reverse

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

Request

application/json

Body

required

oneOf

ReverseAuthorization

authorizationRequestMsg stringrequired

requestMsg returned by the Simulator Authorization endpoint

ReverseClearing

clearingRequestMsg stringrequired

requestMsg returned by the Simulator Clearing endpoint

transactionType stringrequired

Possible values: [purchase, refund]

Transaction type.

transactionAmount string

Amount that replaces the amount on the prior authorize or clear requests. An integer in the smallest denomination of the currency. If not provided the transaction will be reversed for the full amount of the authorization or clearing request.

currencyCode string

Default value: USD

ISO 4217 currency code.

Responses

200

application/json

Schema

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

Example (from schema)

{
  "requestMsg": "string",
  "responseMsg": "string",
  "transactionId": 0
}

400

Request fields are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
errors string[]

Example (from schema)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "BAD_REQUEST",
  "errors": [
    "Expected string, received number"
  ]
}

403

No Authorization to access resource.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...