POST
/
disputes
/
simulations
/
{dispute_id}
/
actions
Simulate a network dispute action
curl --request POST \
  --url https://api.synctera.com/v1/disputes/simulations/{dispute_id}/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "ACH_RETURN",
  "message": "<string>",
  "payment_rail": "ACH",
  "reason_code": "DUPLICATE_TRANSACTION",
  "return_code": "R05",
  "state": "ACCEPT",
  "supporting_doc_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}'
{
  "action": "ACH_RETURN",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "message": "<string>",
  "payment_rail": "ACH",
  "reason_code": "DUPLICATE_TRANSACTION",
  "return_code": "R05",
  "status": "ACCEPTED",
  "supporting_doc_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "tenant": "abcdef_ghijkl"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Path Parameters

dispute_id
string<uuid>
required

The unique identifier of the dispute

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Details of the simulated dispute action

Create an action against a disputed ACH transaction

Response

201
application/json

Successfully simulated dispute action

The response is of type object.