External Payment Token

Attributes

• uuid: Globally unique identifier for the external payment
• memo: string
• effective_date: date (required)

Response Structure

200 OK

• status: string (enum, required)
  • Possible values: PENDING, SETTLED, DECLINED, REVERSED, CANCELED, RETURNED
• token: uuid (required)
• created: date-time (required, ISO 8601 timestamp of creation)
• updated: date-time (required)
• family: const (enum, required)
  • Value: EXTERNAL_PAYMENT
• result: string (enum, required)
  • Possible values: APPROVED, DECLINED
• category: string (enum, required)
  • Possible values: EXTERNAL_WIRE, EXTERNAL_ACH, EXTERNAL_CHECK, EXTERNAL_FEDNOW, EXTERNAL_RTP, EXTERNAL_TRANSFER
• settled_amount: integer (required)
• pending_amount: integer (required)
• currency: string (required)
• events: array of objects (required)

Event Object Structure

• amount: integer (required)
• type: string (enum, required)
  • Possible values: EXTERNAL_WIRE_INITIATED, EXTERNAL_WIRE_CANCELED, EXTERNAL_WIRE_SETTLED, EXTERNAL_WIRE_REVERSED, EXTERNAL_WIRE_RELEASED, EXTERNAL_ACH_INITIATED, EXTERNAL_ACH_CANCELED, EXTERNAL_ACH_SETTLED, EXTERNAL_ACH_REVERSED, EXTERNAL_ACH_RELEASED, EXTERNAL_TRANSFER_INITIATED, EXTERNAL_TRANSFER_CANCELED, EXTERNAL_TRANSFER_SETTLED, EXTERNAL_TRANSFER_REVERSED, EXTERNAL_TRANSFER_RELEASED, EXTERNAL_CHECK_INITIATED, EXTERNAL_CHECK_CANCELED, EXTERNAL_CHECK_SETTLED, EXTERNAL_CHECK_REVERSED, EXTERNAL_CHECK_RELEASED, EXTERNAL_FEDNOW_INITIATED, EXTERNAL_FEDNOW_CANCELED, EXTERNAL_FEDNOW_SETTLED, EXTERNAL_FEDNOW_REVERSED, EXTERNAL_FEDNOW_RELEASED, EXTERNAL_RTP_INITIATED, EXTERNAL_RTP_CANCELED, EXTERNAL_RTP_SETTLED, EXTERNAL_RTP_REVERSED, EXTERNAL_RTP_RELEASED
• result: string (enum, required)
  • Possible values: APPROVED, DECLINED
• detailed_results: array of objects (required)

Additional Attributes

• created: date-time (required)
• token: uuid (required)
• memo: string (required)
• effective_date: date (required)
• user_defined_id: string | null
• financial_account_token: uuid (required)
• payment_type: string (enum, required)
  • Possible values: DEPOSIT, WITHDRAWAL

Common Error Responses

400 Bad Request

A parameter in the query does not match the valid queries for the endpoint.

401 Unauthorized

• User has not been authenticated
• Invalid or missing API key
• API key is not active
• Could not find API key
• Please provide API key in the Authorization header
• Insufficient privileges. Issuing API key required.
• Insufficient privileges to create virtual cards.

404 Not Found

The specified resource was not found.

429 Too Many Requests

• Client has exceeded the number of allowed requests.

Example: Curl Request

curl --request POST \
     --url https://sandbox.lithic.com/v1/external_payments/external_payment_token/release \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "memo": "string",
  "effective_date": "2026-07-18"
}'

Example Response

{
  "status": "PENDING",
  "token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created": "2026-07-18T00:25:32.120Z",
  "updated": "2026-07-18T00:25:32.120Z",
  "family": "string",
  "result": "APPROVED",
  "category": "EXTERNAL_WIRE",
  "settled_amount": 0,
  "pending_amount": 0,
  "currency": "string",
  "events": [
    {
      "amount": 0,
      "type": "EXTERNAL_WIRE_INITIATED",
      "result": "APPROVED",
      "detailed_results": ["APPROVED"],
      "created": "2026-07-18T00:25:32.120Z",
      "token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "memo": "string",
      "effective_date": "2026-07-18"
    }
  ],
  "user_defined_id": "string",
  "financial_account_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "payment_type": "DEPOSIT"
}