Payment Token

• uuid
  • required
  • Description: Payment Token

Return Reason Code

• string
  • Pattern: ^R[0-9][0-9]$
  • Defaults to: R01

200 Created

• object
  • result
    • string
    • enum
    • required
  • transaction_event_token
    • uuid
    • required
  • debugging_request_id
    • uuid
    • required

Errors

• 400 A parameter in the query given in the request does not match the valid queries for the endpoint.

• 401 User has not been authenticated.

  • Invalid or missing API key
  • API key is not active. The API key used is no longer active.
  • Could not find API key. The API key provided is not associated with any user.
  • Please provide API key in Authorization header. The Authorization header is not in the request.
  • Please provide API key in the form Authorization: [api-key]. The Authorization header is not formatted properly.
  • Insufficient privileges. Issuing API key required. Write access requires an Issuing API key. Reach out at lithic.com/contact.
  • Insufficient privileges to create virtual cards. Creating virtual cards requires an additional privilege.

• 404 The specified resource was not found.

• 429 Client has exceeded the number of allowed requests in a given time period.

  • Rate limited, too many requests per second. User has exceeded their per second rate limit.
  • Rate limited, reached daily limit. User has exceeded their daily rate limit.
  • Rate limited, too many keys tried. One IP has queried too many different API keys.

Example Curl Command

curl --request POST \
     --url https://sandbox.lithic.com/v1/simulate/payments/return \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "payment_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "return_reason_code": "R01"
}'

Example Response

{
  "result": "APPROVED",
  "transaction_event_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "debugging_request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}