Shared type definitions for the Wise Platform API.
All domain types are represented as plain maps with atom keys. This module documents the shapes used throughout the library.
Summary
Types
Wise address ID
Money amount with currency
Wise balance ID
Balance type
Wise batch group ID
Wise card order ID
Card status
Wise card token
Card type
Wise support case ID
Wise dispute ID
Wise KYC review ID
Successful API result with no body
Pagination parameters
Wise profile ID
Profile type: personal or business
Wise quote UUID
Wise recipient account ID
Successful API result
Wise transfer ID
Transfer status
Wise user ID
Webhook event type
Wise webhook subscription ID
Types
@type address_id() :: pos_integer()
Wise address ID
Money amount with currency
@type balance_id() :: pos_integer()
Wise balance ID
@type balance_type() :: :STANDARD | :SAVINGS
Balance type
@type batch_group_id() :: String.t()
Wise batch group ID
@type card_order_id() :: String.t()
Wise card order ID
@type card_status() :: :ACTIVE | :INACTIVE | :FROZEN | :BLOCKED
Card status
@type card_token() :: String.t()
Wise card token
@type card_type() :: :PHYSICAL | :VIRTUAL
Card type
@type case_id() :: String.t()
Wise support case ID
@type dispute_id() :: String.t()
Wise dispute ID
@type kyc_review_id() :: String.t()
Wise KYC review ID
@type ok_result() :: {:ok, :ok} | {:error, Wise.Error.t()}
Successful API result with no body
@type page_params() :: %{ optional(:limit) => pos_integer(), optional(:offset) => non_neg_integer(), optional(:cursor) => String.t() }
Pagination parameters
@type profile_id() :: pos_integer()
Wise profile ID
@type profile_type() :: :personal | :business
Profile type: personal or business
@type quote_id() :: String.t()
Wise quote UUID
@type recipient_id() :: pos_integer()
Wise recipient account ID
@type result(t) :: {:ok, t} | {:error, Wise.Error.t()}
Successful API result
@type transfer_id() :: pos_integer()
Wise transfer ID
@type transfer_status() ::
:draft
| :pending_customer_input
| :processing
| :funds_converted
| :outgoing_payment_sent
| :canceled
| :funds_refunded
| :bounced_back
| :charged_back
Transfer status
@type user_id() :: pos_integer()
Wise user ID
@type webhook_event_type() :: String.t()
Webhook event type
@type webhook_subscription_id() :: String.t()
Wise webhook subscription ID