External Payment Token

Schema

Fields

• uuid
  Type: required
  Description: Globally unique identifier for the external payment.

• memo
  Type: string

• effective_date
  Type: required date

• progress_to
  Type: string
  Enum: SETTLED, RELEASED
  Allowed: SETTLED, RELEASED

Response

200 OK

Type: object
Description: Base class for all transaction types in the ledger service

• status
  Type: required string
  Description: The status of the transaction
  Enum: PENDING, SETTLED, DECLINED, REVERSED, CANCELED, RETURNED

• token
  Type: required uuid
  Description: Unique identifier for the transaction

• created
  Type: required date-time
  Description: ISO 8601 timestamp of when the transaction was created

• updated
  Type: required date-time
  Description: ISO 8601 timestamp of when the transaction was last updated

• family
  Type: required const enum
  Description: External Payment Response
  Allowed: EXTERNAL_PAYMENT

• result
  Type: required string
  Enum: APPROVED, DECLINED

• category
  Type: required string
  Enum: EXTERNAL_WIRE, EXTERNAL_ACH, EXTERNAL_CHECK, EXTERNAL_FEDNOW, EXTERNAL_RTP, EXTERNAL_TRANSFER

• settled_amount
  Type: required integer

• pending_amount
  Type: required integer

• currency
  Type: required string

• events
  Type: required array of objects

  • events
    Type: object
    • amount
      Type: required integer
    • type
      Type: required string
      Enum: 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
      Type: required string
      Enum: APPROVED, DECLINED
    • detailed_results
      Type: required array of objects
    • created
      Type: required date-time
    • token
      Type: required uuid
    • memo
      Type: required string
    • effective_date
      Type: required date

• user_defined_id
  Type: string | null

• financial_account_token
  Type: required uuid

• payment_type
  Type: required string
  Enum: DEPOSIT, WITHDRAWAL

Errors

400

Description: A parameter in the query given in the request does not match the valid queries for the endpoint.

401

Description: User has not been authenticated

404

Description: The specified resource was not found.

429

Description: Client has exceeded the number of allowed requests in a given time period.

Example Request

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

### Example Response
```json
{
  "status": "PENDING",
  "token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created": "2026-07-18T00:25:31.588Z",
  "updated": "2026-07-18T00:25:31.588Z",
  "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:31.588Z",
      "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"
}