External Payments

Settle external payment

Changed on

Settle external payment

post/v1/external_payments/{external_payment_token}/settle

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/external_payments/{external_payment_token}/settle
  • Auth
    API key in header Authorization

Path parameters

external_payment_tokenstring uuid required

Globally unique identifier for the external payment

Request body

memostring
effective_datestring date required
progress_to'SETTLED' | 'RELEASED'

Response

OK

tokenstring uuid required

Unique identifier for the transaction

createdstring date-time required

ISO 8601 timestamp of when the transaction was created

updatedstring date-time required

ISO 8601 timestamp of when the transaction was last updated

status'PENDING' | 'SETTLED' | 'DECLINED' | 'REVERSED' | 'CANCELED' | 'RETURNED' required
family'EXTERNAL_PAYMENT' required

EXTERNAL_PAYMENT - External Payment Response

result'APPROVED' | 'DECLINED' required
category'EXTERNAL_WIRE' | 'EXTERNAL_ACH' | 'EXTERNAL_CHECK' | 'EXTERNAL_FEDNOW' | 'EXTERNAL_RTP' | 'EXTERNAL_STABLECOIN' | 'EXTERNAL_TRANSFER' required
settled_amountinteger required
pending_amountinteger required
currencystring required
user_defined_idstring nullable
financial_account_tokenstring uuid required
payment_type'DEPOSIT' | 'WITHDRAWAL' required

Changes

  • 9798275dc379Revision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added subschema #2 to the response property allOf list for the response status

  • 9b03f0754e37Revision changes
    • warning

      added the new EXTERNAL_STABLECOIN enum value to the / response property for the response status

    • warning

      added the new EXTERNAL_STABLECOIN_CANCELED enum value to the /// response property for the response status

    • warning

      added the new EXTERNAL_STABLECOIN_INITIATED enum value to the /// response property for the response status

    • warning

      added the new EXTERNAL_STABLECOIN_RELEASED enum value to the /// response property for the response status

    • warning

      added the new EXTERNAL_STABLECOIN_REVERSED enum value to the /// response property for the response status

    • warning

      added the new EXTERNAL_STABLECOIN_SETTLED enum value to the /// response property for the response status