Skip to main content
An External Payment Instrument represents a payment instrument that an organization can use to receive payouts.
​
id
string
Unique identifier for the payment instrument
​
alias
string
required
User-friendly name for the payment instrument
​
currency
string
Currency code (see Currency Symbols)
​
method
string
Payment method type (see Payment Methods)
​
status
object
Current status information
​
status.current_status
string
Current status (see External Payment Instrument Statuses)
​
status.status_history
object[]
Historical record of status changes
​
status.status_history[].status
string
The status value for this history entry
​
status.status_history[].created_at
string
Timestamp when this status change occurred
​
details
object
Payment method-specific details. Structure varies by method type.
​
created_at
string
Timestamp when the payment instrument was initially created
​
updated_at
string
When the payment instrument was last updated