Skip to content
Stainless Stainless Stainless SDKs

Simulate Action

Simulate payment lifecycle event
post/v1/simulate/payments/{payment_token}/action

Simulate payment lifecycle event

Path Parameters
payment_tokenstring
formatuuid
Body Parameters
event_typeenum
Accepts one of the following: "ACH_ORIGINATION_REVIEWED", "ACH_ORIGINATION_RELEASED", "ACH_ORIGINATION_PROCESSED", 5 more

Event Type

Hide ParametersShow Parameters
"ACH_ORIGINATION_REVIEWED"
"ACH_ORIGINATION_RELEASED"
"ACH_ORIGINATION_PROCESSED"
"ACH_ORIGINATION_SETTLED"
"ACH_RECEIPT_SETTLED"
"ACH_RETURN_INITIATED"
"ACH_RETURN_PROCESSED"
"ACH_RETURN_SETTLED"
decline_reasonenum
optional
Accepts one of the following: "PROGRAM_TRANSACTION_LIMIT_EXCEEDED", "PROGRAM_DAILY_LIMIT_EXCEEDED", "PROGRAM_MONTHLY_LIMIT_EXCEEDED"

Decline reason

Hide ParametersShow Parameters
"PROGRAM_TRANSACTION_LIMIT_EXCEEDED"
"PROGRAM_DAILY_LIMIT_EXCEEDED"
"PROGRAM_MONTHLY_LIMIT_EXCEEDED"
return_reason_codestring
optional

Return Reason Code

Returns
debugging_request_idstring

Debugging Request Id

formatuuid
resultenum
Accepts one of the following: "APPROVED", "DECLINED"

Request Result

Hide ParametersShow Parameters
"APPROVED"
"DECLINED"
transaction_event_tokenstring

Transaction Event Token

formatuuid
Request example Request
curl https://api.lithic.com/v1/simulate/payments/$PAYMENT_TOKEN/action \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
      "event_type": "ACH_ORIGINATION_REVIEWED"
    }'
200 Example
{
  "debugging_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "result": "APPROVED",
  "transaction_event_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}