Skip to content
Stainless Stainless Stainless SDKs

External Payments

External Payments

Last updated: (timestamp)

External Payments

external_payments
Methods
Create external payment
post/v1/external_payments

Create external payment

Get external payment
get/v1/external_payments/{external_payment_token}

Get external payment

List external payments
get/v1/external_payments

List external payments

Cancel external payment
post/v1/external_payments/{external_payment_token}/cancel

Cancel external payment

Release external payment
post/v1/external_payments/{external_payment_token}/release

Release external payment

Reverse external payment
post/v1/external_payments/{external_payment_token}/reverse

Reverse external payment

Settle external payment
post/v1/external_payments/{external_payment_token}/settle

Settle external payment

Domain Types
External Payment
ExternalPaymentobject
ShowShow
tokenstring
formatuuid
categoryenum
Accepts one of the following: "EXTERNAL_WIRE", "EXTERNAL_ACH", "EXTERNAL_CHECK", "EXTERNAL_TRANSFER"
Hide ParametersShow Parameters
"EXTERNAL_WIRE"
"EXTERNAL_ACH"
"EXTERNAL_CHECK"
"EXTERNAL_TRANSFER"
createdstring
formatdate-time
currencystring
eventsarray of object
Hide ParametersShow Parameters
tokenstring
formatuuid
amountnumber
createdstring
formatdate-time
detailed_resultsarray of enum
Hide ParametersShow Parameters
"APPROVED"
effective_datestring
formatdate
memostring
resultenum
Accepts one of the following: "APPROVED", "DECLINED"
Hide ParametersShow Parameters
"APPROVED"
"DECLINED"
typeenum
Accepts one of the following: "EXTERNAL_WIRE_INITIATED", "EXTERNAL_WIRE_CANCELED", "EXTERNAL_WIRE_SETTLED", 17 more
Hide ParametersShow Parameters
"EXTERNAL_WIRE_INITIATED"
"EXTERNAL_WIRE_CANCELED"
"EXTERNAL_WIRE_SETTLED"
"EXTERNAL_WIRE_REVERSED"
"EXTERNAL_WIRE_RELEASED"
"EXTERNAL_ACH_INITIATED"
"EXTERNAL_ACH_CANCELED"
"EXTERNAL_ACH_SETTLED"
"EXTERNAL_ACH_REVERSED"
"EXTERNAL_ACH_RELEASED"
"EXTERNAL_TRANSFER_INITIATED"
"EXTERNAL_TRANSFER_CANCELED"
"EXTERNAL_TRANSFER_SETTLED"
"EXTERNAL_TRANSFER_REVERSED"
"EXTERNAL_TRANSFER_RELEASED"
"EXTERNAL_CHECK_INITIATED"
"EXTERNAL_CHECK_CANCELED"
"EXTERNAL_CHECK_SETTLED"
"EXTERNAL_CHECK_REVERSED"
"EXTERNAL_CHECK_RELEASED"
financial_account_tokenstring
formatuuid
payment_typeenum
Accepts one of the following: "DEPOSIT", "WITHDRAWAL"
Hide ParametersShow Parameters
"DEPOSIT"
"WITHDRAWAL"
pending_amountnumber
resultenum
Accepts one of the following: "APPROVED", "DECLINED"
Hide ParametersShow Parameters
"APPROVED"
"DECLINED"
settled_amountnumber
statusenum
Accepts one of the following: "PENDING", "SETTLED", "DECLINED", 2 more
Hide ParametersShow Parameters
"PENDING"
"SETTLED"
"DECLINED"
"REVERSED"
"CANCELED"
updatedstring
formatdate-time
user_defined_idstring
optional