simulate incoming message (sandbox only)

Simulate an incoming dispute message in sandbox environment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean
required

Flag to trigger the action_requested webhook. When enabled, investigation_type_code must be INV13 or INV14.

string
enum
required

The type of investigation to be simulated.

Allowed:
string
required

The reason code for the investigation (eg from the ISO20022 ExternalReturnReason1Code set).

string
required

The original transaction identification related to the investigation. It must relate to a PayTo payment submission for a mandate owned by the merchant.

string
required

The narrative for the investigation (freeform text, slash-delimited). It is omitted from the message_received webhook but is included in action_requested webhook.

Headers
string
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json