External Payments
Create external payment
Create external payment
post/v1/external_payments
Request body
category'EXTERNAL_WIRE' | 'EXTERNAL_ACH' | 'EXTERNAL_CHECK' | 'EXTERNAL_FEDNOW' | 'EXTERNAL_RTP' | 'EXTERNAL_TRANSFER' required
financial_account_tokenstring uuid required
amountinteger required
memostring
user_defined_idstring
effective_datestring date required
tokenstring uuid
Customer-provided token that will serve as an idempotency token. This token will become the transaction token.
payment_type'DEPOSIT' | 'WITHDRAWAL' 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