Sign in

v66

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-042174421.1 MB
External Payments

Settle external payment

Settle external payment

post/v1/external_payments/{external_payment_token}/settle

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

status'PENDING' | 'SETTLED' | 'DECLINED' | 'REVERSED' | 'CANCELED' | 'RETURNED' required
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

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_TRANSFER' required
settled_amountinteger required
pending_amountinteger required
currencystring required
user_defined_idstring nullable
financial_account_tokenstring uuid required
payment_type'DEPOSIT' | 'WITHDRAWAL' required