Submit Simulator Reversal

post/api/simulator/reverse

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

Request

Body application/json

One of

authorizationRequestMsgstringrequired
requestMsg returned by the Simulator Authorization endpoint
transactionTypestringrequired
Allowed values:purchaserefundwithdrawal
Transaction type.
transactionAmountstring
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.
currencyCodestringdefault: "USD"
ISO 4217 currency code.
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.

clearingRequestMsgstringrequired
requestMsg returned by the Simulator Clearing endpoint
transactionTypestringrequired
Allowed values:purchaserefundwithdrawal
Transaction type.
transactionAmountstring
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.
currencyCodestringdefault: "USD"
ISO 4217 currency code.
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

Request fields are invalid.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
errorsobject[]
Items
- messagestring
- pathstring
  The location of the invalid path param, query param or payload attribute.

No Authorization to access resource.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl https://test.immersve.com/api/simulator/reverse \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "authorizationRequestMsg": "string",
  "transactionType": "purchase",
  "transactionAmount": "string",
  "currencyCode": "USD",
  "provider": "string"
}'

curl https://test.immersve.com/api/simulator/reverse \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "clearingRequestMsg": "string",
  "transactionType": "purchase",
  "transactionAmount": "string",
  "currencyCode": "USD",
  "provider": "string"
}'

curl https://test.immersve.com/api/simulator/reverse \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "authorizationRequestMsg": "string",
  "transactionType": "purchase",
  "transactionAmount": "string",
  "currencyCode": "USD",
  "provider": "string"
}'

curl https://test.immersve.com/api/simulator/reverse \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "clearingRequestMsg": "string",
  "transactionType": "purchase",
  "transactionAmount": "string",
  "currencyCode": "USD",
  "provider": "string"
}'

curl https://test.immersve.com/api/simulator/reverse \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "authorizationRequestMsg": "string",
  "transactionType": "purchase",
  "transactionAmount": "string",
  "currencyCode": "USD",
  "provider": "string"
}'

curl https://test.immersve.com/api/simulator/reverse \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "clearingRequestMsg": "string",
  "transactionType": "purchase",
  "transactionAmount": "string",
  "currencyCode": "USD",
  "provider": "string"
}'

curl https://test.immersve.com/api/simulator/reverse \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "authorizationRequestMsg": "string",
  "transactionType": "purchase",
  "transactionAmount": "string",
  "currencyCode": "USD",
  "provider": "string"
}'

curl https://test.immersve.com/api/simulator/reverse \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "clearingRequestMsg": "string",
  "transactionType": "purchase",
  "transactionAmount": "string",
  "currencyCode": "USD",
  "provider": "string"
}'

Example Response

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

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

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