First Leeward

Activities

List activities

GEThttps://api.firstleeward.com/v0/activities

Retrieves a paginated, chronologically ordered list of fund movements. Supports filtering by resource identifiers, activity type, time window, and status.

Authorizations

Authorizationstring · headerrequired

API key as Bearer token, e.g. Bearer YOUR_API_KEY

Headers

Leeward-Versionenum<string>required

API version (YYYY-MM-DD). Available option: 2026-09-18

Query Parameters

limitintegerdefault: 20

Maximum number of items to return (1-100, default: 20)

cursorstring

Opaque cursor for pagination. Pass nextCursor from previous response to get next page.

accountIdstring<uuid>[]

Filter activities by account ID(s) (comma-separated)

cardIdstring<uuid>[]

Filter card transactions by card ID(s) (comma-separated). Refines which card transactions are returned without excluding other activity types - combine with type=CARD_TRANSACTION to see one card's transactions alone.

typestring[]

Restrict the feed to one or more activity types (comma-separated). This is the only parameter that controls which types appear; every other filter refines its own type without excluding the others. Defaults to every type.

Available options:CRYPTO_DEPOSITCRYPTO_WITHDRAWALFIAT_DEPOSITCARD_TRANSACTIONPOSTING
cryptoDepositStatusstring[]

Filter crypto deposits by status (comma-separated). Refines which crypto deposits are returned without excluding other activity types - combine with type=CRYPTO_DEPOSIT to see deposits alone.

Available options:PENDINGCONFIRMEDAPPROVEDREJECTED
cryptoWithdrawalStatusstring[]

Filter crypto withdrawals by status (comma-separated). Refines which crypto withdrawals are returned without excluding other activity types - combine with type=CRYPTO_WITHDRAWAL to see withdrawals alone.

Available options:PENDING_SIGNATUREPROCESSINGCOMPLETEDEXPIREDCANCELLEDFAILED
cardTransactionStatusstring[]

Filter card transactions by status (comma-separated). Refines which card transactions are returned without excluding other activity types - combine with type=CARD_TRANSACTION to see transactions alone.

Available options:PENDINGCLEAREDDECLINEDVOID
virtualAssetIdstring<uuid>[]

Filter postings by virtual asset ID(s) (comma-separated). Matches postings that contain at least one entry against any of the given virtual assets. Refines which postings are returned without excluding other activity types - combine with type=POSTING to see postings alone.

sincestring<date-time>

Inclusive lower bound on activity time (occurredAt). ISO 8601 datetime.

Response

200Response for status 200
itemsobject[]required
Show child attributes
Option 1 · CryptoDepositActivity
typestringrequired
idstring<uuid>required

Activity resource identifier

occurredAtstringrequired

ISO 8601 timestamp used for chronological ordering

dataobjectrequired
Show child attributes
idstring<uuid>required

Unique deposit identifier

accountIdstring<uuid>required

Account that received the deposit

chainIdstringrequired

Blockchain network identifier

Available options:ETHEREUM_MAINNETETHEREUM_SEPOLIABASE_MAINNETBASE_SEPOLIAARBITRUM_ONE_MAINNETARBITRUM_ONE_SEPOLIAPOLYGON_MAINNETPOLYGON_AMOYSOLANA_MAINNETSOLANA_DEVNET
transactionIdstringrequired

On-chain transaction hash/signature

statusstringrequired

Current deposit status

Available options:PENDINGCONFIRMEDAPPROVEDREJECTED
rejectionReasonstring | nullrequired

Reason for rejection (only when status is REJECTED)

Available options:TRANSACTION_FAILEDASSET_NOT_ACCEPTEDKYT_CHECK_FAILEDAMOUNT_TOO_SMALL
amountstringrequired

Amount with decimals applied (string for full precision)

feeAmountstring | nullrequired

Deposit fee charged on this deposit, in the same asset as amount. null when the deposit is not subject to a deposit fee

senderAddressstringrequired

Address that sent the deposit

occurredAtstring | nullrequired

ISO 8601 timestamp of on-chain transfer

createdAtstringrequired

ISO 8601 timestamp of creation

updatedAtstringrequired

ISO 8601 timestamp of last update

assetobjectrequired

Asset metadata

Show child attributes
symbolstringrequired

Asset symbol

namestring | nullrequired

Full asset name

decimalsintegerrequired

Number of decimal places

logoUristring | nullrequired

URI to asset logo image

Option 2 · CryptoWithdrawalActivity
typestringrequired
idstring<uuid>required

Activity resource identifier

occurredAtstringrequired

ISO 8601 timestamp used for chronological ordering

dataobjectrequired
Show child attributes
idstring<uuid>required

Unique withdrawal identifier

accountIdstring<uuid>required

Account the funds are withdrawn from

chainIdstringrequired

Blockchain network the transfer happens on

Available options:ETHEREUM_MAINNETETHEREUM_SEPOLIABASE_MAINNETBASE_SEPOLIAARBITRUM_ONE_MAINNETARBITRUM_ONE_SEPOLIAPOLYGON_MAINNETPOLYGON_AMOYSOLANA_MAINNETSOLANA_DEVNET
assetobjectrequired

Asset metadata

Show child attributes
symbolstringrequired

Asset symbol

namestring | nullrequired

Full asset name

decimalsintegerrequired

Number of decimal places

logoUristring | nullrequired

URI to asset logo image

amountstringrequired

Gross amount requested, with decimals applied. The fee is taken out of this rather than charged on top.

netAmountstringrequired

Amount the destination receives: the gross less the fee

feeobjectrequired

Fee charged for the withdrawal, fixed at the time it was requested

Show child attributes
amountstringrequired

Fee retained, with decimals applied

assetobjectrequired

Asset metadata

Show child attributes
symbolstringrequired

Asset symbol

namestring | nullrequired

Full asset name

decimalsintegerrequired

Number of decimal places

logoUristring | nullrequired

URI to asset logo image

destinationAddressstringrequired

Address the funds are sent to

statusstringrequired

Current withdrawal status

Available options:PENDING_SIGNATUREPROCESSINGCOMPLETEDEXPIREDCANCELLEDFAILED
failureReasonstring | nullrequired

What went wrong. Set only when the status is FAILED.

Available options:REJECTED_BY_COMPLIANCEACCOUNT_RESTRICTEDTRANSACTION_FAILED
transactionIdstring | nullrequired

On-chain transaction identifier. Present once the transfer has been submitted to the network, which happens while the status is still PROCESSING.

expiresAtstringrequired

When the signature window closes. Past this point the withdrawal is closed and the funds become spendable again.

completedAtstring | nullrequired

When the transfer was observed to be irreversible on-chain, which is when the status became COMPLETED. Null until then.

createdAtstringrequired

ISO 8601 creation timestamp

updatedAtstringrequired

ISO 8601 last update timestamp

Option 3 · FiatDepositActivity
typestringrequired
idstring<uuid>required

Activity resource identifier

occurredAtstringrequired

ISO 8601 timestamp used for chronological ordering

dataobjectrequired
Show child attributes
idstring<uuid>required

Unique fiat deposit identifier

accountIdstring<uuid>required

Account credited by the deposit

transactionIdstringrequired

The bank's unique identifier for the incoming transfer. Use it to reconcile the deposit against a bank statement.

statusstringrequired

Current deposit status

Available options:SETTLED
amountnumberrequired

Amount credited to the account balance

currencystringrequired

Currency the credit was applied in

originalAmountnumberrequired

Amount of the incoming transfer, as received by the bank

originalCurrencystringrequired

Currency the transfer was sent in, as the bank reported it. A transfer must be sent in the billing currency of your card program.

senderNamestring | nullrequired

Name of the sender, when the bank reported one

referencestring | nullrequired

Reference the sender attached to the transfer, when present

occurredAtstringrequired

ISO 8601 timestamp of when the bank received the transfer

createdAtstringrequired

ISO 8601 timestamp of creation

updatedAtstringrequired

ISO 8601 timestamp of last update

Option 4 · CardTransactionActivity
typestringrequired
idstring<uuid>required

Activity resource identifier

occurredAtstringrequired

ISO 8601 timestamp used for chronological ordering

dataobjectrequired

Card transaction resource. The response shape varies by transaction status.

Show child attributes
Option 1 · PendingCardTransaction
idstring<uuid>required

Card transaction identifier

accountIdstring<uuid>required

Account linked to the card

cardIdstring<uuid>required

Card used for this transaction

channelstringrequired

Transaction channel

Available options:ATMPOSECOMMERCEVISA_DIRECT
digitalWalletstring | nullrequired

Digital wallet used, or null if physical card

Available options:APPLE_PAYGOOGLE_PAYMERCHANT_TOKEN
originalCurrencystringrequired

Original transaction currency (merchant local currency)

currencystringrequired

Card currency

merchantobjectrequired

Merchant details

Show child attributes
idstring<uuid>required

Identifier of the merchant details recorded on this transaction. Not a stable merchant identifier: the same merchant has a different id on each transaction, so do not use it to identify or group merchants. Use cardAcceptorId instead.

cardAcceptorIdstring | nullrequired

Card acceptor ID (often called the merchant ID or MID), assigned by the merchant's acquirer and passed on by the card network. It is unique only within one acquirer, and one merchant can have several (for example one per terminal). Combine it with name, country, and mccCode when matching merchants. null when the network did not provide one.

namestringrequired

Merchant name

citystring | nullrequired

Merchant city

postCodestring | nullrequired

Merchant postal or ZIP code

statestring | nullrequired

Merchant state or province

countrystring

ISO 3166-1 alpha-2 country code

mccCodestringrequired

Merchant Category Code

mccCategorystringrequired

MCC category description

feesobjectrequired

Cardholder fee breakdown in the card billing currency. Always present; zeros when no fee applied.

Show child attributes
atmnumberrequired

ATM withdrawal markup charged to the cardholder (card currency)

fxnumberrequired

FX markup charged to the cardholder (card currency)

eventsobject[]required

Chronologically sorted lifecycle events (oldest first). Provides the full audit trail of what happened to this transaction.

Show child attributes
idstring<uuid>required

Event identifier

typestringrequired

Lifecycle event type. DISPUTE_REFUND is the credit from a card dispute resolved in favor of the cardholder; like REFUND it gives cleared value back to the cardholder.

Available options:AUTHORIZATIONCLEARINGREVERSALREFUNDDECLINEDISPUTE_REFUND
originalAmountnumberrequired

Event amount in the event-level original currency

originalCurrencystringrequired

Per-event original currency. Usually equals the parent transaction originalCurrency, but can differ when the card network reports a presentment (typically a clearing) in the bill currency instead of the merchant local currency.

amountnumberrequired

Event amount charged to the cardholder (card currency)

feesobjectrequired

Cardholder fee breakdown in the card billing currency. Always present; zeros when no fee applied.

Show child attributes
atmnumberrequired

ATM withdrawal markup charged to the cardholder (card currency)

fxnumberrequired

FX markup charged to the cardholder (card currency)

occurredAtstringrequired

ISO 8601 timestamp of when the event occurred

createdAtstringrequired

ISO 8601 timestamp of when the event was recorded

occurredAtstringrequired

ISO 8601 timestamp of when the transaction was initiated

createdAtstringrequired

ISO 8601 timestamp of creation

updatedAtstringrequired

ISO 8601 timestamp of last update

statusstringrequired
originalAmountobjectrequired

Amount breakdown showing authorized, reversed, and current values

Show child attributes
authorizednumberrequired

Original authorized amount before reversals

reversednumberrequired

Total amount reversed (credited back)

currentnumberrequired

Effective current amount (authorized - reversed, minimum 0)

amountobjectrequired

Amount breakdown showing authorized, reversed, and current values

Show child attributes
authorizednumberrequired

Original authorized amount before reversals

reversednumberrequired

Total amount reversed (credited back)

currentnumberrequired

Effective current amount (authorized - reversed, minimum 0)

conversionRatenumberrequired

Conversion rate from the original currency to the card currency

Option 2 · ClearedCardTransaction
idstring<uuid>required

Card transaction identifier

accountIdstring<uuid>required

Account linked to the card

cardIdstring<uuid>required

Card used for this transaction

channelstringrequired

Transaction channel

Available options:ATMPOSECOMMERCEVISA_DIRECT
digitalWalletstring | nullrequired

Digital wallet used, or null if physical card

Available options:APPLE_PAYGOOGLE_PAYMERCHANT_TOKEN
originalCurrencystringrequired

Original transaction currency (merchant local currency)

currencystringrequired

Card currency

merchantobjectrequired

Merchant details

Show child attributes
idstring<uuid>required

Identifier of the merchant details recorded on this transaction. Not a stable merchant identifier: the same merchant has a different id on each transaction, so do not use it to identify or group merchants. Use cardAcceptorId instead.

cardAcceptorIdstring | nullrequired

Card acceptor ID (often called the merchant ID or MID), assigned by the merchant's acquirer and passed on by the card network. It is unique only within one acquirer, and one merchant can have several (for example one per terminal). Combine it with name, country, and mccCode when matching merchants. null when the network did not provide one.

namestringrequired

Merchant name

citystring | nullrequired

Merchant city

postCodestring | nullrequired

Merchant postal or ZIP code

statestring | nullrequired

Merchant state or province

countrystring

ISO 3166-1 alpha-2 country code

mccCodestringrequired

Merchant Category Code

mccCategorystringrequired

MCC category description

feesobjectrequired

Cardholder fee breakdown in the card billing currency. Always present; zeros when no fee applied.

Show child attributes
atmnumberrequired

ATM withdrawal markup charged to the cardholder (card currency)

fxnumberrequired

FX markup charged to the cardholder (card currency)

eventsobject[]required

Chronologically sorted lifecycle events (oldest first). Provides the full audit trail of what happened to this transaction.

Show child attributes
idstring<uuid>required

Event identifier

typestringrequired

Lifecycle event type. DISPUTE_REFUND is the credit from a card dispute resolved in favor of the cardholder; like REFUND it gives cleared value back to the cardholder.

Available options:AUTHORIZATIONCLEARINGREVERSALREFUNDDECLINEDISPUTE_REFUND
originalAmountnumberrequired

Event amount in the event-level original currency

originalCurrencystringrequired

Per-event original currency. Usually equals the parent transaction originalCurrency, but can differ when the card network reports a presentment (typically a clearing) in the bill currency instead of the merchant local currency.

amountnumberrequired

Event amount charged to the cardholder (card currency)

feesobjectrequired

Cardholder fee breakdown in the card billing currency. Always present; zeros when no fee applied.

Show child attributes
atmnumberrequired

ATM withdrawal markup charged to the cardholder (card currency)

fxnumberrequired

FX markup charged to the cardholder (card currency)

occurredAtstringrequired

ISO 8601 timestamp of when the event occurred

createdAtstringrequired

ISO 8601 timestamp of when the event was recorded

occurredAtstringrequired

ISO 8601 timestamp of when the transaction was initiated

createdAtstringrequired

ISO 8601 timestamp of creation

updatedAtstringrequired

ISO 8601 timestamp of last update

statusstringrequired
originalAmountobjectrequired

Amount breakdown showing cleared, refunded, and current values

Show child attributes
clearednumberrequired

Total settled amount

refundednumberrequired

Total amount refunded, by the merchant (REFUND events) or through a dispute (DISPUTE_REFUND events)

currentnumberrequired

Effective current amount (cleared - refunded, minimum 0)

amountobjectrequired

Amount breakdown showing cleared, refunded, and current values

Show child attributes
clearednumberrequired

Total settled amount

refundednumberrequired

Total amount refunded, by the merchant (REFUND events) or through a dispute (DISPUTE_REFUND events)

currentnumberrequired

Effective current amount (cleared - refunded, minimum 0)

conversionRatenumberrequired

Conversion rate from the original currency to the card currency

Option 3 · DeclinedCardTransaction
idstring<uuid>required

Card transaction identifier

accountIdstring<uuid>required

Account linked to the card

cardIdstring<uuid>required

Card used for this transaction

channelstringrequired

Transaction channel

Available options:ATMPOSECOMMERCEVISA_DIRECT
digitalWalletstring | nullrequired

Digital wallet used, or null if physical card

Available options:APPLE_PAYGOOGLE_PAYMERCHANT_TOKEN
originalCurrencystringrequired

Original transaction currency (merchant local currency)

currencystringrequired

Card currency

merchantobjectrequired

Merchant details

Show child attributes
idstring<uuid>required

Identifier of the merchant details recorded on this transaction. Not a stable merchant identifier: the same merchant has a different id on each transaction, so do not use it to identify or group merchants. Use cardAcceptorId instead.

cardAcceptorIdstring | nullrequired

Card acceptor ID (often called the merchant ID or MID), assigned by the merchant's acquirer and passed on by the card network. It is unique only within one acquirer, and one merchant can have several (for example one per terminal). Combine it with name, country, and mccCode when matching merchants. null when the network did not provide one.

namestringrequired

Merchant name

citystring | nullrequired

Merchant city

postCodestring | nullrequired

Merchant postal or ZIP code

statestring | nullrequired

Merchant state or province

countrystring

ISO 3166-1 alpha-2 country code

mccCodestringrequired

Merchant Category Code

mccCategorystringrequired

MCC category description

feesobjectrequired

Cardholder fee breakdown in the card billing currency. Always present; zeros when no fee applied.

Show child attributes
atmnumberrequired

ATM withdrawal markup charged to the cardholder (card currency)

fxnumberrequired

FX markup charged to the cardholder (card currency)

eventsobject[]required

Chronologically sorted lifecycle events (oldest first). Provides the full audit trail of what happened to this transaction.

Show child attributes
idstring<uuid>required

Event identifier

typestringrequired

Lifecycle event type. DISPUTE_REFUND is the credit from a card dispute resolved in favor of the cardholder; like REFUND it gives cleared value back to the cardholder.

Available options:AUTHORIZATIONCLEARINGREVERSALREFUNDDECLINEDISPUTE_REFUND
originalAmountnumberrequired

Event amount in the event-level original currency

originalCurrencystringrequired

Per-event original currency. Usually equals the parent transaction originalCurrency, but can differ when the card network reports a presentment (typically a clearing) in the bill currency instead of the merchant local currency.

amountnumberrequired

Event amount charged to the cardholder (card currency)

feesobjectrequired

Cardholder fee breakdown in the card billing currency. Always present; zeros when no fee applied.

Show child attributes
atmnumberrequired

ATM withdrawal markup charged to the cardholder (card currency)

fxnumberrequired

FX markup charged to the cardholder (card currency)

occurredAtstringrequired

ISO 8601 timestamp of when the event occurred

createdAtstringrequired

ISO 8601 timestamp of when the event was recorded

occurredAtstringrequired

ISO 8601 timestamp of when the transaction was initiated

createdAtstringrequired

ISO 8601 timestamp of creation

updatedAtstringrequired

ISO 8601 timestamp of last update

statusstringrequired
originalAmountnumberrequired

Attempted transaction amount in the original currency

declineReasonobjectrequired

Reason the transaction was declined

Show child attributes
codestringrequired

Machine-readable decline reason code. Intended for client application logic (routing the cardholder to a top-up screen, prompting for PIN re-entry, ...). Do not display this string to cardholders directly; use message instead, or render your own copy keyed off code.

Available options:INSUFFICIENT_BALANCEINSUFFICIENT_MASTER_BALANCECARD_NOT_ACTIVECARD_NOT_ACTIVATEDCARD_EXPIREDCARD_FROZENCARD_BLOCKEDCARD_REPORTED_LOSTCARD_REPORTED_STOLENACCOUNT_NOT_ACTIVEINCORRECT_PININCORRECT_CVVINVALID_CARD_DETAILSCONTACTLESS_NOT_SUPPORTEDTERMINAL_ERRORCASH_SERVICE_NOT_AVAILABLEWITHDRAWALS_NOT_ALLOWEDATM_WITHDRAWAL_LIMIT_EXCEEDEDATM_WITHDRAWAL_FREQUENCY_EXCEEDEDMERCHANT_CARD_TYPE_MISMATCHMERCHANT_CATEGORY_CODE_NOT_ALLOWEDTRANSACTION_TYPE_NOT_ALLOWEDMERCHANT_NOT_ALLOWEDCHANNEL_NOT_ALLOWEDTRANSACTION_AMOUNT_LIMIT_EXCEEDEDSPEND_LIMIT_EXCEEDEDAUTHORIZATION_COUNT_LIMIT_EXCEEDEDTRANSACTION_NOT_ALLOWEDNETWORK_DECLINESUSPECTED_FRAUDINTERNAL_ERROR
messagestringrequired

Cardholder-facing description of the decline reason. Safe to render directly in your UI as a sensible default.

policyobject | nullrequired

The policy that caused the decline, or null if the transaction was declined for another reason (e.g. insufficient funds).

Show child attributes
idstringrequired

ID of the policy that declined the transaction. A UUID for your policies; a stable identifier for platform policies.

typestringrequired
Available options:MERCHANT_RESTRICTIONCHANNEL_RESTRICTIONTRANSACTION_AMOUNT_LIMITSPEND_LIMITAUTHORIZATION_COUNT_LIMIT
scopeTypestringrequired

The level the policy was attached to.

Available options:PROJECTUSERCARD
namestringrequired

Human-readable label.

Option 4 · VoidCardTransaction
idstring<uuid>required

Card transaction identifier

accountIdstring<uuid>required

Account linked to the card

cardIdstring<uuid>required

Card used for this transaction

channelstringrequired

Transaction channel

Available options:ATMPOSECOMMERCEVISA_DIRECT
digitalWalletstring | nullrequired

Digital wallet used, or null if physical card

Available options:APPLE_PAYGOOGLE_PAYMERCHANT_TOKEN
originalCurrencystringrequired

Original transaction currency (merchant local currency)

currencystringrequired

Card currency

merchantobjectrequired

Merchant details

Show child attributes
idstring<uuid>required

Identifier of the merchant details recorded on this transaction. Not a stable merchant identifier: the same merchant has a different id on each transaction, so do not use it to identify or group merchants. Use cardAcceptorId instead.

cardAcceptorIdstring | nullrequired

Card acceptor ID (often called the merchant ID or MID), assigned by the merchant's acquirer and passed on by the card network. It is unique only within one acquirer, and one merchant can have several (for example one per terminal). Combine it with name, country, and mccCode when matching merchants. null when the network did not provide one.

namestringrequired

Merchant name

citystring | nullrequired

Merchant city

postCodestring | nullrequired

Merchant postal or ZIP code

statestring | nullrequired

Merchant state or province

countrystring

ISO 3166-1 alpha-2 country code

mccCodestringrequired

Merchant Category Code

mccCategorystringrequired

MCC category description

feesobjectrequired

Cardholder fee breakdown in the card billing currency. Always present; zeros when no fee applied.

Show child attributes
atmnumberrequired

ATM withdrawal markup charged to the cardholder (card currency)

fxnumberrequired

FX markup charged to the cardholder (card currency)

eventsobject[]required

Chronologically sorted lifecycle events (oldest first). Provides the full audit trail of what happened to this transaction.

Show child attributes
idstring<uuid>required

Event identifier

typestringrequired

Lifecycle event type. DISPUTE_REFUND is the credit from a card dispute resolved in favor of the cardholder; like REFUND it gives cleared value back to the cardholder.

Available options:AUTHORIZATIONCLEARINGREVERSALREFUNDDECLINEDISPUTE_REFUND
originalAmountnumberrequired

Event amount in the event-level original currency

originalCurrencystringrequired

Per-event original currency. Usually equals the parent transaction originalCurrency, but can differ when the card network reports a presentment (typically a clearing) in the bill currency instead of the merchant local currency.

amountnumberrequired

Event amount charged to the cardholder (card currency)

feesobjectrequired

Cardholder fee breakdown in the card billing currency. Always present; zeros when no fee applied.

Show child attributes
atmnumberrequired

ATM withdrawal markup charged to the cardholder (card currency)

fxnumberrequired

FX markup charged to the cardholder (card currency)

occurredAtstringrequired

ISO 8601 timestamp of when the event occurred

createdAtstringrequired

ISO 8601 timestamp of when the event was recorded

occurredAtstringrequired

ISO 8601 timestamp of when the transaction was initiated

createdAtstringrequired

ISO 8601 timestamp of creation

updatedAtstringrequired

ISO 8601 timestamp of last update

statusstringrequired
originalAmountobjectrequired

Amount breakdown showing authorized, reversed, and current values

Show child attributes
authorizednumberrequired

Original authorized amount before reversals

reversednumberrequired

Total amount reversed (credited back)

currentnumberrequired

Effective current amount (authorized - reversed, minimum 0)

amountobjectrequired

Amount breakdown showing authorized, reversed, and current values

Show child attributes
authorizednumberrequired

Original authorized amount before reversals

reversednumberrequired

Total amount reversed (credited back)

currentnumberrequired

Effective current amount (authorized - reversed, minimum 0)

Option 5 · PostingActivity
typestringrequired
idstring<uuid>required

Activity resource identifier

occurredAtstringrequired

ISO 8601 timestamp used for chronological ordering

dataobjectrequired

Client-driven posting against an account.

Show child attributes
idstring<uuid>required

Posting ID

accountIdstring<uuid>required

Account ID

typestringrequired
  • DEPOSIT: Credit the submitted virtual asset amounts to the account balance.
  • WITHDRAWAL: Debit the submitted virtual asset amounts from the account balance. Rejected if any entry would take the balance below zero.
  • SETTLEMENT: Debit the submitted virtual asset amounts from the account balance AND apply their value to the account’s outstanding card debt. Same non-negative guard as WITHDRAWAL.
Available options:DEPOSITWITHDRAWALSETTLEMENT
entriesobject[]required
Show child attributes
virtualAssetIdstring<uuid>required

Virtual asset ID

amountstringrequired

Entry amount in the virtual asset denomination

rateSnapshotnumber | nullrequired

Billing-currency-per-unit rate applied to this entry, read when the posting was made. The entry contributed amount × rateSnapshot to settledAmount. Populated for SETTLEMENT postings, null otherwise.

settledAmountnumber | nullrequired

Value applied to outstanding card debt, in the billing currency of the card program. Each entry is valued at amount × rateSnapshot and rounded to the billing currency's precision, then the entries are summed. Populated for SETTLEMENT postings, null otherwise.

createdAtstringrequired

ISO 8601 creation timestamp

nextCursorstring | nullrequired

Cursor for next page, or null if no more items