Lithic API Documentation | External Payments

External Payments

external_payments

Methods

List External Payments -> CursorPage<

ExternalPayment

get/v1/external_payments

List external payments

Create External Payment ->

ExternalPayment

post/v1/external_payments

Create external payment

Get External Payment ->

ExternalPayment

get/v1/external_payments/{external_payment_token}

Get external payment

Settle External Payment ->

ExternalPayment

post/v1/external_payments/{external_payment_token}/settle

Settle external payment

path Parameters

external_payment_token: string

(format: uuid)

Response fields

ExternalPayment

Request example

curl https://api.lithic.com/v1/external_payments/$EXTERNAL_PAYMENT_TOKEN/settle \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
          "effective_date": "2019-12-27"
        }'

200Example

{
  "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created": "2019-12-27T18:11:19.117Z",
  "status": "PENDING",
  "updated": "2019-12-27T18:11:19.117Z",
  "category": "EXTERNAL_WIRE",
  "currency": "currency",
  "events": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "amount": 0,
      "created": "2019-12-27T18:11:19.117Z",
      "detailed_results": [
        "APPROVED"
      ],
      "effective_date": "2019-12-27",
      "memo": "memo",
      "result": "APPROVED",
      "type": "EXTERNAL_WIRE_INITIATED"
    }
  ],
  "family": "EXTERNAL_PAYMENT",
  "financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "payment_type": "DEPOSIT",
  "pending_amount": 0,
  "result": "APPROVED",
  "settled_amount": 0,
  "user_defined_id": "user_defined_id"
}

Release External Payment ->

ExternalPayment

post/v1/external_payments/{external_payment_token}/release

Release external payment

Cancel External Payment ->

ExternalPayment

post/v1/external_payments/{external_payment_token}/cancel

Cancel external payment

Reverse External Payment ->

ExternalPayment

post/v1/external_payments/{external_payment_token}/reverse

Reverse external payment

Domain types

ExternalPayment = { token, created, status, 11 more... }