Simulate Return

Simulate return payment

post/v1/simulate/payments/return

Simulates a return of a Payment.

Body Parameters

payment_tokenstring

Payment Token

formatuuid

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/return \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
      "payment_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "return_reason_code": "R12"
    }'

200 Example

{
  "debugging_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "result": "APPROVED",
  "transaction_event_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}