Settle
Settle external payment
post/v1/external_payments/{external_payment_token}/settle
Settle external payment
Path Parameters
external_payment_tokenstring
formatuuid
Body Parameters
effective_datestring
formatdate
memostring
optional
progress_toenum
optional
Accepts one of the following: "SETTLED", "RELEASED"
Returns
tokenstringcategoryenumcreatedstringcurrencystringeventsarray of objectfinancial_account_tokenstringpayment_typeenumpending_amountnumberresultenumsettled_amountnumberstatusenumupdatedstringuser_defined_idstringExternalPayment
Request example Request
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"
}'200 Example
{
"token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"category": "EXTERNAL_WIRE",
"created": "2019-12-27T18:11:19.117Z",
"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"
}
],
"financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"payment_type": "DEPOSIT",
"pending_amount": 0,
"result": "APPROVED",
"settled_amount": 0,
"status": "PENDING",
"updated": "2019-12-27T18:11:19.117Z",
"user_defined_id": "user_defined_id"
}