Skip to main content
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

  • ACH Action
  • Card Action
  • External Card Action

Create an action against a disputed ACH transaction

​
action
enum<string>
required
Available options:
ACH_RETURN,
STOP_PAYMENT
​
payment_rail
enum<string>
required

A short string representing the payment rail of the dispute.

Available options:
ACH,
CARD,
EXTERNAL_CARD
​
state
enum<string>
required
Available options:
ACCEPT,
CREATE,
MORE_INFO_REQUIRED,
REJECT
​
message
string

Message text related to ACH dispute action

  • Max length for debit transactions is 38 characters
Maximum length: 100
​
reason_code
enum<string>
Reason CodeDescription
UNAUTHORIZED_TRANSACTIONA party claims that a transaction was not authorized by the account holder
INCORRECT_TRANSACTION_AMOUNTThe amount of the ACH transaction does not match the agreed-upon or expected amount.
DUPLICATE_TRANSACTIONThe same transaction is processed more than once, leading to duplicate charges.
MISTIMED_WITHDRAWALThe timing of the transaction is not in accordance with the agreed-upon schedule, leading to a dispute.
TRANSACTION_NOT_RECOGNIZEDThe account holder does not recognize the transaction, possibly due to a mistake or fraudulent activity
Available options:
DUPLICATE_TRANSACTION,
INCORRECT_TRANSACTION_AMOUNT,
MISTIMED_WITHDRAWAL,
TRANSACTION_NOT_RECOGNIZED,
UNAUTHORIZED_TRANSACTION
​
return_code
enum<string>

This field is required for dispute action ACH_RETURN. Upon successful dispute resolution this return code will be used when sending the outgoing return.

Available options:
R05,
R07,
R10,
R29,
R34,
R51
​
supporting_doc_id
string<uuid>

The unique identifier of the supporting document

Example:

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

Response

Successfully simulated dispute action

  • ACH Action
  • External Card Action
  • Card Action

Response for an ACH dispute action.

​
action
enum<string>
required
Available options:
ACH_RETURN,
STOP_PAYMENT
​
creation_time
string<date-time>
required

The date and time the resource was created.

Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>
required

The unique identifier of the dispute action

Example:

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

​
payment_rail
enum<string>
required

A short string representing the payment rail of the dispute.

Available options:
ACH,
CARD,
EXTERNAL_CARD
​
status
enum<string>
required
StatusDescription
SUBMITTEDThe action has been submitted
ACCEPTEDThe action has been accepted
REJECTEDThe action has been rejected
MORE_INFO_REQUIREDThe action contains a directive that more information is required
Available options:
ACCEPTED,
MORE_INFO_REQUIRED,
REJECTED,
SUBMITTED
​
tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
message
string

Message text related to card dispute action

Maximum length: 100
​
reason_code
enum<string>
Reason CodeDescription
UNAUTHORIZED_TRANSACTIONA party claims that a transaction was not authorized by the account holder
INCORRECT_TRANSACTION_AMOUNTThe amount of the ACH transaction does not match the agreed-upon or expected amount.
DUPLICATE_TRANSACTIONThe same transaction is processed more than once, leading to duplicate charges.
MISTIMED_WITHDRAWALThe timing of the transaction is not in accordance with the agreed-upon schedule, leading to a dispute.
TRANSACTION_NOT_RECOGNIZEDThe account holder does not recognize the transaction, possibly due to a mistake or fraudulent activity
Available options:
DUPLICATE_TRANSACTION,
INCORRECT_TRANSACTION_AMOUNT,
MISTIMED_WITHDRAWAL,
TRANSACTION_NOT_RECOGNIZED,
UNAUTHORIZED_TRANSACTION
​
return_code
enum<string>

This field is required for dispute action ACH_RETURN. Upon successful dispute resolution this return code will be used when sending the outgoing return.

Available options:
R05,
R07,
R10,
R29,
R34,
R51
​
supporting_doc_id
string<uuid>

The unique identifier of the supporting document

Example:

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